#VirtualMachine [virtualmachines.kubevirt.io/v1]

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Spec contains the specification of VirtualMachineInstance created

Status holds the current state of the controller and brief information about its associated VirtualMachineInstance

dataVolumeTemplates is a list of dataVolumes that the VirtualMachineInstance template can reference. DataVolumes in this list are dynamically created for the VirtualMachine and are tied to the VirtualMachine's life-cycle.

InstancetypeMatcher references a instancetype that is used to fill fields in Template

PreferenceMatcher references a set of preference that is used to fill fields in Template

Running state indicates the requested running state of the VirtualMachineInstance mutually exclusive with Running

Running controls whether the associatied VirtualMachineInstance is created or not Mutually exclusive with RunStrategy Deprecated: VirtualMachineInstance field "Running" is now deprecated, please use RunStrategy instead.

Template is the direct specification of VirtualMachineInstance

UpdateVolumesStrategy is the strategy to apply on volumes updates

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

DataVolumeSpec contains the DataVolume specification.

DataVolumeTemplateDummyStatus is here simply for backwards compatibility with a previous API.

Checkpoints is a list of DataVolumeCheckpoints, representing stages in a multistage import.

DataVolumeContentType options: "kubevirt", "archive"

FinalCheckpoint indicates whether the current DataVolumeCheckpoint is the final checkpoint.

Preallocation controls whether storage for DataVolumes should be allocated in advance.

PriorityClassName for Importer, Cloner and Uploader pod

PVC is the PVC specification

Source is the src of the data for the requested DataVolume

SourceRef is an indirect reference to the source of data for the requested DataVolume

Storage is the requested storage specification

Current is the identifier of the snapshot created for this checkpoint.

Previous is the identifier of the snapshot from the previous checkpoint.

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource field can be used to specify either:

• An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
• An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef:

• While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
• While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
• While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

selector is a label query over volumes to consider for binding.

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName is the binding reference to the PersistentVolume backing this claim.

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

Kind is the type of resource being referenced

Name is the name of resource being referenced

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

Kind is the type of resource being referenced

Name is the name of resource being referenced

Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

DataVolumeBlankImage provides the parameters to create a new raw blank image for the PVC

DataVolumeSourceGCS provides the parameters to create a Data Volume from an GCS source

DataVolumeSourceHTTP can be either an http or https endpoint, with an optional basic auth user name and password, and an optional configmap containing additional CAs

DataVolumeSourceImageIO provides the parameters to create a Data Volume from an imageio source

DataVolumeSourcePVC provides the parameters to create a Data Volume from an existing PVC

DataVolumeSourceRegistry provides the parameters to create a Data Volume from an registry source

DataVolumeSourceS3 provides the parameters to create a Data Volume from an S3 source

DataVolumeSourceSnapshot provides the parameters to create a Data Volume from an existing VolumeSnapshot

DataVolumeSourceUpload provides the parameters to create a Data Volume by uploading the source

DataVolumeSourceVDDK provides the parameters to create a Data Volume from a Vmware source

SecretRef provides the secret reference needed to access the GCS source

URL is the url of the GCS source

CertConfigMap is a configmap reference, containing a Certificate Authority(CA) public key, and a base64 encoded pem certificate

ExtraHeaders is a list of strings containing extra headers to include with HTTP transfer requests

SecretExtraHeaders is a list of Secret references, each containing an extra HTTP header that may include sensitive information

SecretRef A Secret reference, the secret should contain accessKeyId (user name) base64 encoded, and secretKey (password) also base64 encoded

URL is the URL of the http(s) endpoint

CertConfigMap provides a reference to the CA cert

DiskID provides id of a disk to be imported

SecretRef provides the secret reference needed to access the ovirt-engine

URL is the URL of the ovirt-engine

The name of the source PVC

The namespace of the source PVC

CertConfigMap provides a reference to the Registry certs

ImageStream is the name of image stream for import

Platform describes the minimum runtime requirements of the image

PullMethod can be either "pod" (default import), or "node" (node docker cache based import)

SecretRef provides the secret reference needed to access the Registry source

URL is the url of the registry source (starting with the scheme: docker, oci-archive)

Architecture specifies the image target CPU architecture

CertConfigMap is a configmap reference, containing a Certificate Authority(CA) public key, and a base64 encoded pem certificate

SecretRef provides the secret reference needed to access the S3 source

URL is the url of the S3 source

The name of the source VolumeSnapshot

The namespace of the source VolumeSnapshot

BackingFile is the path to the virtual hard disk to migrate from vCenter/ESXi

ExtraArgs is a reference to a ConfigMap containing extra arguments to pass directly to the VDDK library

InitImageURL is an optional URL to an image containing an extracted VDDK library, overrides v2v-vmware config map

SecretRef provides a reference to a secret containing the username and password needed to access the vCenter or ESXi host

Thumbprint is the certificate thumbprint of the vCenter or ESXi host

URL is the URL of the vCenter or ESXi host with the VM to migrate

UUID is the UUID of the virtual machine that the backing file is attached to in vCenter/ESXi

The kind of the source reference, currently only "DataSource" is supported

The name of the source reference

The namespace of the source reference, defaults to the DataVolume namespace

AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef:

• While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
• While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

A label query over volumes to consider for binding.

Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

VolumeName is the binding reference to the PersistentVolume backing this claim.

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

Kind is the type of resource being referenced

Name is the name of resource being referenced

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

Kind is the type of resource being referenced

Name is the name of resource being referenced

Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

InferFromVolume lists the name of a volume that should be used to infer or discover the instancetype to be used through known annotations on the underlying resource. Once applied to the InstancetypeMatcher this field is removed.

InferFromVolumeFailurePolicy controls what should happen on failure when inferring the instancetype. Allowed values are: "RejectInferFromVolumeFailure" and "IgnoreInferFromVolumeFailure". If not specified, "RejectInferFromVolumeFailure" is used by default.

Kind specifies which instancetype resource is referenced. Allowed values are: "VirtualMachineInstancetype" and "VirtualMachineClusterInstancetype". If not specified, "VirtualMachineClusterInstancetype" is used by default.

Name is the name of the VirtualMachineInstancetype or VirtualMachineClusterInstancetype

RevisionName specifies a ControllerRevision containing a specific copy of the VirtualMachineInstancetype or VirtualMachineClusterInstancetype to be used. This is initially captured the first time the instancetype is applied to the VirtualMachineInstance.

InferFromVolume lists the name of a volume that should be used to infer or discover the preference to be used through known annotations on the underlying resource. Once applied to the PreferenceMatcher this field is removed.

InferFromVolumeFailurePolicy controls what should happen on failure when preference the instancetype. Allowed values are: "RejectInferFromVolumeFailure" and "IgnoreInferFromVolumeFailure". If not specified, "RejectInferFromVolumeFailure" is used by default.

Kind specifies which preference resource is referenced. Allowed values are: "VirtualMachinePreference" and "VirtualMachineClusterPreference". If not specified, "VirtualMachineClusterPreference" is used by default.

Name is the name of the VirtualMachinePreference or VirtualMachineClusterPreference

RevisionName specifies a ControllerRevision containing a specific copy of the VirtualMachinePreference or VirtualMachineClusterPreference to be used. This is initially captured the first time the instancetype is applied to the VirtualMachineInstance.

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

Specifies a set of public keys to inject into the vm guest

If affinity is specifies, obey all the affinity rules

Specifies the architecture of the vm guest you are attempting to run. Defaults to the compiled architecture of the KubeVirt components

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

Specification of the desired behavior of the VirtualMachineInstance on the host.

EvictionStrategy describes the strategy to follow when a node drain occurs. The possible options are:

• "None": No action will be taken, according to the specified 'RunStrategy' the VirtualMachine will be restarted or shutdown.
• "LiveMigrate": the VirtualMachineInstance will be migrated instead of being shutdown.
• "LiveMigrateIfPossible": the same as "LiveMigrate" but only if the VirtualMachine is Live-Migratable, otherwise it will behave as "None".
• "External": the VirtualMachineInstance will be protected and 'vmi.Status.EvacuationNodeName' will be set on eviction. This is mainly useful for cluster-api-provider-kubevirt (capk) which needs a way for VMI's to be blocked from eviction, yet signal capk that eviction has been called on the VMI so the capk controller can handle tearing the VMI down. Details can be found in the commit description https://github.com/kubevirt/kubevirt/commit/c1d77face705c8b126696bac9a3ee3825f27f1fa.

Specifies the hostname of the vmi If not specified, the hostname will be set to the name of the vmi, if dhcp or cloud-init is configured properly.

Periodic probe of VirtualMachineInstance liveness. VirtualmachineInstances will be stopped if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

List of networks that can be attached to a vm's virtual interface.

NodeSelector is a selector which must be true for the vmi to fit on a node. Selector which must match a node's labels for the vmi to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

If specified, indicates the pod's priority. If not specified, the pod priority will be default or zero if there is no default.

Periodic probe of VirtualMachineInstance service readiness. VirtualmachineInstances will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

ResourceClaims define which ResourceClaims must be allocated and reserved before the VMI, hence virt-launcher pod is allowed to start. The resources will be made available to the domain which consumes them by name.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate in kubernetes https://kubernetes.io/docs/concepts/scheduling-eviction/dynamic-resource-allocation/ This field should only be configured if one of the feature-gates GPUsWithDRA or HostDevicesWithDRA is enabled. This feature is in alpha.

If specified, the VMI will be dispatched by specified scheduler. If not specified, the VMI will be dispatched by default scheduler.

StartStrategy can be set to "Paused" if Virtual Machine should be started in paused state.

If specified, the fully qualified vmi hostname will be "...svc.". If not specified, the vmi will not have a domainname at all. The DNS entry will resolve to the vmi, no matter if the vmi itself can pick up a hostname.

Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated.

If toleration is specified, obey all the toleration rules.

TopologySpreadConstraints describes how a group of VMIs will be spread across a given topology domains. K8s scheduler will schedule VMI pods in a way which abides by the constraints.

List of volumes that can be mounted by disks belonging to the vmi.

SSHPublicKey represents the source and method of applying a ssh public key into a guest virtual machine.

UserPassword represents the source and method for applying a guest user's password

PropagationMethod represents how the public key is injected into the vm guest.

Source represents where the public keys are pulled from

ConfigDrivePropagation means that the ssh public keys are injected into the VM using metadata using the configDrive cloud-init provider

NoCloudPropagation means that the ssh public keys are injected into the VM using metadata using the noCloud cloud-init provider

QemuGuestAgentAccessCredentailPropagation means ssh public keys are dynamically injected into the vm at runtime via the qemu guest agent. This feature requires the qemu guest agent to be running within the guest.

Users represents a list of guest users that should have the ssh public keys added to their authorized_keys file.

Secret means that the access credential is pulled from a kubernetes secret

SecretName represents the name of the secret in the VMI's namespace

propagationMethod represents how the user passwords are injected into the vm guest.

Source represents where the user passwords are pulled from

QemuGuestAgentAccessCredentailPropagation means passwords are dynamically injected into the vm at runtime via the qemu guest agent. This feature requires the qemu guest agent to be running within the guest.

Secret means that the access credential is pulled from a kubernetes secret

SecretName represents the name of the secret in the VMI's namespace

Describes node affinity scheduling rules for the pod.

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

A node selector term, associated with the corresponding weight.

Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

A list of node selector requirements by node's labels.

A list of node selector requirements by node's fields.

The label key that the selector applies to.

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

The label key that the selector applies to.

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

Required. A list of node selector terms. The terms are ORed.

A list of node selector requirements by node's labels.

A list of node selector requirements by node's fields.

The label key that the selector applies to.

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

The label key that the selector applies to.

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

Required. A pod affinity term, associated with the corresponding weight.

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with 'labelSelector' as 'key in (value)' to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with 'labelSelector' as 'key notin (value)' to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with 'labelSelector' as 'key in (value)' to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with 'labelSelector' as 'key notin (value)' to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

Required. A pod affinity term, associated with the corresponding weight.

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with 'labelSelector' as 'key in (value)' to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with 'labelSelector' as 'key notin (value)' to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with 'labelSelector' as 'key in (value)' to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with 'labelSelector' as 'key notin (value)' to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.

A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

Name is this DNS resolver option's name. Required.

Value is this DNS resolver option's value.

Chassis specifies the chassis info passed to the domain.

Clock sets the clock and timers of the vmi.

CPU allow specified the detailed CPU topology inside the vmi.

Devices allows adding disks, network interfaces, and others

Features like acpi, apic, hyperv, smm.

Firmware.

IOThreads specifies the IOThreads options.

Controls whether or not disks will share IOThreads. Omitting IOThreadsPolicy disables use of IOThreads. One of: shared, auto, supplementalPool

Launch Security setting of the vmi.

Machine type.

Memory allow specifying the VMI memory features.

Resources describes the Compute Resources required by this vmi.

Timer specifies whih timers are attached to the vmi.

Timezone sets the guest clock to the specified timezone. Zone name follows the TZ environment variable format (e.g. 'America/New_York').

UTC sets the guest clock to UTC on each boot. If an offset is specified, guest changes to the clock will be kept during reboots and are not reset.

HPET (High Precision Event Timer) - multiple timers with periodic interrupts.

Hyperv (Hypervclock) - lets guests read the host’s wall clock time (paravirtualized). For windows guests.

KVM (KVM clock) - lets guests read the host’s wall clock time (paravirtualized). For linux guests.

PIT (Programmable Interval Timer) - a timer with periodic interrupts.

RTC (Real Time Clock) - a continuously running timer with periodic interrupts.

Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "merge", "discard".

Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "discard".

Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup".

Track the guest or the wall clock.

OffsetSeconds specifies an offset in seconds, relative to UTC. If set, guest changes to the clock will be kept during reboots and not reset.

Cores specifies the number of cores inside the vmi. Must be a value greater or equal 1.

DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node with enough dedicated pCPUs and pin the vCPUs to it.

Features specifies the CPU features list inside the VMI.

IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place the emulator thread on it.

MaxSockets specifies the maximum amount of sockets that can be hotplugged

Model specifies the CPU model inside the VMI. List of available models https://github.com/libvirt/libvirt/tree/master/src/cpu_map. It is possible to specify special cases like "host-passthrough" to get the same CPU as the node and "host-model" to get CPU closest to the node one. Defaults to host-model.

NUMA allows specifying settings for the guest NUMA topology

Realtime instructs the virt-launcher to tune the VMI for lower latency, optional for real time workloads

Sockets specifies the number of sockets inside the vmi. Must be a value greater or equal 1.

Threads specifies the number of threads inside the vmi. Must be a value greater or equal 1.

Name of the CPU feature

Policy is the CPU feature attribute which can have the following attributes: force - The virtual CPU will claim the feature is supported regardless of it being supported by host CPU. require - Guest creation will fail unless the feature is supported by the host CPU or the hypervisor is able to emulate it. optional - The feature will be supported by virtual CPU if and only if it is supported by host CPU. disable - The feature will not be supported by virtual CPU. forbid - Guest creation will fail if the feature is supported by host CPU. Defaults to require

GuestMappingPassthrough will create an efficient guest topology based on host CPUs exclusively assigned to a pod. The created topology ensures that memory and CPUs on the virtual numa nodes never cross boundaries of host numa nodes.

Mask defines the vcpu mask expression that defines which vcpus are used for realtime. Format matches libvirt's expressions. Example: "0-3,^1","0,2,3","2-3"

Whether to attach the default graphics device or not. VNC will not be available if set to false. Defaults to true.

Whether to attach an Input Device. Defaults to false.

Whether to attach the Memory balloon device with default period. Period can be adjusted in virt-config. Defaults to true.

Whether to attach a pod network interface. Defaults to true.

Whether to attach the default virtio-serial console or not. Serial console access will not be available if set to false. Defaults to true.

Whether to attach the VSOCK CID to the VM or not. VSOCK access will be available if set to true. Defaults to false.

Whether or not to enable virtio multi-queue for block devices. Defaults to false.

To configure and access client devices such as redirecting USB

DisableHotplug disabled the ability to hotplug disks.

Disks describes disks, cdroms and luns which are connected to the vmi.

DownwardMetrics creates a virtio serials for exposing the downward metrics to the vmi.

Filesystems describes filesystem which is connected to the vmi.

Whether to attach a GPU device to the vmi.

Whether to attach a host device to the vmi.

Inputs describe input devices

Interfaces describe network interfaces which are added to the vmi.

Whether to log the auto-attached default serial console or not. Serial console logs will be collect to a file and then streamed from a named 'guest-console-log'. Not relevant if autoattachSerialConsole is disabled. Defaults to cluster wide setting on VirtualMachineOptions.

If specified, virtual network interfaces configured with a virtio bus will also enable the vhost multiqueue feature for network devices. The number of queues created depends on additional factors of the VirtualMachineInstance, like the number of guest CPUs.

PanicDevices provides additional crash information when a guest crashes.

Whether to have random number generator from host

Whether to emulate a sound device.

Whether to emulate a TPM device.

Fall back to legacy virtio 0.9 support if virtio bus is selected on devices. This is helpful for old machines like CentOS6 or RHEL6 which do not understand virtio_non_transitional (virtio 1.0).

Video describes the video device configuration for the vmi.

Watchdog describes a watchdog device which can be added to the vmi.

If specified, the virtual disk will be presented with the given block sizes.

BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each disk or interface that has a boot order must have a unique value. Disks without a boot order are not tried if a disk with a boot order exists.

Cache specifies which kvm disk cache mode should be used. Supported values are: none: Guest I/O not cached on the host, but may be kept in a disk cache. writethrough: Guest I/O cached on the host but written through to the physical medium. Slowest but with most guarantees. writeback: Guest I/O cached on the host. Defaults to none if the storage supports O_DIRECT, otherwise writethrough.

Attach a volume as a cdrom to the vmi.

ChangedBlockTracking indicates this disk should have CBT option Defaults to false.

dedicatedIOThread indicates this disk should have an exclusive IO Thread. Enabling this implies useIOThreads = true. Defaults to false.

Attach a volume as a disk to the vmi.

If specified, it can change the default error policy (stop) for the disk

IO specifies which QEMU disk IO mode should be used. Supported values are: native, default, threads.

Attach a volume as a LUN to the vmi.

Name is the device name

Serial provides the ability to specify a serial number for the disk device.

If specified the disk is made sharable and multiple write from different VMs are permitted

If specified, disk address and its tag will be provided to the guest via config drive metadata

CustomBlockSize represents the desired logical and physical block size for a VM disk.

Represents if a feature is enabled or disabled.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

ReadOnly. Defaults to true.

Tray indicates if the tray of the device is open or closed. Allowed values are "open" and "closed". Defaults to closed.

Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi, usb.

If specified, the virtual disk will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

ReadOnly. Defaults to false.

Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

ReadOnly. Defaults to false.

Reservation indicates if the disk needs to support the persistent reservation for the SCSI disk

Name is the device name

Virtiofs is supported

ClaimName needs to be provided from the list vmi.spec.resourceClaims[].name where this device is allocated

DeviceName is the name of the device provisioned by device-plugins

Name of the GPU device as exposed by a device plugin

RequestName needs to be provided from resourceClaim.spec.devices.requests[].name where this device is requested

If specified, the virtual network interface address and its tag will be provided to the guest via config drive

Enabled determines if a display addapter backed by a vGPU should be enabled or disabled on the guest. Defaults to true.

Enables a boot framebuffer, until the guest OS loads a real GPU driver Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

ClaimName needs to be provided from the list vmi.spec.resourceClaims[].name where this device is allocated

DeviceName is the name of the device provisioned by device-plugins

RequestName needs to be provided from resourceClaim.spec.devices.requests[].name where this device is requested

If specified, the virtual network interface address and its tag will be provided to the guest via config drive

Bus indicates the bus of input device to emulate. Supported values: virtio, usb.

Name is the device name

Type indicated the type of input device. Supported values: tablet.

If specified, the ACPI index is used to provide network interface device naming, that is stable across changes in PCI addresses assigned to the device. This value is required to be unique across all devices and be between 1 and (16*1024-1).

Binding specifies the binding plugin that will be used to connect the interface to the guest. It provides an alternative to InterfaceBindingMethod. version: 1alphav1

BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each interface or disk that has a boot order must have a unique value. Interfaces without a boot order are not tried.

InterfaceBridge connects to a given network via a linux bridge.

If specified the network interface will pass additional DHCP options to the VMI

Interface MAC address. For example: de:ad:00:00:be:af or DE-AD-00-00-BE-AF.

DeprecatedMacvtap is an alias to the deprecated Macvtap interface, please refer to Kubevirt user guide for alternatives. Deprecated: Removed in v1.3

InterfaceMasquerade connects to a given network using netfilter rules to nat the traffic.

Interface model. One of: e1000, e1000e, igb, ne2k_pci, pcnet, rtl8139, virtio. Defaults to virtio.

Logical name of the interface as well as a reference to the associated networks. Must match the Name of a Network.

DeprecatedPasst is an alias to the deprecated Passt interface, please refer to Kubevirt user guide for alternatives. Deprecated: Removed in v1.3

If specified, the virtual network interface will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

List of ports to be forwarded to the virtual machine.

DeprecatedSlirp is an alias to the deprecated Slirp interface Deprecated: Removed in v1.3

InterfaceSRIOV connects to a given network by passing-through an SR-IOV PCI device via vfio.

State represents the requested operational state of the interface. The supported values are: 'absent', expressing a request to remove the interface. 'down', expressing a request to set the link down. 'up', expressing a request to set the link up. Empty value functions as 'up'.

If specified, the virtual network interface address and its tag will be provided to the guest via config drive

Name references to the binding name as denined in the kubevirt CR. version: 1alphav1

If specified will pass option 67 to interface's DHCP server

If specified will pass the configured NTP server to the VM via DHCP option 042.

If specified will pass extra DHCP options for private use, range: 224-254

If specified will pass option 66 to interface's DHCP server

Option is an Integer value from 224-254 Required.

Value is a String value for the Option provided Required.

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

Number of port to expose for the virtual machine. This must be a valid port number, 0 < x < 65536.

Protocol for port. Must be UDP or TCP. Defaults to "TCP".

Model specifies what type of panic device is provided. The panic model used when this attribute is missing depends on the hypervisor and guest arch. One of: isa, hyperv, pvpanic.

We only support ich9 or ac97. If SoundDevice is not set: No sound card is emulated. If SoundDevice is set but Model is not: ich9

User's defined name for this sound device

Enabled allows a user to explicitly disable the vTPM even when one is enabled by a preference referenced by the VirtualMachine Defaults to True

Persistent indicates the state of the TPM device should be kept accross reboots Defaults to false

Type specifies the video device type (e.g., virtio, vga, bochs, ramfb). If not specified, the default is architecture-dependent (VGA for BIOS-based VMs, Bochs for EFI-based VMs on AMD64; virtio for Arm and s390x).

diag288 watchdog device (specific to s390x architecture).

i6300esb watchdog device.

Name of the watchdog.

The action to take. Valid values are poweroff, reset, shutdown. Defaults to reset.

The action to take. Valid values are poweroff, reset, shutdown. Defaults to reset.

ACPI enables/disables ACPI inside the guest. Defaults to enabled.

Defaults to the machine type setting.

Defaults to the machine type setting.

This enables all supported hyperv flags automatically. Bear in mind that if this enabled hyperV features cannot be enabled explicitly. In addition, a Virtual Machine using it will be non-migratable.

Configure how KVM presence is exposed to the guest.

Notify the guest that the host supports paravirtual spinlocks. For older kernels this feature should be explicitly disabled.

SMM enables/disables System Management Mode. TSEG not yet implemented.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

EndOfInterrupt enables the end of interrupt notification in the guest. Defaults to false.

EVMCS Speeds up L2 vmexits, but disables other virtualization features. Requires vapic. Defaults to the machine type setting.

Frequencies improves the TSC clock source handling for Hyper-V on KVM. Defaults to the machine type setting.

IPI improves performances in overcommited environments. Requires vpindex. Defaults to the machine type setting.

Reenlightenment enables the notifications on TSC frequency changes. Defaults to the machine type setting.

Relaxed instructs the guest OS to disable watchdog timeouts. Defaults to the machine type setting.

Reset enables Hyperv reboot/reset for the vmi. Requires synic. Defaults to the machine type setting.

Runtime improves the time accounting to improve scheduling in the guest. Defaults to the machine type setting.

Spinlocks allows to configure the spinlock retry attempts.

SyNIC enables the Synthetic Interrupt Controller. Defaults to the machine type setting.

SyNICTimer enables Synthetic Interrupt Controller Timers, reducing CPU load. Defaults to the machine type setting.

TLBFlush improves performances in overcommited environments. Requires vpindex. Defaults to the machine type setting.

VAPIC improves the paravirtualized handling of interrupts. Defaults to the machine type setting.

VendorID allows setting the hypervisor vendor id. Defaults to the machine type setting.

VPIndex enables the Virtual Processor Index to help windows identifying virtual processors. Defaults to the machine type setting.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Retries indicates the number of retries. Must be a value greater or equal 4096. Defaults to 4096.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Represents if a feature is enabled or disabled.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

VendorID sets the hypervisor vendor id, visible to the vmi. String up to twelve characters.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Hide the KVM hypervisor from standard MSR based discovery. Defaults to false

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

Information that can be set in the ACPI table

Settings to control the bootloader that is used.

Settings to set the kernel for booting.

The system-serial-number in SMBIOS

UUID reported by the vmi bios. Defaults to a random generated uid.

Similar to SlicNameRef, another ACPI entry that is used in more recent Windows versions. The above points to the spec of MSDM too.

SlicNameRef should match the volume name of a secret object. The data in the secret should be a binary blob that follows the ACPI SLIC standard, see: https://learn.microsoft.com/en-us/previous-versions/windows/hardware/design/dn653305(v=vs.85)

If set (default), BIOS will be used.

If set, EFI will be used instead of BIOS.

If set, the BIOS output will be transmitted over serial

If set to true, Persistent will persist the EFI NVRAM across reboots. Defaults to false

If set, SecureBoot will be enabled and the OVMF roms will be swapped for SecureBoot-enabled ones. Requires SMM to be enabled. Defaults to true

Container defines the container that containes kernel artifacts

Arguments to be passed to the kernel at boot time

Image that contains initrd / kernel files.

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.

the fully-qualified path to the ramdisk image in the host OS

The fully-qualified path to the kernel image in the host OS

SupplementalPoolThreadCount specifies how many iothreads are allocated for the supplementalPool policy.

AMD Secure Encrypted Virtualization (SEV).

AMD SEV-SNP flags defined by the SEV-SNP specifications.

Intel Trust Domain Extensions (TDX).

If specified, run the attestation process for a vmi.

Base64 encoded guest owner's Diffie-Hellman key.

Guest policy flags as defined in AMD SEV API specification. Note: due to security reasons it is not allowed to enable guest debugging. Therefore NoDebug flag is not exposed to users and is always true.

Base64 encoded session blob.

SEV-ES is required. Defaults to false.

QEMU machine type is the actual chipset of the VirtualMachineInstance.

Guest allows to specifying the amount of memory which is visible inside the Guest OS. The Guest must lie between Requests and Limits from the resources section. Defaults to the requested memory in the resources section if not specified.

Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory.

MaxGuest allows to specify the maximum amount of memory which is visible inside the Guest OS. The delta between MaxGuest and Guest is the amount of memory that can be hot(un)plugged.

PageSize specifies the hugepage size, for x86_64 architecture valid values are 1Gi and 2Mi.

Limits describes the maximum amount of compute resources allowed. Valid resource keys are "memory" and "cpu".

Don't ask the scheduler to take the guest-management overhead into account. Instead put the overhead only into the container's memory limit. This can lead to crashes if all memory is in use on a node. Defaults to false.

Requests is a description of the initial vmi resources. Valid resource keys are "memory" and "cpu".

One and only one of the following should be specified. Exec specifies the action to take, it will be executed on the guest through the qemu-guest-agent. If the guest agent is not available, this probe will fail.

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

GuestAgentPing contacts the qemu-guest-agent for availability checks.

HTTPGet specifies the http request to perform.

Number of seconds after the VirtualMachineInstance has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

Number of seconds after which the probe times out. For exec probes the timeout fails the probe but does not terminate the command running on the guest. This means a blocking command can result in an increasing load on the guest. A small buffer will be added to the resulting workload exec probe to compensate for delays caused by the qemu guest exec mechanism. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

Custom headers to set in the request. HTTP allows repeated headers.

Path to access on the HTTP server.

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

Scheme to use for connecting to the host. Defaults to HTTP.

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

The header field value

Optional: Host name to connect to, defaults to the pod IP.

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

Represents the multus cni network.

Network name. Must be a DNS_LABEL and unique within the vm. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Represents the stock pod network interface.

Select the default network and add it to the multus-cni.io/default-network annotation.

References to a NetworkAttachmentDefinition CRD object. Format: , /. If namespace is not specified, VMI namespace is assumed.

IPv6 CIDR for the vm network. Defaults to fd10:0:2::/120 if not specified.