VirtualMachineInstanceReplicaSet
kubevirt.io / v1alpha3
apiVersion: kubevirt.io/v1alpha3
kind: VirtualMachineInstanceReplicaSet
metadata:
name: example
apiVersion
string
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
string
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
metadata
object
spec object required
VirtualMachineInstance Spec contains the VirtualMachineInstance specification.
paused
boolean
Indicates that the replica set is paused.
replicas
integer
Number of desired pods. This is a pointer to distinguish between explicit
zero and not specified. Defaults to 1.
format:
int32selector object required
Label selector for pods. Existing ReplicaSets whose pods are
selected by this will be the ones affected by this deployment.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
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.
matchLabels
object
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.
template object required
Template describes the pods that will be created.
metadata
object
spec object
VirtualMachineInstance Spec contains the VirtualMachineInstance specification.
accessCredentials []object
Specifies a set of public keys to inject into the vm guest
maxItems:
256sshPublicKey object
SSHPublicKey represents the source and method of applying a ssh public
key into a guest virtual machine.
propagationMethod object required
PropagationMethod represents how the public key is injected into the vm guest.
configDrive
object
ConfigDrivePropagation means that the ssh public keys are injected
into the VM using metadata using the configDrive cloud-init provider
noCloud
object
NoCloudPropagation means that the ssh public keys are injected
into the VM using metadata using the noCloud cloud-init provider
qemuGuestAgent object
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
[]string required
Users represents a list of guest users that should have the ssh public keys
added to their authorized_keys file.
source object required
Source represents where the public keys are pulled from
secret object
Secret means that the access credential is pulled from a kubernetes secret
secretName
string required
SecretName represents the name of the secret in the VMI's namespace
userPassword object
UserPassword represents the source and method for applying a guest user's
password
propagationMethod object required
propagationMethod represents how the user passwords are injected into the vm guest.
qemuGuestAgent
object
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.
source object required
Source represents where the user passwords are pulled from
secret object
Secret means that the access credential is pulled from a kubernetes secret
secretName
string required
SecretName represents the name of the secret in the VMI's namespace
affinity object
If affinity is specifies, obey all the affinity rules
nodeAffinity object
Describes node affinity scheduling rules for the pod.
preferredDuringSchedulingIgnoredDuringExecution []object
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.
preference object required
A node selector term, associated with the corresponding weight.
matchExpressions []object
A list of node selector requirements by node's labels.
key
string required
The label key that the selector applies to.
operator
string required
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
[]string
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.
matchFields []object
A list of node selector requirements by node's fields.
key
string required
The label key that the selector applies to.
operator
string required
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
[]string
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.
weight
integer required
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
format:
int32requiredDuringSchedulingIgnoredDuringExecution object
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.
nodeSelectorTerms []object required
Required. A list of node selector terms. The terms are ORed.
matchExpressions []object
A list of node selector requirements by node's labels.
key
string required
The label key that the selector applies to.
operator
string required
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
[]string
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.
matchFields []object
A list of node selector requirements by node's fields.
key
string required
The label key that the selector applies to.
operator
string required
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
[]string
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.
podAffinity object
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
preferredDuringSchedulingIgnoredDuringExecution []object
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.
podAffinityTerm object required
Required. A pod affinity term, associated with the corresponding weight.
labelSelector object
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
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.
matchLabels
object
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.
matchLabelKeys
[]string
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
[]string
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.
namespaceSelector object
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.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
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.
matchLabels
object
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.
namespaces
[]string
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".
topologyKey
string required
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.
weight
integer required
weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.
format:
int32requiredDuringSchedulingIgnoredDuringExecution []object
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.
labelSelector object
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
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.
matchLabels
object
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.
matchLabelKeys
[]string
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
[]string
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.
namespaceSelector object
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.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
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.
matchLabels
object
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.
namespaces
[]string
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".
topologyKey
string required
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.
podAntiAffinity object
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
preferredDuringSchedulingIgnoredDuringExecution []object
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 subtracting
"weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.
podAffinityTerm object required
Required. A pod affinity term, associated with the corresponding weight.
labelSelector object
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
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.
matchLabels
object
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.
matchLabelKeys
[]string
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
[]string
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.
namespaceSelector object
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.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
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.
matchLabels
object
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.
namespaces
[]string
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".
topologyKey
string required
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.
weight
integer required
weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.
format:
int32requiredDuringSchedulingIgnoredDuringExecution []object
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.
labelSelector object
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
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.
matchLabels
object
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.
matchLabelKeys
[]string
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
[]string
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.
namespaceSelector object
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.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
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.
matchLabels
object
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.
namespaces
[]string
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".
topologyKey
string required
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.
architecture
string
Specifies the architecture of the vm guest you are attempting to run. Defaults to the compiled architecture of the KubeVirt components
dnsConfig object
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy.
nameservers
[]string
A list of DNS name server IP addresses.
This will be appended to the base nameservers generated from DNSPolicy.
Duplicated nameservers will be removed.
options []object
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.
name
string
Name is this DNS resolver option's name.
Required.
value
string
Value is this DNS resolver option's value.
searches
[]string
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.
dnsPolicy
string
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'.
domain object required
Specification of the desired behavior of the VirtualMachineInstance on the host.
chassis object
Chassis specifies the chassis info passed to the domain.
asset
string
manufacturer
string
serial
string
sku
string
version
string
clock object
Clock sets the clock and timers of the vmi.
timer object
Timer specifies whih timers are attached to the vmi.
hpet object
HPET (High Precision Event Timer) - multiple timers with periodic interrupts.
present
boolean
Enabled set to false makes sure that the machine type or a preset can't add the timer.
Defaults to true.
tickPolicy
string
TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest.
One of "delay", "catchup", "merge", "discard".
hyperv object
Hyperv (Hypervclock) - lets guests read the host’s wall clock time (paravirtualized). For windows guests.
present
boolean
Enabled set to false makes sure that the machine type or a preset can't add the timer.
Defaults to true.
kvm object
KVM (KVM clock) - lets guests read the host’s wall clock time (paravirtualized). For linux guests.
present
boolean
Enabled set to false makes sure that the machine type or a preset can't add the timer.
Defaults to true.
pit object
PIT (Programmable Interval Timer) - a timer with periodic interrupts.
present
boolean
Enabled set to false makes sure that the machine type or a preset can't add the timer.
Defaults to true.
tickPolicy
string
TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest.
One of "delay", "catchup", "discard".
rtc object
RTC (Real Time Clock) - a continuously running timer with periodic interrupts.
present
boolean
Enabled set to false makes sure that the machine type or a preset can't add the timer.
Defaults to true.
tickPolicy
string
TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest.
One of "delay", "catchup".
track
string
Track the guest or the wall clock.
timezone
string
Timezone sets the guest clock to the specified timezone.
Zone name follows the TZ environment variable format (e.g. 'America/New_York').
utc object
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.
offsetSeconds
integer
OffsetSeconds specifies an offset in seconds, relative to UTC. If set,
guest changes to the clock will be kept during reboots and not reset.
cpu object
CPU allow specified the detailed CPU topology inside the vmi.
cores
integer
Cores specifies the number of cores inside the vmi.
Must be a value greater or equal 1.
format:
int32
dedicatedCpuPlacement
boolean
DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node
with enough dedicated pCPUs and pin the vCPUs to it.
features []object
Features specifies the CPU features list inside the VMI.
name
string required
Name of the CPU feature
policy
string
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
isolateEmulatorThread
boolean
IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place
the emulator thread on it.
maxSockets
integer
MaxSockets specifies the maximum amount of sockets that can
be hotplugged
format:
int32
model
string
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 object
NUMA allows specifying settings for the guest NUMA topology
guestMappingPassthrough
object
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.
realtime object
Realtime instructs the virt-launcher to tune the VMI for lower latency, optional for real time workloads
mask
string
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"
sockets
integer
Sockets specifies the number of sockets inside the vmi.
Must be a value greater or equal 1.
format:
int32
threads
integer
Threads specifies the number of threads inside the vmi.
Must be a value greater or equal 1.
format:
int32devices object required
Devices allows adding disks, network interfaces, and others
autoattachGraphicsDevice
boolean
Whether to attach the default graphics device or not.
VNC will not be available if set to false. Defaults to true.
autoattachInputDevice
boolean
Whether to attach an Input Device.
Defaults to false.
autoattachMemBalloon
boolean
Whether to attach the Memory balloon device with default period.
Period can be adjusted in virt-config.
Defaults to true.
autoattachPodInterface
boolean
Whether to attach a pod network interface. Defaults to true.
autoattachSerialConsole
boolean
Whether to attach the default virtio-serial console or not.
Serial console access will not be available if set to false. Defaults to true.
autoattachVSOCK
boolean
Whether to attach the VSOCK CID to the VM or not.
VSOCK access will be available if set to true. Defaults to false.
blockMultiQueue
boolean
Whether or not to enable virtio multi-queue for block devices.
Defaults to false.
clientPassthrough
object
To configure and access client devices such as redirecting USB
disableHotplug
boolean
DisableHotplug disabled the ability to hotplug disks.
disks []object
Disks describes disks, cdroms and luns which are connected to the vmi.
maxItems:
256blockSize object
If specified, the virtual disk will be presented with the given block sizes.
custom object
CustomBlockSize represents the desired logical and physical block size for a VM disk.
discardGranularity
integer
logical
integer
physical
integer
matchVolume object
Represents if a feature is enabled or disabled.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
bootOrder
integer
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
string
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.
cdrom object
Attach a volume as a cdrom to the vmi.
bus
string
Bus indicates the type of disk device to emulate.
supported values: virtio, sata, scsi.
readonly
boolean
ReadOnly.
Defaults to true.
tray
string
Tray indicates if the tray of the device is open or closed.
Allowed values are "open" and "closed".
Defaults to closed.
changedBlockTracking
boolean
ChangedBlockTracking indicates this disk should have CBT option
Defaults to false.
dedicatedIOThread
boolean
dedicatedIOThread indicates this disk should have an exclusive IO Thread.
Enabling this implies useIOThreads = true.
Defaults to false.
disk object
Attach a volume as a disk to the vmi.
bus
string
Bus indicates the type of disk device to emulate.
supported values: virtio, sata, scsi, usb.
pciAddress
string
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
boolean
ReadOnly.
Defaults to false.
errorPolicy
string
If specified, it can change the default error policy (stop) for the disk
io
string
IO specifies which QEMU disk IO mode should be used.
Supported values are: native, default, threads.
lun object
Attach a volume as a LUN to the vmi.
bus
string
Bus indicates the type of disk device to emulate.
supported values: virtio, sata, scsi.
readonly
boolean
ReadOnly.
Defaults to false.
reservation
boolean
Reservation indicates if the disk needs to support the persistent reservation for the SCSI disk
name
string required
Name is the device name
serial
string
Serial provides the ability to specify a serial number for the disk device.
shareable
boolean
If specified the disk is made sharable and multiple write from different VMs are permitted
tag
string
If specified, disk address and its tag will be provided to the guest via config drive metadata
downwardMetrics
object
DownwardMetrics creates a virtio serials for exposing the downward metrics to the vmi.
filesystems []object
Filesystems describes filesystem which is connected to the vmi.
name
string required
Name is the device name
virtiofs
object required
Virtiofs is supported
gpus []object
Whether to attach a GPU device to the vmi.
claimName
string
ClaimName needs to be provided from the list vmi.spec.resourceClaims[].name where this
device is allocated
deviceName
string
DeviceName is the name of the device provisioned by device-plugins
name
string required
Name of the GPU device as exposed by a device plugin
requestName
string
RequestName needs to be provided from resourceClaim.spec.devices.requests[].name where this
device is requested
tag
string
If specified, the virtual network interface address and its tag will be provided to the guest via config drive
virtualGPUOptions object
display object
enabled
boolean
Enabled determines if a display addapter backed by a vGPU should be enabled or disabled on the guest.
Defaults to true.
ramFB object
Enables a boot framebuffer, until the guest OS loads a real GPU driver
Defaults to true.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
hostDevices []object
Whether to attach a host device to the vmi.
claimName
string
ClaimName needs to be provided from the list vmi.spec.resourceClaims[].name where this
device is allocated
deviceName
string
DeviceName is the name of the device provisioned by device-plugins
name
string required
requestName
string
RequestName needs to be provided from resourceClaim.spec.devices.requests[].name where this
device is requested
tag
string
If specified, the virtual network interface address and its tag will be provided to the guest via config drive
inputs []object
Inputs describe input devices
bus
string
Bus indicates the bus of input device to emulate.
Supported values: virtio, usb.
name
string required
Name is the device name
type
string required
Type indicated the type of input device.
Supported values: tablet.
interfaces []object
Interfaces describe network interfaces which are added to the vmi.
maxItems:
256
acpiIndex
integer
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 object
Binding specifies the binding plugin that will be used to connect the interface to the guest.
It provides an alternative to InterfaceBindingMethod.
version: 1alphav1
name
string required
Name references to the binding name as denined in the kubevirt CR.
version: 1alphav1
bootOrder
integer
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.
bridge
object
InterfaceBridge connects to a given network via a linux bridge.
dhcpOptions object
If specified the network interface will pass additional DHCP options to the VMI
bootFileName
string
If specified will pass option 67 to interface's DHCP server
ntpServers
[]string
If specified will pass the configured NTP server to the VM via DHCP option 042.
privateOptions []object
If specified will pass extra DHCP options for private use, range: 224-254
option
integer required
Option is an Integer value from 224-254
Required.
value
string required
Value is a String value for the Option provided
Required.
tftpServerName
string
If specified will pass option 66 to interface's DHCP server
macAddress
string
Interface MAC address. For example: de:ad:00:00:be:af or DE-AD-00-00-BE-AF.
macvtap
object
DeprecatedMacvtap is an alias to the deprecated Macvtap interface,
please refer to Kubevirt user guide for alternatives.
Deprecated: Removed in v1.3
masquerade
object
InterfaceMasquerade connects to a given network using netfilter rules to nat the traffic.
model
string
Interface model.
One of: e1000, e1000e, igb, ne2k_pci, pcnet, rtl8139, virtio.
Defaults to virtio.
name
string required
Logical name of the interface as well as a reference to the associated networks.
Must match the Name of a Network.
passt
object
DeprecatedPasst is an alias to the deprecated Passt interface,
please refer to Kubevirt user guide for alternatives.
Deprecated: Removed in v1.3
passtBinding
object
InterfacePasstBinding connects to a given network using passt usermode networking.
pciAddress
string
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
ports []object
List of ports to be forwarded to the virtual machine.
name
string
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.
port
integer required
Number of port to expose for the virtual machine.
This must be a valid port number, 0 < x < 65536.
format:
int32
protocol
string
Protocol for port. Must be UDP or TCP.
Defaults to "TCP".
slirp
object
DeprecatedSlirp is an alias to the deprecated Slirp interface
Deprecated: Removed in v1.3
sriov
object
InterfaceSRIOV connects to a given network by passing-through an SR-IOV PCI device via vfio.
state
string
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'.
tag
string
If specified, the virtual network interface address and its tag will be provided to the guest via config drive
logSerialConsole
boolean
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.
networkInterfaceMultiqueue
boolean
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 []object
PanicDevices provides additional crash information when a guest crashes.
model
string
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.
rng
object
Whether to have random number generator from host
sound object
Whether to emulate a sound device.
model
string
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
name
string required
User's defined name for this sound device
tpm object
Whether to emulate a TPM device.
enabled
boolean
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
boolean
Persistent indicates the state of the TPM device should be kept accross reboots
Defaults to false
useVirtioTransitional
boolean
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 object
Video describes the video device configuration for the vmi.
type
string
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).
watchdog object
Watchdog describes a watchdog device which can be added to the vmi.
diag288 object
diag288 watchdog device (specific to s390x architecture).
action
string
The action to take. Valid values are poweroff, reset, shutdown.
Defaults to reset.
i6300esb object
i6300esb watchdog device.
action
string
The action to take. Valid values are poweroff, reset, shutdown.
Defaults to reset.
name
string required
Name of the watchdog.
features object
Features like acpi, apic, hyperv, smm.
acpi object
ACPI enables/disables ACPI inside the guest.
Defaults to enabled.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
apic object
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
endOfInterrupt
boolean
EndOfInterrupt enables the end of interrupt notification in the guest.
Defaults to false.
hyperv object
Defaults to the machine type setting.
evmcs object
EVMCS Speeds up L2 vmexits, but disables other virtualization features. Requires vapic.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
frequencies object
Frequencies improves the TSC clock source handling for Hyper-V on KVM.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
ipi object
IPI improves performances in overcommited environments. Requires vpindex.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
reenlightenment object
Reenlightenment enables the notifications on TSC frequency changes.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
relaxed object
Relaxed instructs the guest OS to disable watchdog timeouts.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
reset object
Reset enables Hyperv reboot/reset for the vmi. Requires synic.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
runtime object
Runtime improves the time accounting to improve scheduling in the guest.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
spinlocks object
Spinlocks allows to configure the spinlock retry attempts.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
spinlocks
integer
Retries indicates the number of retries.
Must be a value greater or equal 4096.
Defaults to 4096.
format:
int32synic object
SyNIC enables the Synthetic Interrupt Controller.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
synictimer object
SyNICTimer enables Synthetic Interrupt Controller Timers, reducing CPU load.
Defaults to the machine type setting.
direct object
Represents if a feature is enabled or disabled.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
tlbflush object
TLBFlush improves performances in overcommited environments. Requires vpindex.
Defaults to the machine type setting.
direct object
Direct allows sending the TLB flush command directly to the hypervisor.
It can be useful to optimize performance in nested virtualization cases, such as Windows VBS.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
extended object
Extended allows the guest to execute partial TLB flushes. It can be helpful for general purpose workloads.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
vapic object
VAPIC improves the paravirtualized handling of interrupts.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
vendorid object
VendorID allows setting the hypervisor vendor id.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
vendorid
string
VendorID sets the hypervisor vendor id, visible to the vmi.
String up to twelve characters.
vpindex object
VPIndex enables the Virtual Processor Index to help windows identifying virtual processors.
Defaults to the machine type setting.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
hypervPassthrough object
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.
enabled
boolean
kvm object
Configure how KVM presence is exposed to the guest.
hidden
boolean
Hide the KVM hypervisor from standard MSR based discovery.
Defaults to false
pvspinlock object
Notify the guest that the host supports paravirtual spinlocks.
For older kernels this feature should be explicitly disabled.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
smm object
SMM enables/disables System Management Mode.
TSEG not yet implemented.
enabled
boolean
Enabled determines if the feature should be enabled or disabled on the guest.
Defaults to true.
firmware object
Firmware.
acpi object
Information that can be set in the ACPI table
msdmNameRef
string
Similar to SlicNameRef, another ACPI entry that is used in more recent Windows versions.
The above points to the spec of MSDM too.
slicNameRef
string
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)
bootloader object
Settings to control the bootloader that is used.
bios object
If set (default), BIOS will be used.
useSerial
boolean
If set, the BIOS output will be transmitted over serial
efi object
If set, EFI will be used instead of BIOS.
persistent
boolean
If set to true, Persistent will persist the EFI NVRAM across reboots.
Defaults to false
secureBoot
boolean
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
kernelBoot object
Settings to set the kernel for booting.
container object
Container defines the container that containes kernel artifacts
image
string required
Image that contains initrd / kernel files.
imagePullPolicy
string
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
string
ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.
initrdPath
string
the fully-qualified path to the ramdisk image in the host OS
kernelPath
string
The fully-qualified path to the kernel image in the host OS
kernelArgs
string
Arguments to be passed to the kernel at boot time
serial
string
The system-serial-number in SMBIOS
uuid
string
UUID reported by the vmi bios.
Defaults to a random generated uid.
ioThreads object
IOThreads specifies the IOThreads options.
supplementalPoolThreadCount
integer
SupplementalPoolThreadCount specifies how many iothreads are allocated for the supplementalPool policy.
format:
int32
ioThreadsPolicy
string
Controls whether or not disks will share IOThreads.
Omitting IOThreadsPolicy disables use of IOThreads.
One of: shared, auto, supplementalPool
launchSecurity object
Launch Security setting of the vmi.
sev object
AMD Secure Encrypted Virtualization (SEV).
attestation
object
If specified, run the attestation process for a vmi.
dhCert
string
Base64 encoded guest owner's Diffie-Hellman key.
policy object
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.
encryptedState
boolean
SEV-ES is required.
Defaults to false.
session
string
Base64 encoded session blob.
snp
object
AMD SEV-SNP flags defined by the SEV-SNP specifications.
tdx
object
Intel Trust Domain Extensions (TDX).
machine object
Machine type.
type
string
QEMU machine type is the actual chipset of the VirtualMachineInstance.
memory object
Memory allow specifying the VMI memory features.
guest
string | integer
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.
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$hugepages object
Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory.
pageSize
string
PageSize specifies the hugepage size, for x86_64 architecture valid values are 1Gi and 2Mi.
maxGuest
string | integer
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.
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$reservedOverhead object
ReservedOverhead configures the memory overhead applied to a VM
and its characteristics.
addedOverhead
string | integer
AddedOverhead determines the memory overhead that will be reserved
for the VM. It increases the virt-launcher pod memory limit.
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
memLock
string
RequiresLock determines whether the VM's and its overhead memory
need to be locked or not. It is a common practice to enable this
if vDPA, VFIO or any other specialized hardware that depends on
DMA is being used by the VM.
False - (Default) memory lock RLimits are not modified.
True - Memory lock RLimits will be updated to consider VM memory
size and memory overhead
enum:
NotRequired, Required
rebootPolicy
string
RebootPolicy specifies how the guest should behave on reboot.
Reboot (default): The guest is allowed to reboot silently.
Terminate: The VMI will be terminated on guest reboot, allowing
higher level controllers (such as the VM controller) to recreate
the VMI with any updated configuration such as boot order changes.
enum:
Reboot, Terminateresources object
Resources describes the Compute Resources required by this vmi.
limits
object
Limits describes the maximum amount of compute resources allowed.
Valid resource keys are "memory" and "cpu".
overcommitGuestOverhead
boolean
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
object
Requests is a description of the initial vmi resources.
Valid resource keys are "memory" and "cpu".
evictionStrategy
string
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.
hostname
string
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.
livenessProbe object
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
exec object
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.
command
[]string
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.
failureThreshold
integer
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format:
int32
guestAgentPing
object
GuestAgentPing contacts the qemu-guest-agent for availability checks.
Probe failures are automatically suppressed when the guest agent is
unreachable for a non-fault reason: during live migration (guest paused
on one pod while memory is transferred) and whenever the VM is paused
for an intentional or transient reason such as a user pause, snapshot,
save, or dump. Failures are not suppressed when the VM is paused due to
a fault (IO error, crash, or postcopy failure).
httpGet object
HTTPGet specifies the http request to perform.
host
string
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
httpHeaders []object
Custom headers to set in the request. HTTP allows repeated headers.
name
string required
The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
string required
The header field value
path
string
Path to access on the HTTP server.
port
string | integer required
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
string
Scheme to use for connecting to the host.
Defaults to HTTP.
initialDelaySeconds
integer
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
format:
int32
periodSeconds
integer
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
format:
int32
successThreshold
integer
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.
format:
int32tcpSocket object
TCPSocket specifies an action involving a TCP port.
TCP hooks not yet supported
host
string
Optional: Host name to connect to, defaults to the pod IP.
port
string | integer required
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.
timeoutSeconds
integer
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
format:
int32networks []object
List of networks that can be attached to a vm's virtual interface.
maxItems:
256multus object
Represents the multus cni network.
default
boolean
Select the default network and add it to the
multus-cni.io/default-network annotation.
networkName
string required
References to a NetworkAttachmentDefinition CRD object. Format:
<networkName>, <namespace>/<networkName>. If namespace is not
specified, VMI namespace is assumed.
name
string required
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
pod object
Represents the stock pod network interface.
vmIPv6NetworkCIDR
string
IPv6 CIDR for the vm network.
Defaults to fd10:0:2::/120 if not specified.
vmNetworkCIDR
string
CIDR for vm network.
Default 10.0.2.0/24 if not specified.
nodeSelector
object
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/
priorityClassName
string
If specified, indicates the pod's priority.
If not specified, the pod priority will be default or zero if there is no
default.
readinessProbe object
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
exec object
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.
command
[]string
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.
failureThreshold
integer
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format:
int32
guestAgentPing
object
GuestAgentPing contacts the qemu-guest-agent for availability checks.
Probe failures are automatically suppressed when the guest agent is
unreachable for a non-fault reason: during live migration (guest paused
on one pod while memory is transferred) and whenever the VM is paused
for an intentional or transient reason such as a user pause, snapshot,
save, or dump. Failures are not suppressed when the VM is paused due to
a fault (IO error, crash, or postcopy failure).
httpGet object
HTTPGet specifies the http request to perform.
host
string
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
httpHeaders []object
Custom headers to set in the request. HTTP allows repeated headers.
name
string required
The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
string required
The header field value
path
string
Path to access on the HTTP server.
port
string | integer required
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
string
Scheme to use for connecting to the host.
Defaults to HTTP.
initialDelaySeconds
integer
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
format:
int32
periodSeconds
integer
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
format:
int32
successThreshold
integer
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.
format:
int32tcpSocket object
TCPSocket specifies an action involving a TCP port.
TCP hooks not yet supported
host
string
Optional: Host name to connect to, defaults to the pod IP.
port
string | integer required
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.
timeoutSeconds
integer
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
format:
int32resourceClaims []object
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.
name
string required
Name uniquely identifies this resource claim inside the pod.
This must be a DNS_LABEL.
resourceClaimName
string
ResourceClaimName is the name of a ResourceClaim object in the same
namespace as this pod.
Exactly one of ResourceClaimName and ResourceClaimTemplateName must
be set.
resourceClaimTemplateName
string
ResourceClaimTemplateName is the name of a ResourceClaimTemplate
object in the same namespace as this pod.
The template will be used to create a new ResourceClaim, which will
be bound to this pod. When this pod is deleted, the ResourceClaim
will also be deleted. The pod name and resource name, along with a
generated component, will be used to form a unique name for the
ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.
This field is immutable and no changes will be made to the
corresponding ResourceClaim by the control plane after creating the
ResourceClaim.
Exactly one of ResourceClaimName and ResourceClaimTemplateName must
be set.
schedulerName
string
If specified, the VMI will be dispatched by specified scheduler.
If not specified, the VMI will be dispatched by default scheduler.
startStrategy
string
StartStrategy can be set to "Paused" if Virtual Machine should be started in paused state.
subdomain
string
If specified, the fully qualified vmi hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>".
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.
terminationGracePeriodSeconds
integer
Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated.
format:
int64tolerations []object
If toleration is specified, obey all the toleration rules.
effect
string
Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key
string
Key is the taint key that the toleration applies to. Empty means match all taint keys.
If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator
string
Operator represents a key's relationship to the value.
Valid operators are Exists and Equal. Defaults to Equal.
Exists is equivalent to wildcard for value, so that a pod can
tolerate all taints of a particular category.
tolerationSeconds
integer
TolerationSeconds represents the period of time the toleration (which must be
of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
it is not set, which means tolerate the taint forever (do not evict). Zero and
negative values will be treated as 0 (evict immediately) by the system.
format:
int64
value
string
Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.
topologySpreadConstraints []object
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.
labelSelector object
LabelSelector is used to find matching pods.
Pods that match this label selector are counted to determine the number of pods
in their corresponding topology domain.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
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.
matchLabels
object
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.
matchLabelKeys
[]string
MatchLabelKeys is a set of pod label keys to select the pods over which
spreading will be calculated. The keys are used to lookup values from the
incoming pod labels, those key-value labels are ANDed with labelSelector
to select the group of existing pods over which spreading will be calculated
for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
MatchLabelKeys cannot be set when LabelSelector isn't set.
Keys that don't exist in the incoming pod labels will
be ignored. A null or empty list means only match against labelSelector.
This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
maxSkew
integer required
MaxSkew describes the degree to which pods may be unevenly distributed.
When 'whenUnsatisfiable=DoNotSchedule', it is the maximum permitted difference
between the number of matching pods in the target topology and the global minimum.
The global minimum is the minimum number of matching pods in an eligible domain
or zero if the number of eligible domains is less than MinDomains.
For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
labelSelector spread as 2/2/1:
In this case, the global minimum is 1.
| zone1 | zone2 | zone3 |
| P P | P P | P |
- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
violate MaxSkew(1).
- if MaxSkew is 2, incoming pod can be scheduled onto any zone.
When 'whenUnsatisfiable=ScheduleAnyway', it is used to give higher precedence
to topologies that satisfy it.
It's a required field. Default value is 1 and 0 is not allowed.
format:
int32
minDomains
integer
MinDomains indicates a minimum number of eligible domains.
When the number of eligible domains with matching topology keys is less than minDomains,
Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
And when the number of eligible domains with matching topology keys equals or greater than minDomains,
this value has no effect on scheduling.
As a result, when the number of eligible domains is less than minDomains,
scheduler won't schedule more than maxSkew Pods to those domains.
If value is nil, the constraint behaves as if MinDomains is equal to 1.
Valid values are integers greater than 0.
When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
labelSelector spread as 2/2/2:
| zone1 | zone2 | zone3 |
| P P | P P | P P |
The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
In this situation, new pod with the same labelSelector cannot be scheduled,
because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
it will violate MaxSkew.
format:
int32
nodeAffinityPolicy
string
NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
when calculating pod topology spread skew. Options are:
- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
If this value is nil, the behavior is equivalent to the Honor policy.
nodeTaintsPolicy
string
NodeTaintsPolicy indicates how we will treat node taints when calculating
pod topology spread skew. Options are:
- Honor: nodes without taints, along with tainted nodes for which the incoming pod
has a toleration, are included.
- Ignore: node taints are ignored. All nodes are included.
If this value is nil, the behavior is equivalent to the Ignore policy.
topologyKey
string required
TopologyKey is the key of node labels. Nodes that have a label with this key
and identical values are considered to be in the same topology.
We consider each <key, value> as a "bucket", and try to put balanced number
of pods into each bucket.
We define a domain as a particular instance of a topology.
Also, we define an eligible domain as a domain whose nodes meet the requirements of
nodeAffinityPolicy and nodeTaintsPolicy.
e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
It's a required field.
whenUnsatisfiable
string required
WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
the spread constraint.
- DoNotSchedule (default) tells the scheduler not to schedule it.
- ScheduleAnyway tells the scheduler to schedule the pod in any location,
but giving higher precedence to topologies that would help reduce the
skew.
A constraint is considered "Unsatisfiable" for an incoming pod
if and only if every possible node assignment for that pod would violate
"MaxSkew" on some topology.
For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
labelSelector spread as 3/1/1:
| zone1 | zone2 | zone3 |
| P P P | P | P |
If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
won't make it *more* imbalanced.
It's a required field.
utilityVolumes []object
List of utility volumes that can be mounted to the vmi virt-launcher pod
without having a matching disk in the domain.
Used to collect data for various operational workflows.
maxItems:
256
claimName
string required
claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
name
string required
UtilityVolume's name.
Must be unique within the vmi, including regular Volumes.
readOnly
boolean
readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
type
string
Type represents the type of the utility volume.
volumes []object
List of volumes that can be mounted by disks belonging to the vmi.
maxItems:
256cloudInitConfigDrive object
CloudInitConfigDrive represents a cloud-init Config Drive user-data source.
The Config Drive data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest.
More info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html
networkData
string
NetworkData contains config drive inline cloud-init networkdata.
networkDataBase64
string
NetworkDataBase64 contains config drive cloud-init networkdata as a base64 encoded string.
networkDataSecretRef object
NetworkDataSecretRef references a k8s secret that contains config drive networkdata.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
secretRef object
UserDataSecretRef references a k8s secret that contains config drive userdata.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
userData
string
UserData contains config drive inline cloud-init userdata.
userDataBase64
string
UserDataBase64 contains config drive cloud-init userdata as a base64 encoded string.
cloudInitNoCloud object
CloudInitNoCloud represents a cloud-init NoCloud user-data source.
The NoCloud data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest.
More info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html
networkData
string
NetworkData contains NoCloud inline cloud-init networkdata.
networkDataBase64
string
NetworkDataBase64 contains NoCloud cloud-init networkdata as a base64 encoded string.
networkDataSecretRef object
NetworkDataSecretRef references a k8s secret that contains NoCloud networkdata.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
secretRef object
UserDataSecretRef references a k8s secret that contains NoCloud userdata.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
userData
string
UserData contains NoCloud inline cloud-init userdata.
userDataBase64
string
UserDataBase64 contains NoCloud cloud-init userdata as a base64 encoded string.
configMap object
ConfigMapSource represents a reference to a ConfigMap in the same namespace.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or it's keys must be defined
volumeLabel
string
The volume label of the resulting disk inside the VMI.
Different bootstrapping mechanisms require different values.
Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).
containerDisk object
ContainerDisk references a docker image, embedding a qcow or raw disk.
More info: https://kubevirt.gitbooks.io/user-guide/registry-disk.html
image
string required
Image is the name of the image with the embedded disk.
imagePullPolicy
string
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
string
ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.
path
string
Path defines the path to disk file in the container
containerPath object
ContainerPath exposes a path from the virt-launcher container to the VM via virtiofs.
The path must correspond to an existing volumeMount in the compute container.
path
string required
Path is the absolute path within the virt-launcher container to expose to the VM.
The path must correspond to an existing volumeMount in the compute container.
maxLength:
4096
readOnly
boolean
ReadOnly controls whether the volume is exposed as read-only to the VM.
Defaults to true. Write access is not currently supported.
dataVolume object
DataVolume represents the dynamic creation a PVC for this volume as well as
the process of populating that PVC with a disk image.
hotpluggable
boolean
Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.
name
string required
Name of both the DataVolume and the PVC in the same namespace.
downwardAPI object
DownwardAPI represents downward API about the pod that should populate this volume
fields []object
Fields is a list of downward API volume file
fieldRef object
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
apiVersion
string
Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath
string required
Path of the field to select in the specified API version.
mode
integer
Optional: mode bits used to set permissions on this file, must be an octal value
between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.
format:
int32
path
string required
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRef object
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
containerName
string
Container name: required for volumes, optional for env vars
divisor
string | integer
Specifies the output format of the exposed resources, defaults to "1"
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
Required: resource to select
volumeLabel
string
The volume label of the resulting disk inside the VMI.
Different bootstrapping mechanisms require different values.
Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).
downwardMetrics
object
DownwardMetrics adds a very small disk to VMIs which contains a limited view of host and guest
metrics. The disk content is compatible with vhostmd (https://github.com/vhostmd/vhostmd) and vm-dump-metrics.
emptyDisk object
EmptyDisk represents a temporary disk which shares the vmis lifecycle.
More info: https://kubevirt.gitbooks.io/user-guide/disks-and-volumes.html
capacity
string | integer required
Capacity of the sparse disk.
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ephemeral object
Ephemeral is a special volume source that "wraps" specified source and provides copy-on-write image on top of it.
persistentVolumeClaim object
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace.
Directly attached to the vmi via qemu.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
claimName
string required
claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
readOnly
boolean
readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
hostDisk object
HostDisk represents a disk created on the cluster level
capacity
string | integer
Capacity of the sparse disk
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
path
string required
The path to HostDisk image located on the cluster
shared
boolean
Shared indicate whether the path is shared between nodes
type
string required
Contains information if disk.img exists or should be created
allowed options are 'Disk' and 'DiskOrCreate'
memoryDump object
MemoryDump is attached to the virt launcher and is populated with a memory dump of the vmi
claimName
string required
claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
hotpluggable
boolean
Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.
readOnly
boolean
readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
name
string required
Volume's name.
Must be a DNS_LABEL and unique within the vmi.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
persistentVolumeClaim object
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace.
Directly attached to the vmi via qemu.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
claimName
string required
claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
hotpluggable
boolean
Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.
readOnly
boolean
readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
secret object
SecretVolumeSource represents a reference to a secret data in the same namespace.
More info: https://kubernetes.io/docs/concepts/configuration/secret/
optional
boolean
Specify whether the Secret or it's keys must be defined
secretName
string
Name of the secret in the pod's namespace to use.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
volumeLabel
string
The volume label of the resulting disk inside the VMI.
Different bootstrapping mechanisms require different values.
Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).
serviceAccount object
ServiceAccountVolumeSource represents a reference to a service account.
There can only be one volume of this type!
More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
serviceAccountName
string
Name of the service account in the pod's namespace to use.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
sysprep object
Represents a Sysprep volume source.
configMap object
ConfigMap references a ConfigMap that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
secret object
Secret references a k8s Secret that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
status object
Status is the high level overview of how the VirtualMachineInstance is doing. It contains information available to controllers and users.
conditions []object
lastProbeTime
string
format:
date-time
lastTransitionTime
string
format:
date-time
message
string
reason
string
status
string required
type
string required
labelSelector
string
Canonical form of the label selector for HPA which consumes it through the scale subresource.
readyReplicas
integer
The number of ready replicas for this replica set.
format:
int32
replicas
integer
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
format:
int32No matches. Try .spec.paused for an exact path