mirror of
https://github.com/aljazceru/kata-containers.git
synced 2026-01-04 06:54:28 +01:00
annotations: Add annotations to support additional configurations
Add annotation to support all hypervisor configurations. Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
This commit is contained in:
Archana Shinde
@@ -9,8 +9,23 @@ const (
|
||||
kataAnnotationsPrefix = "io.kata-containers."
|
||||
kataConfAnnotationsPrefix = kataAnnotationsPrefix + "config."
|
||||
kataAnnotHypervisorPrefix = kataConfAnnotationsPrefix + "hypervisor."
|
||||
kataAnnotAgentPrefix = kataConfAnnotationsPrefix + "agent."
|
||||
kataAnnotRuntimePrefix = kataConfAnnotationsPrefix + "runtime." // nolint: unused
|
||||
|
||||
//
|
||||
// OCI
|
||||
//
|
||||
|
||||
// BundlePathKey is the annotation key to fetch the OCI configuration file path.
|
||||
BundlePathKey = kataAnnotationsPrefix + "pkg.oci.bundle_path"
|
||||
|
||||
// ContainerTypeKey is the annotation key to fetch container type.
|
||||
ContainerTypeKey = kataAnnotationsPrefix + "pkg.oci.container_type"
|
||||
)
|
||||
|
||||
// Annotations related to Hypervisor configuration
|
||||
const (
|
||||
//
|
||||
// Assets
|
||||
//
|
||||
|
||||
// KernelPath is a sandbox annotation for passing a per container path pointing at the kernel needed to boot the container VM.
|
||||
KernelPath = kataAnnotHypervisorPrefix + "kernel"
|
||||
@@ -51,11 +66,122 @@ const (
|
||||
// AssetHashType is the hash type used for assets verification
|
||||
AssetHashType = kataAnnotationsPrefix + "asset_hash_type"
|
||||
|
||||
// BundlePathKey is the annotation key to fetch the OCI configuration file path.
|
||||
BundlePathKey = kataAnnotationsPrefix + "pkg.oci.bundle_path"
|
||||
//
|
||||
// Generic annotations
|
||||
//
|
||||
|
||||
// ContainerTypeKey is the annotation key to fetch container type.
|
||||
ContainerTypeKey = kataAnnotationsPrefix + "pkg.oci.container_type"
|
||||
// KernelParams is a sandbox annotation for passing additional guest kernel parameters.
|
||||
KernelParams = kataAnnotHypervisorPrefix + "kernel_params"
|
||||
|
||||
// MachineType is a sandbox annotation to specify the type of machine being emulated by the hypervisor.
|
||||
MachineType = kataAnnotHypervisorPrefix + "machine_type"
|
||||
|
||||
// MachineAccelerators is a sandbox annotation to specify machine specific accelerators for the hypervisor.
|
||||
MachineAccelerators = kataAnnotHypervisorPrefix + "machine_accelerators"
|
||||
|
||||
// DisableVhostNet is a sandbox annotation to specify if vhost-net is not available on the host.
|
||||
DisableVhostNet = kataAnnotHypervisorPrefix + "disable_vhost_net"
|
||||
|
||||
// GuestHookPath is a sandbox annotation to specify the path within the VM that will be used for 'drop-in' hooks.
|
||||
GuestHookPath = kataAnnotHypervisorPrefix + "guest_hook_path"
|
||||
|
||||
// UseVSock is a sandbox annotation to specify use of vsock for agent communication.
|
||||
UseVSock = kataAnnotHypervisorPrefix + "use_vsock"
|
||||
|
||||
// HotplugVFIOOnRootBus is a sandbox annotation used to indicate if devices need to be hotplugged on the
|
||||
// root bus instead of a bridge.
|
||||
HotplugVFIOOnRootBus = kataAnnotHypervisorPrefix + "hotplug_vfio_on_root_bus"
|
||||
|
||||
// EntropySource is a sandbox annotation to specify the path to a host source of
|
||||
// entropy (/dev/random, /dev/urandom or real hardware RNG device)
|
||||
EntropySource = kataAnnotHypervisorPrefix + "entropy_source"
|
||||
|
||||
//
|
||||
// CPU Annotations
|
||||
//
|
||||
|
||||
// DefaultVCPUs is a sandbox annotation for passing the default vcpus assigned for a VM by the hypervisor.
|
||||
DefaultVCPUs = kataAnnotHypervisorPrefix + "default_vcpus"
|
||||
|
||||
// DefaultVCPUs is a sandbox annotation that specifies the maximum number of vCPUs allocated for the VM by the hypervisor.
|
||||
DefaultMaxVCPUs = kataAnnotHypervisorPrefix + "default_max_vcpus"
|
||||
|
||||
//
|
||||
// Memory related annotations
|
||||
//
|
||||
|
||||
// DefaultMemory is a sandbox annotation for the memory assigned for a VM by the hypervisor.
|
||||
DefaultMemory = kataAnnotHypervisorPrefix + "default_memory"
|
||||
|
||||
// MemSlots is a sandbox annotation to specify the memory slots assigned to the VM by the hypervisor.
|
||||
MemSlots = kataAnnotHypervisorPrefix + "memory_slots"
|
||||
|
||||
// MemOffset is a sandbox annotation that specifies the memory space used for nvdimm device by the hypervisor.
|
||||
MemOffset = kataAnnotHypervisorPrefix + "memory_offset"
|
||||
|
||||
// MemPrealloc is a sandbox annotation that specifies the memory space used for nvdimm device by the hypervisor.
|
||||
MemPrealloc = kataAnnotHypervisorPrefix + "enable_mem_prealloc"
|
||||
|
||||
// EnableSwap is a sandbox annotation to enable swap of vm memory.
|
||||
// The behaviour is undefined if mem_prealloc is also set to true
|
||||
EnableSwap = kataAnnotHypervisorPrefix + "enable_swap"
|
||||
|
||||
// HugePages is a sandbox annotation to specify if the memory should be pre-allocated from huge pages
|
||||
HugePages = kataAnnotHypervisorPrefix + "enable_hugepages"
|
||||
|
||||
// FileBackedMemRootDir is a sandbox annotation to soecify file based memory backend root directory
|
||||
FileBackedMemRootDir = kataAnnotHypervisorPrefix + "file_mem_backend"
|
||||
|
||||
//
|
||||
// Shared File System related annotations
|
||||
//
|
||||
|
||||
// Msize9p is a sandbox annotation to specify as the msize for 9p shares
|
||||
Msize9p = kataAnnotHypervisorPrefix + "msize_9p"
|
||||
|
||||
// SharedFs is a sandbox annotation to specify the shared file system type, either virtio-9p or virtio-fs.
|
||||
SharedFS = kataAnnotHypervisorPrefix + "shared_fs"
|
||||
|
||||
// VirtioFSDaemon is a sandbox annotations to specify virtio-fs vhost-user daemon path
|
||||
VirtioFSDaemon = kataAnnotHypervisorPrefix + "virtio_fs_daemon"
|
||||
|
||||
// VirtioFSCache is a sandbox annotation to specify the cache mode for fs version cache or "none"
|
||||
VirtioFSCache = kataAnnotHypervisorPrefix + "virtio_fs_cache"
|
||||
|
||||
// VirtioFSCacheSize is a sandbox annotation to specify the DAX cache size in MiB
|
||||
VirtioFSCacheSize = kataAnnotHypervisorPrefix + "virtio_fs_cache_size"
|
||||
|
||||
// VirtioFSExtraArgs is a sandbox annotation to pass options to virtiofsd daemon
|
||||
VirtioFSExtraArgs = kataAnnotHypervisorPrefix + "virtio_fs_extra_args"
|
||||
|
||||
//
|
||||
// Block Device related annotations
|
||||
//
|
||||
|
||||
// BlockDeviceDriver specifies the driver to be used for block device either VirtioSCSI or VirtioBlock
|
||||
BlockDeviceDriver = kataAnnotHypervisorPrefix + "block_device_driver"
|
||||
|
||||
// DisableBlockDeviceUse is a sandbox annotation that disallows a block device from being used.
|
||||
DisableBlockDeviceUse = kataAnnotHypervisorPrefix + "disable_block_device_use"
|
||||
|
||||
// EnableIOThreads is a sandbox annotation to enable IO to be processed in a separate thread.
|
||||
// Supported currently for virtio-scsi driver.
|
||||
EnableIOThreads = kataAnnotHypervisorPrefix + "enable_iothreads"
|
||||
|
||||
// BlockDeviceCacheSet is a sandbox annotation that specifies cache-related options will be set to block devices or not.
|
||||
BlockDeviceCacheSet = kataAnnotHypervisorPrefix + "block_device_cache_set"
|
||||
|
||||
// BlockDeviceCacheDirect is a sandbox annotation that specifies cache-related options for block devices.
|
||||
// Denotes whether use of O_DIRECT (bypass the host page cache) is enabled.
|
||||
BlockDeviceCacheDirect = kataAnnotHypervisorPrefix + "block_device_cache_direct"
|
||||
|
||||
// BlockDeviceCacheNoflush is a sandbox annotation that specifies cache-related options for block devices.
|
||||
// Denotes whether flush requests for the device are ignored.
|
||||
BlockDeviceCacheNoflush = kataAnnotHypervisorPrefix + "block_device_cache_noflush"
|
||||
)
|
||||
|
||||
const (
|
||||
kataAnnotAgentPrefix = kataConfAnnotationsPrefix + "agent."
|
||||
|
||||
// KernelModules is the annotation key for passing the list of kernel
|
||||
// modules and their parameters that will be loaded in the guest kernel.
|
||||
@@ -69,18 +195,6 @@ const (
|
||||
// The first word is considered as the module name and the rest as its parameters.
|
||||
//
|
||||
KernelModules = kataAnnotAgentPrefix + "kernel_modules"
|
||||
|
||||
// DefaultVCPUs is a sandbox annotation for passing the default vcpus assigned for a VM by the hypervisor.
|
||||
DefaultVCPUs = kataAnnotHypervisorPrefix + "default_vcpus"
|
||||
|
||||
// DefaultVCPUs is a sandbox annotation that specifies the maximum number of vCPUs allocated for the VM by the hypervisor.
|
||||
DefaultMaxVCPUs = kataAnnotHypervisorPrefix + "default_max_vcpus"
|
||||
|
||||
// DefaultMemory is a sandbox annotation for the memory assigned for a VM by the hypervisor.
|
||||
DefaultMemory = kataAnnotHypervisorPrefix + "default_memory"
|
||||
|
||||
// KernelParams is a sandbox annotation for passing additional guest kernel parameters.
|
||||
KernelParams = kataAnnotHypervisorPrefix + "kernel_params"
|
||||
)
|
||||
|
||||
const (
|
||||
|
||||
Reference in New Issue
Block a user