Top Level API Objects

Definitions

k8s.io.api.core.v1.Affinity

Affinity is a group of affinity scheduling rules.

Name Description Schema

nodeAffinity
optional

Describes node affinity scheduling rules for the pod.

podAffinity
optional

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

podAntiAffinity
optional

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

k8s.io.api.core.v1.DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name Description Schema

fieldRef
optional

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

mode
optional

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.

integer (int32)

path
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 '..'
Default : ""

string

resourceFieldRef
optional

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

k8s.io.api.core.v1.ExecAction

ExecAction describes a "run in container" action.

Name Description Schema

command
optional

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.

< string > array

k8s.io.api.core.v1.HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Name Description Schema

host
optional

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

string

httpHeaders
optional

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

path
optional

Path to access on the HTTP server.

string

scheme
optional

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

Possible enum values: - "HTTP" means that the scheme used will be http:// - "HTTPS" means that the scheme used will be https://

enum (HTTP, HTTPS)

k8s.io.api.core.v1.HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Name Description Schema

name
required

The header field name
Default : ""

string

value
required

The header field value
Default : ""

string

k8s.io.api.core.v1.LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name Description Schema

name
optional

string

k8s.io.api.core.v1.NodeAffinity

Node affinity is a group of node affinity scheduling rules.

Name Description Schema

preferredDuringSchedulingIgnoredDuringExecution
optional

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.

requiredDuringSchedulingIgnoredDuringExecution
optional

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.

k8s.io.api.core.v1.NodeSelector

A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

Name Description Schema

nodeSelectorTerms
required

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

k8s.io.api.core.v1.NodeSelectorRequirement

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name Description Schema

key
required

The label key that the selector applies to.
Default : ""

string

operator
required

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

Possible enum values: - "DoesNotExist" - "Exists" - "Gt" - "In" - "Lt" - "NotIn"
Default : ""

enum (DoesNotExist, Exists, Gt, In, Lt, NotIn)

values
optional

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.

< string > array

k8s.io.api.core.v1.NodeSelectorTerm

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name Description Schema

matchExpressions
optional

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

matchFields
optional

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

k8s.io.api.core.v1.ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

Name Description Schema

apiVersion
optional

Version of the schema the FieldPath is written in terms of, defaults to "v1".

string

fieldPath
required

Path of the field to select in the specified API version.
Default : ""

string

k8s.io.api.core.v1.PersistentVolumeClaimSpec

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Name Description Schema

accessModes
optional

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

< string > array

dataSource
optional

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
optional

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
optional

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
optional

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

storageClassName
optional

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

string

volumeMode
optional

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

Possible enum values: - "Block" means the volume will not be formatted with a filesystem and will remain a raw block device. - "Filesystem" means the volume will be or is formatted with a filesystem.

enum (Block, Filesystem)

volumeName
optional

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

string

k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

Name Description Schema

claimName
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
Default : ""

string

readOnly
optional

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

boolean

k8s.io.api.core.v1.PodAffinity

Pod affinity is a group of inter pod affinity scheduling rules.

Name Description Schema

preferredDuringSchedulingIgnoredDuringExecution
optional

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.

requiredDuringSchedulingIgnoredDuringExecution
optional

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.

k8s.io.api.core.v1.PodAffinityTerm

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, 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 a pod of the set of pods is running

Name Description Schema

labelSelector
optional

A label query over a set of resources, in this case pods.

namespaceSelector
optional

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
optional

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".

< string > array

topologyKey
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.
Default : ""

string

k8s.io.api.core.v1.PodAntiAffinity

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

Name Description Schema

preferredDuringSchedulingIgnoredDuringExecution
optional

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.

requiredDuringSchedulingIgnoredDuringExecution
optional

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.

k8s.io.api.core.v1.PodDNSConfig

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

Name Description Schema

nameservers
optional

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

< string > array

options
optional

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.

searches
optional

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.

< string > array

k8s.io.api.core.v1.PodDNSConfigOption

PodDNSConfigOption defines DNS resolver options of a pod.

Name Description Schema

name
optional

Required.

string

value
optional

string

k8s.io.api.core.v1.PreferredSchedulingTerm

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name Description Schema

preference
required

A node selector term, associated with the corresponding weight.

weight
required

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

integer (int32)

k8s.io.api.core.v1.ResourceClaim

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Description Schema

name
required

Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
Default : ""

string

k8s.io.api.core.v1.ResourceFieldSelector

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Name Description Schema

containerName
optional

Container name: required for volumes, optional for env vars

string

divisor
optional

Specifies the output format of the exposed resources, defaults to "1"

resource
required

Required: resource to select
Default : ""

string

k8s.io.api.core.v1.ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Name Description Schema

claims
optional

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

limits
optional

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

requests
optional

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

k8s.io.api.core.v1.TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Name Description Schema

host
optional

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

string

k8s.io.api.core.v1.Toleration

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

Name Description Schema

effect
optional

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

Possible enum values: - "NoExecute" Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController. - "NoSchedule" Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler. - "PreferNoSchedule" Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.

enum (NoExecute, NoSchedule, PreferNoSchedule)

key
optional

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.

string

operator
optional

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.

Possible enum values: - "Equal" - "Exists"

enum (Equal, Exists)

tolerationSeconds
optional

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.

integer (int64)

value
optional

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

string

k8s.io.api.core.v1.TopologySpreadConstraint

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

Name Description Schema

labelSelector
optional

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.

matchLabelKeys
optional

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. Keys that don’t exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.

< string > array

maxSkew
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.
Default : 0

integer (int32)

minDomains
optional

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.

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

integer (int32)

nodeAffinityPolicy
optional

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. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

Possible enum values: - "Honor" means use this scheduling directive when calculating pod topology spread skew. - "Ignore" means ignore this scheduling directive when calculating pod topology spread skew.

enum (Honor, Ignore)

nodeTaintsPolicy
optional

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. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

Possible enum values: - "Honor" means use this scheduling directive when calculating pod topology spread skew. - "Ignore" means ignore this scheduling directive when calculating pod topology spread skew.

enum (Honor, Ignore)

topologyKey
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.
Default : ""

string

whenUnsatisfiable
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.

Possible enum values: - "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied. - "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
Default : ""

enum (DoNotSchedule, ScheduleAnyway)

k8s.io.api.core.v1.TypedLocalObjectReference

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

Name Description Schema

apiGroup
optional

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.

string

kind
required

Kind is the type of resource being referenced
Default : ""

string

name
required

Name is the name of resource being referenced
Default : ""

string

k8s.io.api.core.v1.TypedObjectReference

Name Description Schema

apiGroup
optional

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.

string

kind
required

Kind is the type of resource being referenced
Default : ""

string

name
required

Name is the name of resource being referenced
Default : ""

string

namespace
optional

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.

string

k8s.io.api.core.v1.WeightedPodAffinityTerm

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name Description Schema

podAffinityTerm
required

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

weight
required

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

integer (int32)

k8s.io.apimachinery.pkg.api.resource.Quantity

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

The serialization format is:

<quantity> ::= <signedNumber><suffix>
(Note that <suffix> may be empty, from the "" case in <decimalSI>.)

<digit> ::= 0 | 1 | … | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

<decimalSI> ::= m | "" | k | M | G | T | P | E

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

<decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber>

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

  • No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.

The sign will be omitted unless the number is negative.

Examples:

  • 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don’t diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

Type : string

k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup

APIGroup contains the name, the supported versions, and the preferred version of a group.

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

name
required

name is the name of the group.
Default : ""

string

preferredVersion
optional

preferredVersion is the version preferred by the API server, which probably is the storage version.

serverAddressByClientCIDRs
optional

a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.

versions
required

versions are the versions supported in this group.

k8s.io.apimachinery.pkg.apis.meta.v1.APIGroupList

APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.

Name Description Schema

apiVersion
optional

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

string

groups
required

groups is a list of APIGroup.

kind
optional

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

string

k8s.io.apimachinery.pkg.apis.meta.v1.APIResource

APIResource specifies the name of a resource and whether it is namespaced.

Name Description Schema

categories
optional

categories is a list of the grouped resources this resource belongs to (e.g. 'all')

< string > array

group
optional

group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".

string

kind
required

kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
Default : ""

string

name
required

name is the plural name of the resource.
Default : ""

string

namespaced
required

namespaced indicates if a resource is namespaced or not.
Default : false

boolean

shortNames
optional

shortNames is a list of suggested short names of the resource.

< string > array

singularName
required

singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.
Default : ""

string

storageVersionHash
optional

The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.

string

verbs
required

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)

< string > array

version
optional

version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource’s group)".

string

k8s.io.apimachinery.pkg.apis.meta.v1.APIResourceList

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

Name Description Schema

apiVersion
optional

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

string

groupVersion
required

groupVersion is the group and version this APIResourceList is for.
Default : ""

string

kind
optional

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

string

resources
required

resources contains the name of the resources and if they are namespaced.

k8s.io.apimachinery.pkg.apis.meta.v1.DeleteOptions

DeleteOptions may be provided when deleting an API object.

Name Description Schema

apiVersion
optional

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

string

dryRun
optional

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

< string > array

gracePeriodSeconds
optional

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

integer (int64)

kind
optional

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

string

orphanDependents
optional

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

boolean

preconditions
optional

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

propagationPolicy
optional

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

string

k8s.io.apimachinery.pkg.apis.meta.v1.Duration

Duration is a wrapper around time.Duration which supports correct marshaling to YAML and JSON. In particular, it marshals into strings, which can be used as map keys in json.

Type : string

k8s.io.apimachinery.pkg.apis.meta.v1.FieldsV1

FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.

Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item’s key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.

The exact format is defined in sigs.k8s.io/structured-merge-diff

Type : object

k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery

GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.

Name Description Schema

groupVersion
required

groupVersion specifies the API group and version in the form "group/version"
Default : ""

string

version
required

version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.
Default : ""

string

k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

Name Description Schema

matchExpressions
optional

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

matchLabels
optional

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.

< string, string > map

k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name Description Schema

key
required

key is the label key that the selector applies to.
Default : ""

string

operator
required

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

string

values
optional

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.

< string > array

k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Name Description Schema

continue
optional

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

string

remainingItemCount
optional

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

integer (int64)

resourceVersion
optional

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

string

selfLink
optional

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

string

k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Name Description Schema

apiVersion
optional

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

string

fieldsType
optional

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

string

fieldsV1
optional

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

manager
optional

Manager is an identifier of the workflow managing these fields.

string

operation
optional

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

string

subresource
optional

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

string

time
optional

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta

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

Name Description Schema

annotations
optional

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

< string, string > map

deletionGracePeriodSeconds
optional

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

integer (int64)

deletionTimestamp
optional

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers
optional

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

< string > array

generateName
optional

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

string

generation
optional

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

integer (int64)

labels
optional

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

< string, string > map

managedFields
optional

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

name
optional

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

string

namespace
optional

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

string

ownerReferences
optional

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

resourceVersion
optional

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

string

selfLink
optional

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

string

uid
optional

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

string

k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Name Description Schema

apiVersion
required

API version of the referent.
Default : ""

string

blockOwnerDeletion
optional

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

boolean

controller
optional

If true, this reference points to the managing controller.

boolean

kind
required

string

name
required

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
Default : ""

string

uid
required

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Default : ""

string

k8s.io.apimachinery.pkg.apis.meta.v1.Patch

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Type : object

k8s.io.apimachinery.pkg.apis.meta.v1.Preconditions

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

Name Description Schema

resourceVersion
optional

Specifies the target ResourceVersion

string

uid
optional

Specifies the target UID.

string

k8s.io.apimachinery.pkg.apis.meta.v1.RootPaths

RootPaths lists the paths available at root. For example: "/healthz", "/apis".

Name Description Schema

paths
required

paths are the paths available at root.

< string > array

k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR

ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.

Name Description Schema

clientCIDR
required

The CIDR with which clients can match their IP to figure out the server address that they should use.
Default : ""

string

serverAddress
required

Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.
Default : ""

string

k8s.io.apimachinery.pkg.apis.meta.v1.Status

Status is a return value for calls that don’t return other objects.

Name Description Schema

apiVersion
optional

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

string

code
optional

Suggested HTTP return code for this status, 0 if not set.

integer (int32)

details
optional

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

kind
optional

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

string

message
optional

A human-readable description of the status of this operation.

string

metadata
optional

reason
optional

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

string

status
optional

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

string

k8s.io.apimachinery.pkg.apis.meta.v1.StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Name Description Schema

field
optional

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"

string

message
optional

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

string

reason
optional

A machine-readable description of the cause of the error. If this value is empty there is no information available.

string

k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

Name Description Schema

causes
optional

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

group
optional

The group attribute of the resource associated with the status StatusReason.

string

kind
optional

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

string

name
optional

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

string

retryAfterSeconds
optional

If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.

integer (int32)

uid
optional

UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

string

k8s.io.apimachinery.pkg.apis.meta.v1.Time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

Type : string (date-time)

k8s.io.apimachinery.pkg.apis.meta.v1.WatchEvent

Event represents a single event to a watched resource.

Name Description Schema

object
required

Object is: * If Type is Added or Modified: the new state of the object. * If Type is Deleted: the state of the object immediately before deletion. * If Type is Error: *Status is recommended; other types may make sense depending on context.

type
required

Default : ""

string

k8s.io.apimachinery.pkg.runtime.RawExtension

RawExtension is used to hold extensions in external versions.

To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.

type MyAPIObject struct {
    runtime.TypeMeta `json:",inline"`
    MyPlugin runtime.Object `json:"myPlugin"`
}

type PluginA struct {
    AOption string `json:"aOption"`
}
type MyAPIObject struct {
    runtime.TypeMeta `json:",inline"`
    MyPlugin runtime.RawExtension `json:"myPlugin"`
}

type PluginA struct {
    AOption string `json:"aOption"`
}
{
    "kind":"MyAPIObject",
    "apiVersion":"v1",
    "myPlugin": {
       "kind":"PluginA",
       "aOption":"foo",
    },
}

So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package’s DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)

Type : object

k8s.io.apimachinery.pkg.util.intstr.IntOrString

IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.

Type : string (int-or-string)

v1.ACPI

Name Description Schema

slicNameRef
optional

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)

string

v1.AccessCredential

AccessCredential represents a credential source that can be used to authorize remote access to the vm guest Only one of its members may be specified.

Name Description Schema

sshPublicKey
optional

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

userPassword
optional

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

v1.AccessCredentialSecretSource

Name Description Schema

secretName
required

SecretName represents the name of the secret in the VMI’s namespace
Default : ""

string

v1.AddVolumeOptions

AddVolumeOptions is provided when dynamically hot plugging a volume and disk

Name Description Schema

disk
required

Disk represents the hotplug disk that will be plugged into the running VMI

dryRun
optional

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

< string > array

name
required

Name represents the name that will be used to map the disk to the corresponding volume. This overrides any name set inside the Disk struct itself.
Default : ""

string

volumeSource
required

VolumeSource represents the source of the volume to map to the disk.

v1.ArchConfiguration

Name Schema

amd64
optional

arm64
optional

defaultArchitecture
optional

string

ppc64le
optional

v1.ArchSpecificConfiguration

Name Schema

emulatedMachines
optional

< string > array

machineType
optional

string

ovmfPath
optional

string

v1.BIOS

If set (default), BIOS will be used.

Name Description Schema

useSerial
optional

If set, the BIOS output will be transmitted over serial

boolean

v1.BlockSize

BlockSize provides the option to change the block size presented to the VM for a disk. Only one of its members may be specified.

Name Schema

custom
optional

matchVolume
optional

v1.Bootloader

Represents the firmware blob used to assist in the domain creation process. Used for setting the QEMU BIOS file path for the libvirt domain.

Name Description Schema

bios
optional

If set (default), BIOS will be used.

efi
optional

If set, EFI will be used instead of BIOS.

v1.CDRomTarget

Name Description Schema

bus
optional

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

string

readonly
optional

ReadOnly. Defaults to true.

boolean

tray
optional

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

string

v1.CPU

CPU allows specifying the CPU topology.

Name Description Schema

cores
optional

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

integer (int64)

dedicatedCpuPlacement
optional

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

boolean

features
optional

Features specifies the CPU features list inside the VMI.

< v1.CPUFeature > array

isolateEmulatorThread
optional

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

boolean

maxSockets
optional

MaxSockets specifies the maximum amount of sockets that can be hotplugged

integer (int64)

model
optional

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.

string

numa
optional

NUMA allows specifying settings for the guest NUMA topology

realtime
optional

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

sockets
optional

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

integer (int64)

threads
optional

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

integer (int64)

v1.CPUFeature

CPUFeature allows specifying a CPU feature.

Name Description Schema

name
required

Name of the CPU feature
Default : ""

string

policy
optional

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

string

v1.CPUTopology

CPUTopology allows specifying the amount of cores, sockets and threads.

Name Description Schema

cores
optional

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

integer (int64)

sockets
optional

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

integer (int64)

threads
optional

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

integer (int64)

v1.CertConfig

CertConfig contains the tunables for TLS certificates

Name Description Schema

duration
optional

The requested 'duration' (i.e. lifetime) of the Certificate.

renewBefore
optional

The amount of time before the currently issued certificate’s "notAfter" time that we will begin to attempt to renew the certificate.

v1.Chassis

Chassis specifies the chassis info passed to the domain.

Name Schema

asset
optional

string

manufacturer
optional

string

serial
optional

string

sku
optional

string

version
optional

string

v1.ClientPassthroughDevices

Represent a subset of client devices that can be accessed by VMI. At the moment only, USB devices using Usbredir’s library and tooling. Another fit would be a smartcard with libcacard.

The struct is currently empty as there is no immediate request for user-facing APIs. This structure simply turns on USB redirection of UsbClientPassthroughMaxNumberOf devices.

Type : object

v1.Clock

Represents the clock and timers of a vmi.

Name Description Schema

timer
optional

Timer specifies whih timers are attached to the vmi.

timezone
optional

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

string

utc
optional

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.

v1.ClockOffset

Exactly one of its members must be set.

Name Description Schema

timezone
optional

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

string

utc
optional

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.

v1.ClockOffsetUTC

UTC sets the guest clock to UTC on each boot.

Name Description Schema

offsetSeconds
optional

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

integer (int32)

v1.CloudInitConfigDriveSource

Represents a cloud-init config drive user data source. More info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html

Name Description Schema

networkData
optional

NetworkData contains config drive inline cloud-init networkdata.

string

networkDataBase64
optional

NetworkDataBase64 contains config drive cloud-init networkdata as a base64 encoded string.

string

networkDataSecretRef
optional

NetworkDataSecretRef references a k8s secret that contains config drive networkdata.

secretRef
optional

UserDataSecretRef references a k8s secret that contains config drive userdata.

userData
optional

UserData contains config drive inline cloud-init userdata.

string

userDataBase64
optional

UserDataBase64 contains config drive cloud-init userdata as a base64 encoded string.

string

v1.CloudInitNoCloudSource

Represents a cloud-init nocloud user data source. More info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html

Name Description Schema

networkData
optional

NetworkData contains NoCloud inline cloud-init networkdata.

string

networkDataBase64
optional

NetworkDataBase64 contains NoCloud cloud-init networkdata as a base64 encoded string.

string

networkDataSecretRef
optional

NetworkDataSecretRef references a k8s secret that contains NoCloud networkdata.

secretRef
optional

UserDataSecretRef references a k8s secret that contains NoCloud userdata.

userData
optional

UserData contains NoCloud inline cloud-init userdata.

string

userDataBase64
optional

UserDataBase64 contains NoCloud cloud-init userdata as a base64 encoded string.

string

v1.ComponentConfig

Name Description Schema

nodePlacement
optional

nodePlacement describes scheduling configuration for specific KubeVirt components

replicas
optional

replicas indicates how many replicas should be created for each KubeVirt infrastructure component (like virt-api or virt-controller). Defaults to 2. WARNING: this is an advanced feature that prevents auto-scaling for core kubevirt components. Please use with caution!

integer (byte)

v1.ConfigDriveSSHPublicKeyAccessCredentialPropagation

Type : object

v1.ConfigMapVolumeSource

ConfigMapVolumeSource adapts a ConfigMap into a volume. More info: https://kubernetes.io/docs/concepts/storage/volumes/#configmap

Name Description Schema

name
optional

string

optional
optional

Specify whether the ConfigMap or it’s keys must be defined

boolean

volumeLabel
optional

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).

string

v1.ContainerDiskInfo

ContainerDiskInfo shows info about the containerdisk

Name Description Schema

checksum
optional

Checksum is the checksum of the rootdisk or kernel artifacts inside the containerdisk

integer (int64)

v1.ContainerDiskSource

Represents a docker image with an embedded disk.

Name Description Schema

image
required

Image is the name of the image with the embedded disk.
Default : ""

string

imagePullPolicy
optional

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

Possible enum values: - "Always" means that kubelet always attempts to pull the latest image. Container will fail If the pull fails. - "IfNotPresent" means that kubelet pulls if the image isn’t present on disk. Container will fail if the image isn’t present and the pull fails. - "Never" means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn’t present

enum (Always, IfNotPresent, Never)

imagePullSecret
optional

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

string

path
optional

Path defines the path to disk file in the container

string

v1.CustomBlockSize

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

Name Description Schema

logical
required

Default : 0

integer (int32)

physical
required

Default : 0

integer (int32)

v1.CustomProfile

Name Schema

localhostProfile
optional

string

runtimeDefaultProfile
optional

boolean

v1.CustomizeComponents

Name Description Schema

flags
optional

Configure the value used for deployment and daemonset resources

patches
optional

v1.CustomizeComponentsPatch

Name Description Schema

patch
required

Default : ""

string

resourceName
required

Default : ""

string

resourceType
required

Default : ""

string

type
required

Default : ""

string

v1.DHCPOptions

Extra DHCP options to use in the interface.

Name Description Schema

bootFileName
optional

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

string

ntpServers
optional

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

< string > array

privateOptions
optional

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

tftpServerName
optional

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

string

v1.DHCPPrivateOptions

DHCPExtraOptions defines Extra DHCP options for a VM.

Name Description Schema

option
required

Option is an Integer value from 224-254 Required.
Default : 0

integer (int32)

value
required

Value is a String value for the Option provided Required.
Default : ""

string

v1.DataVolumeSource

Name Description Schema

hotpluggable
optional

Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

boolean

name
required

Name of both the DataVolume and the PVC in the same namespace. After PVC population the DataVolume is garbage collected by default.
Default : ""

string

v1.DataVolumeTemplateDummyStatus

Type : object

v1.DataVolumeTemplateSpec

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

DataVolumeSpec contains the DataVolume specification.

status
optional

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

v1.DeprecatedInterfaceMacvtap

DeprecatedInterfaceMacvtap is an alias to the deprecated InterfaceMacvtap that connects to a given network by extending the Kubernetes node’s L2 networks via a macvtap interface. Deprecated: Removed in v1.3

Type : object

v1.DeprecatedInterfaceSlirp

DeprecatedInterfaceSlirp is an alias to the deprecated InterfaceSlirp that connects to a given network using QEMU user networking mode. Deprecated: Removed in v1.3

Type : object

v1.DeveloperConfiguration

DeveloperConfiguration holds developer options

Name Description Schema

cpuAllocationRatio
optional

For each requested virtual CPU, CPUAllocationRatio defines how much physical CPU to request per VMI from the hosting node. The value is in fraction of a CPU thread (or core on non-hyperthreaded nodes). For example, a value of 1 means 1 physical CPU thread per VMI CPU thread. A value of 100 would be 1% of a physical thread allocated for each requested VMI thread. This option has no effect on VMIs that request dedicated CPUs. More information at: https://kubevirt.io/user-guide/operations/node_overcommit/#node-cpu-allocation-ratio Defaults to 10

integer (int32)

diskVerification
optional

featureGates
optional

FeatureGates is the list of experimental features to enable. Defaults to none

< string > array

logVerbosity
optional

memoryOvercommit
optional

MemoryOvercommit is the percentage of memory we want to give VMIs compared to the amount given to its parent pod (virt-launcher). For example, a value of 102 means the VMI will "see" 2% more memory than its parent pod. Values under 100 are effectively "undercommits". Overcommits can lead to memory exhaustion, which in turn can lead to crashes. Use carefully. Defaults to 100

integer (int32)

minimumClusterTSCFrequency
optional

Allow overriding the automatically determined minimum TSC frequency of the cluster and fixate the minimum to this frequency.

integer (int64)

minimumReservePVCBytes
optional

MinimumReservePVCBytes is the amount of space, in bytes, to leave unused on disks. Defaults to 131072 (128KiB)

integer (int64)

nodeSelectors
optional

NodeSelectors allows restricting VMI creation to nodes that match a set of labels. Defaults to none

< string, string > map

pvcTolerateLessSpaceUpToPercent
optional

LessPVCSpaceToleration determines how much smaller, in percentage, disk PVCs are allowed to be compared to the requested size (to account for various overheads). Defaults to 10

integer (int32)

useEmulation
optional

UseEmulation can be set to true to allow fallback to software emulation in case hardware-assisted emulation is not available. Defaults to false

boolean

v1.Devices

Name Description Schema

autoattachGraphicsDevice
optional

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

boolean

autoattachInputDevice
optional

Whether to attach an Input Device. Defaults to false.

boolean

autoattachMemBalloon
optional

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

boolean

autoattachPodInterface
optional

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

boolean

autoattachSerialConsole
optional

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

boolean

autoattachVSOCK
optional

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

boolean

blockMultiQueue
optional

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

boolean

clientPassthrough
optional

To configure and access client devices such as redirecting USB

disableHotplug
optional

DisableHotplug disabled the ability to hotplug disks.

boolean

disks
optional

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

< v1.Disk > array

downwardMetrics
optional

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

filesystems
optional

Filesystems describes filesystem which is connected to the vmi.

< v1.Filesystem > array

gpus
optional

Whether to attach a GPU device to the vmi.

< v1.GPU > array

hostDevices
optional

Whether to attach a host device to the vmi.

< v1.HostDevice > array

inputs
optional

Inputs describe input devices

< v1.Input > array

interfaces
optional

Interfaces describe network interfaces which are added to the vmi.

< v1.Interface > array

logSerialConsole
optional

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.

boolean

networkInterfaceMultiqueue
optional

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.

boolean

rng
optional

Whether to have random number generator from host

sound
optional

Whether to emulate a sound device.

tpm
optional

Whether to emulate a TPM device.

useVirtioTransitional
optional

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).

boolean

watchdog
optional

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

v1.DisableFreePageReporting

Type : object

v1.DisableSerialConsoleLog

Type : object

v1.Disk

Name Description Schema

blockSize
optional

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

bootOrder
optional

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.

integer (int32)

cache
optional

Cache specifies which kvm disk cache mode should be used. Supported values are: CacheNone, CacheWriteThrough.

string

cdrom
optional

Attach a volume as a cdrom to the vmi.

dedicatedIOThread
optional

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

boolean

disk
optional

Attach a volume as a disk to the vmi.

errorPolicy
optional

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

string

io
optional

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

string

lun
optional

Attach a volume as a LUN to the vmi.

name
required

Name is the device name
Default : ""

string

serial
optional

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

string

shareable
optional

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

boolean

tag
optional

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

string

v1.DiskTarget

Name Description Schema

bus
optional

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

string

pciAddress
optional

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

string

readonly
optional

ReadOnly. Defaults to false.

boolean

v1.DiskVerification

DiskVerification holds container disks verification limits

Name Schema

memoryLimit
required

v1.DomainMemoryDumpInfo

DomainMemoryDumpInfo represents the memory dump information

Name Description Schema

claimName
optional

ClaimName is the name of the pvc the memory was dumped to

string

endTimestamp
optional

EndTimestamp is the time when the memory dump completed

startTimestamp
optional

StartTimestamp is the time when the memory dump started

targetFileName
optional

TargetFileName is the name of the memory dump output

string

v1.DomainSpec

Name Description Schema

chassis
optional

Chassis specifies the chassis info passed to the domain.

clock
optional

Clock sets the clock and timers of the vmi.

cpu
optional

CPU allow specified the detailed CPU topology inside the vmi.

devices
required

Devices allows adding disks, network interfaces, and others

features
optional

Features like acpi, apic, hyperv, smm.

firmware
optional

Firmware.

ioThreadsPolicy
optional

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

string

launchSecurity
optional

Launch Security setting of the vmi.

machine
optional

Machine type.

memory
optional

Memory allow specifying the VMI memory features.

resources
optional

Resources describes the Compute Resources required by this vmi.

v1.DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info.

Name Description Schema

fields
optional

Fields is a list of downward API volume file

volumeLabel
optional

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).

string

v1.DownwardMetrics

Type : object

v1.DownwardMetricsVolumeSource

DownwardMetricsVolumeSource 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.

Type : object

v1.EFI

If set, EFI will be used instead of BIOS.

Name Description Schema

persistent
optional

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

boolean

secureBoot
optional

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

boolean

v1.EmptyDiskSource

EmptyDisk represents a temporary disk which shares the vmis lifecycle.

Name Description Schema

capacity
required

Capacity of the sparse disk.

v1.EphemeralVolumeSource

Name Description Schema

persistentVolumeClaim
optional

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

v1.FeatureAPIC

Name Description Schema

enabled
optional

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

boolean

endOfInterrupt
optional

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

boolean

v1.FeatureHyperv

Hyperv specific features.

Name Description Schema

evmcs
optional

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

frequencies
optional

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

ipi
optional

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

reenlightenment
optional

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

relaxed
optional

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

reset
optional

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

runtime
optional

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

spinlocks
optional

Spinlocks allows to configure the spinlock retry attempts.

synic
optional

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

synictimer
optional

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

tlbflush
optional

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

vapic
optional

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

vendorid
optional

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

vpindex
optional

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

v1.FeatureKVM

Name Description Schema

hidden
optional

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

boolean

v1.FeatureSpinlocks

Name Description Schema

enabled
optional

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

boolean

spinlocks
optional

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

integer (int64)

v1.FeatureState

Represents if a feature is enabled or disabled.

Name Description Schema

enabled
optional

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

boolean

v1.FeatureVendorID

Name Description Schema

enabled
optional

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

boolean

vendorid
optional

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

string

v1.Features

Name Description Schema

acpi
optional

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

apic
optional

Defaults to the machine type setting.

hyperv
optional

Defaults to the machine type setting.

hypervPassthrough
optional

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.

kvm
optional

Configure how KVM presence is exposed to the guest.

pvspinlock
optional

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

smm
optional

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

v1.Filesystem

Name Description Schema

name
required

Name is the device name
Default : ""

string

virtiofs
required

Virtiofs is supported

v1.FilesystemVirtiofs

Type : object

v1.Firmware

Name Description Schema

acpi
optional

Information that can be set in the ACPI table

bootloader
optional

Settings to control the bootloader that is used.

kernelBoot
optional

Settings to set the kernel for booting.

serial
optional

The system-serial-number in SMBIOS

string

uuid
optional

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

string

v1.Flags

Flags will create a patch that will replace all flags for the container’s command field. The only flags that will be used are those define. There are no guarantees around forward/backward compatibility. If set incorrectly this will cause the resource when rolled out to error until flags are updated.

Name Schema

api
optional

< string, string > map

controller
optional

< string, string > map

handler
optional

< string, string > map

v1.FreezeUnfreezeTimeout

FreezeUnfreezeTimeout represent the time unfreeze will be triggered if guest was not unfrozen by unfreeze command

Name Schema

unfreezeTimeout
required

v1.GPU

Name Description Schema

deviceName
required

Default : ""

string

name
required

Name of the GPU device as exposed by a device plugin
Default : ""

string

tag
optional

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

string

virtualGPUOptions
optional

v1.GenerationStatus

GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.

Name Description Schema

group
required

group is the group of the thing you’re tracking
Default : ""

string

hash
optional

hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps

string

lastGeneration
required

lastGeneration is the last generation of the workload controller involved
Default : 0

integer (int64)

name
required

name is the name of the thing you’re tracking
Default : ""

string

namespace
optional

namespace is where the thing you’re tracking is

string

resource
required

resource is the resource type of the thing you’re tracking
Default : ""

string

v1.GuestAgentCommandInfo

List of commands that QEMU guest agent supports

Name Description Schema

enabled
optional

boolean

name
required

Default : ""

string

v1.GuestAgentPing

GuestAgentPing configures the guest-agent based ping probe

Type : object

v1.HPETTimer

Name Description Schema

present
optional

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

boolean

tickPolicy
optional

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

string

v1.HostDevice

Name Description Schema

deviceName
required

DeviceName is the resource name of the host device exposed by a device plugin
Default : ""

string

name
required

Default : ""

string

tag
optional

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

string

v1.HostDisk

Represents a disk created on the cluster level

Name Description Schema

capacity
optional

Capacity of the sparse disk

path
required

The path to HostDisk image located on the cluster
Default : ""

string

shared
optional

Shared indicate whether the path is shared between nodes

boolean

type
required

Contains information if disk.img exists or should be created allowed options are 'Disk' and 'DiskOrCreate'
Default : ""

string

v1.HotplugVolumeSource

HotplugVolumeSource Represents the source of a volume to mount which are capable of being hotplugged on a live running VMI. Only one of its members may be specified.

Name Description Schema

dataVolume
optional

DataVolume represents the dynamic creation a PVC for this volume as well as the process of populating that PVC with a disk image.

persistentVolumeClaim
optional

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

v1.HotplugVolumeStatus

HotplugVolumeStatus represents the hotplug status of the volume

Name Description Schema

attachPodName
optional

AttachPodName is the name of the pod used to attach the volume to the node.

string

attachPodUID
optional

AttachPodUID is the UID of the pod used to attach the volume to the node.

string

v1.Hugepages

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

Name Description Schema

pageSize
optional

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

string

v1.HyperVPassthrough

Name Schema

enabled
optional

boolean

v1.HypervTimer

Name Description Schema

present
optional

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

boolean

v1.I6300ESBWatchdog

i6300esb watchdog device.

Name Description Schema

action
optional

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

string

v1.InitrdInfo

InitrdInfo show info about the initrd file

Name Description Schema

checksum
optional

Checksum is the checksum of the initrd file

integer (int64)

v1.Input

Name Description Schema

bus
optional

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

string

name
required

Name is the device name
Default : ""

string

type
required

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

string

v1.InstancetypeMatcher

InstancetypeMatcher references a instancetype that is used to fill fields in the VMI template.

Name Description Schema

inferFromVolume
optional

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.

string

inferFromVolumeFailurePolicy
optional

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.

string

kind
optional

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

string

name
optional

Name is the name of the VirtualMachineInstancetype or VirtualMachineClusterInstancetype

string

revisionName
optional

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.

string

v1.Interface

Name Description Schema

acpiIndex
optional

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).

integer (int32)

binding
optional

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
optional

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.

integer (int32)

bridge
optional

dhcpOptions
optional

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

macAddress
optional

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

string

macvtap
optional

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

masquerade
optional

model
optional

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

string

name
required

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

string

passt
optional

Deprecated, please refer to Kubevirt user guide for alternatives.

pciAddress
optional

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

string

ports
optional

List of ports to be forwarded to the virtual machine.

< v1.Port > array

slirp
optional

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

sriov
optional

state
optional

State represents the requested operational state of the interface. The (only) value supported is absent, expressing a request to remove the interface.

string

tag
optional

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

string

v1.InterfaceBindingMigration

Name Description Schema

method
optional

Method defines a pre-defined migration methodology version: 1alphav1

string

v1.InterfaceBindingPlugin

Name Description Schema

domainAttachmentType
optional

DomainAttachmentType is a standard domain network attachment method kubevirt supports. Supported values: "tap". The standard domain attachment can be used instead or in addition to the sidecarImage. version: 1alphav1

string

downwardAPI
optional

DownwardAPI specifies what kind of data should be exposed to the binding plugin sidecar. Supported values: "device-info" version: v1alphav1

string

migration
optional

Migration means the VM using the plugin can be safely migrated version: 1alphav1

networkAttachmentDefinition
optional

NetworkAttachmentDefinition references to a NetworkAttachmentDefinition CR object. Format: <name>, <namespace>/<name>. If namespace is not specified, VMI namespace is assumed. version: 1alphav1

string

sidecarImage
optional

SidecarImage references a container image that runs in the virt-launcher pod. The sidecar handles (libvirt) domain configuration and optional services. version: 1alphav1

string

v1.InterfaceBridge

InterfaceBridge connects to a given network via a linux bridge.

Type : object

v1.InterfaceMasquerade

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

Type : object

v1.InterfacePasst

InterfacePasst connects to a given network.

Type : object

v1.InterfaceSRIOV

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

Type : object

v1.KSMConfiguration

KSMConfiguration holds information about KSM.

Name Description Schema

nodeLabelSelector
optional

NodeLabelSelector is a selector that filters in which nodes the KSM will be enabled. Empty NodeLabelSelector will enable ksm for every node.

v1.KVMTimer

Name Description Schema

present
optional

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

boolean

v1.KernelBoot

Represents the firmware blob used to assist in the kernel boot process. Used for setting the kernel, initrd and command line arguments

Name Description Schema

container
optional

Container defines the container that containes kernel artifacts

kernelArgs
optional

Arguments to be passed to the kernel at boot time

string

v1.KernelBootContainer

If set, the VM will be booted from the defined kernel / initrd.

Name Description Schema

image
required

Image that contains initrd / kernel files.
Default : ""

string

imagePullPolicy
optional

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

Possible enum values: - "Always" means that kubelet always attempts to pull the latest image. Container will fail If the pull fails. - "IfNotPresent" means that kubelet pulls if the image isn’t present on disk. Container will fail if the image isn’t present and the pull fails. - "Never" means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn’t present

enum (Always, IfNotPresent, Never)

imagePullSecret
optional

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

string

initrdPath
optional

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

string

kernelPath
optional

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

string

v1.KernelBootStatus

KernelBootStatus contains info about the kernelBootContainer

Name Description Schema

initrdInfo
optional

InitrdInfo show info about the initrd file

kernelInfo
optional

KernelInfo show info about the kernel image

v1.KernelInfo

KernelInfo show info about the kernel image

Name Description Schema

checksum
optional

Checksum is the checksum of the kernel image

integer (int64)

v1.KubeVirt

KubeVirt represents the object deploying all KubeVirt resources

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

status
optional

v1.KubeVirtCertificateRotateStrategy

Name Schema

selfSigned
optional

v1.KubeVirtCondition

KubeVirtCondition represents a condition of a KubeVirt deployment

Name Description Schema

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

Default : ""

string

v1.KubeVirtConfiguration

KubeVirtConfiguration holds all kubevirt configurations

Name Description Schema

additionalGuestMemoryOverheadRatio
optional

AdditionalGuestMemoryOverheadRatio can be used to increase the virtualization infrastructure overhead. This is useful, since the calculation of this overhead is not accurate and cannot be entirely known in advance. The ratio that is being set determines by which factor to increase the overhead calculated by Kubevirt. A higher ratio means that the VMs would be less compromised by node pressures, but would mean that fewer VMs could be scheduled to a node. If not set, the default is 1.

string

apiConfiguration
optional

architectureConfiguration
optional

autoCPULimitNamespaceLabelSelector
optional

When set, AutoCPULimitNamespaceLabelSelector will set a CPU limit on virt-launcher for VMIs running inside namespaces that match the label selector. The CPU limit will equal the number of requested vCPUs. This setting does not apply to VMIs with dedicated CPUs.

controllerConfiguration
optional

cpuModel
optional

string

cpuRequest
optional

defaultRuntimeClass
optional

string

developerConfiguration
optional

emulatedMachines
optional

Deprecated. Use architectureConfiguration instead.

< string > array

evictionStrategy
optional

EvictionStrategy defines at the cluster level if the VirtualMachineInstance should be migrated instead of shut-off in case of a node drain. If the VirtualMachineInstance specific field is set it overrides the cluster level one.

string

handlerConfiguration
optional

imagePullPolicy
optional

Possible enum values: - "Always" means that kubelet always attempts to pull the latest image. Container will fail If the pull fails. - "IfNotPresent" means that kubelet pulls if the image isn’t present on disk. Container will fail if the image isn’t present and the pull fails. - "Never" means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn’t present

enum (Always, IfNotPresent, Never)

ksmConfiguration
optional

KSMConfiguration holds the information regarding the enabling the KSM in the nodes (if available).

liveUpdateConfiguration
optional

LiveUpdateConfiguration holds defaults for live update features

machineType
optional

Deprecated. Use architectureConfiguration instead.

string

mediatedDevicesConfiguration
optional

memBalloonStatsPeriod
optional

integer (int64)

migrations
optional

minCPUModel
optional

string

network
optional

obsoleteCPUModels
optional

< string, boolean > map

ovmfPath
optional

Deprecated. Use architectureConfiguration instead.

string

permittedHostDevices
optional

seccompConfiguration
optional

selinuxLauncherType
optional

string

smbios
optional

supportContainerResources
optional

SupportContainerResources specifies the resource requirements for various types of supporting containers such as container disks/virtiofs/sidecars and hotplug attachment pods. If omitted a sensible default will be supplied.

supportedGuestAgentVersions
optional

deprecated

< string > array

tlsConfiguration
optional

virtualMachineInstancesPerNode
optional

integer (int32)

virtualMachineOptions
optional

vmRolloutStrategy
optional

VMRolloutStrategy defines how changes to a VM object propagate to its VMI

string

vmStateStorageClass
optional

VMStateStorageClass is the name of the storage class to use for the PVCs created to preserve VM state, like TPM. The storage class must support RWX in filesystem mode.

string

webhookConfiguration
optional

v1.KubeVirtList

KubeVirtList is a list of KubeVirts

Name Description Schema

apiVersion
optional

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

string

items
required

< v1.KubeVirt > array

kind
optional

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

string

metadata
optional

v1.KubeVirtSelfSignConfiguration

Name Description Schema

ca
optional

CA configuration CA certs are kept in the CA bundle as long as they are valid

caOverlapInterval
optional

Deprecated. Use CA.Duration and CA.RenewBefore instead

caRotateInterval
optional

Deprecated. Use CA.Duration instead

certRotateInterval
optional

Deprecated. Use Server.Duration instead

server
optional

Server configuration Certs are rotated and discarded

v1.KubeVirtSpec

Name Description Schema

certificateRotateStrategy
optional

configuration
optional

holds kubevirt configurations. same as the virt-configMap

customizeComponents
optional

imagePullPolicy
optional

The ImagePullPolicy to use.

Possible enum values: - "Always" means that kubelet always attempts to pull the latest image. Container will fail If the pull fails. - "IfNotPresent" means that kubelet pulls if the image isn’t present on disk. Container will fail if the image isn’t present and the pull fails. - "Never" means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn’t present

enum (Always, IfNotPresent, Never)

imagePullSecrets
optional

The imagePullSecrets to pull the container images from Defaults to none

imageRegistry
optional

The image registry to pull the container images from Defaults to the same registry the operator’s container image is pulled from.

string

imageTag
optional

The image tag to use for the continer images installed. Defaults to the same tag as the operator’s container image.

string

infra
optional

selectors and tolerations that should apply to KubeVirt infrastructure components

monitorAccount
optional

The name of the Prometheus service account that needs read-access to KubeVirt endpoints Defaults to prometheus-k8s

string

monitorNamespace
optional

The namespace Prometheus is deployed in Defaults to openshift-monitor

string

productComponent
optional

Designate the apps.kubevirt.io/component label for KubeVirt components. Useful if KubeVirt is included as part of a product. If ProductComponent is not specified, the component label default value is kubevirt.

string

productName
optional

Designate the apps.kubevirt.io/part-of label for KubeVirt components. Useful if KubeVirt is included as part of a product. If ProductName is not specified, the part-of label will be omitted.

string

productVersion
optional

Designate the apps.kubevirt.io/version label for KubeVirt components. Useful if KubeVirt is included as part of a product. If ProductVersion is not specified, KubeVirt’s version will be used.

string

serviceMonitorNamespace
optional

The namespace the service monitor will be deployed When ServiceMonitorNamespace is set, then we’ll install the service monitor object in that namespace otherwise we will use the monitoring namespace.

string

uninstallStrategy
optional

Specifies if kubevirt can be deleted if workloads are still present. This is mainly a precaution to avoid accidental data loss

string

workloadUpdateStrategy
optional

WorkloadUpdateStrategy defines at the cluster level how to handle automated workload updates

workloads
optional

selectors and tolerations that should apply to KubeVirt workloads

v1.KubeVirtStatus

KubeVirtStatus represents information pertaining to a KubeVirt deployment.

Name Schema

conditions
optional

defaultArchitecture
optional

string

generations
optional

observedDeploymentConfig
optional

string

observedDeploymentID
optional

string

observedGeneration
optional

integer (int64)

observedKubeVirtRegistry
optional

string

observedKubeVirtVersion
optional

string

operatorVersion
optional

string

outdatedVirtualMachineInstanceWorkloads
optional

integer (int32)

phase
optional

string

targetDeploymentConfig
optional

string

targetDeploymentID
optional

string

targetKubeVirtRegistry
optional

string

targetKubeVirtVersion
optional

string

v1.KubeVirtWorkloadUpdateStrategy

KubeVirtWorkloadUpdateStrategy defines options related to updating a KubeVirt install

Name Description Schema

batchEvictionInterval
optional

BatchEvictionInterval Represents the interval to wait before issuing the next batch of shutdowns

Defaults to 1 minute

batchEvictionSize
optional

BatchEvictionSize Represents the number of VMIs that can be forced updated per the BatchShutdownInteral interval

Defaults to 10

integer (int32)

workloadUpdateMethods
optional

WorkloadUpdateMethods defines the methods that can be used to disrupt workloads during automated workload updates. When multiple methods are present, the least disruptive method takes precedence over more disruptive methods. For example if both LiveMigrate and Shutdown methods are listed, only VMs which are not live migratable will be restarted/shutdown

An empty list defaults to no automated workload updating

< string > array

v1.LaunchSecurity

Name Description Schema

sev
optional

AMD Secure Encrypted Virtualization (SEV).

v1.LiveUpdateConfiguration

Name Description Schema

maxCpuSockets
optional

MaxCpuSockets holds the maximum amount of sockets that can be hotplugged

integer (int64)

maxGuest
optional

MaxGuest defines the maximum amount memory that can be allocated to the guest using hotplug.

maxHotplugRatio
optional

MaxHotplugRatio is the ratio used to define the max amount of a hotplug resource that can be made available to a VM when the specific Max* setting is not defined (MaxCpuSockets, MaxGuest) Example: VM is configured with 512Mi of guest memory, if MaxGuest is not defined and MaxHotplugRatio is 2 then MaxGuest = 1Gi defaults to 4

integer (int64)

v1.LogVerbosity

LogVerbosity sets log verbosity level of various components

Name Description Schema

nodeVerbosity
optional

NodeVerbosity represents a map of nodes with a specific verbosity level

< string, integer (int32) > map

virtAPI
optional

integer (int32)

virtController
optional

integer (int32)

virtHandler
optional

integer (int32)

virtLauncher
optional

integer (int32)

virtOperator
optional

integer (int32)

v1.LunTarget

Name Description Schema

bus
optional

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

string

readonly
optional

ReadOnly. Defaults to false.

boolean

reservation
optional

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

boolean

v1.Machine

Name Description Schema

type
optional

QEMU machine type is the actual chipset of the VirtualMachineInstance.
Default : ""

string

v1.MediatedDevicesConfiguration

MediatedDevicesConfiguration holds information about MDEV types to be defined, if available

Name Description Schema

mediatedDeviceTypes
optional

< string > array

mediatedDevicesTypes
optional

Deprecated. Use mediatedDeviceTypes instead.

< string > array

nodeMediatedDeviceTypes
optional

v1.MediatedHostDevice

MediatedHostDevice represents a host mediated device allowed for passthrough

Name Description Schema

externalResourceProvider
optional

boolean

mdevNameSelector
required

Default : ""

string

resourceName
required

Default : ""

string

v1.Memory

Memory allows specifying the VirtualMachineInstance memory features.

Name Description Schema

guest
optional

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
optional

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

maxGuest
optional

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.

v1.MemoryDumpVolumeSource

Name Description Schema

claimName
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
Default : ""

string

hotpluggable
optional

Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

boolean

readOnly
optional

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

boolean

v1.MemoryStatus

Name Description Schema

guestAtBoot
optional

GuestAtBoot specifies with how much memory the VirtualMachine intiallly booted with.

guestCurrent
optional

GuestCurrent specifies how much memory is currently available for the VirtualMachine.

guestRequested
optional

GuestRequested specifies how much memory was requested (hotplug) for the VirtualMachine.

v1.MigrateOptions

MigrateOptions may be provided on migrate request.

Name Description Schema

apiVersion
optional

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

string

dryRun
optional

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

< string > array

kind
optional

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

string

v1.MigrationConfiguration

MigrationConfiguration holds migration options. Can be overridden for specific groups of VMs though migration policies. Visit https://kubevirt.io/user-guide/operations/migration_policies/ for more information.

Name Description Schema

allowAutoConverge
optional

AllowAutoConverge allows the platform to compromise performance/availability of VMIs to guarantee successful VMI live migrations. Defaults to false

boolean

allowPostCopy
optional

AllowPostCopy enables post-copy live migrations. Such migrations allow even the busiest VMIs to successfully live-migrate. However, events like a network failure can cause a VMI crash. If set to true, migrations will still start in pre-copy, but switch to post-copy when CompletionTimeoutPerGiB triggers. Defaults to false

boolean

bandwidthPerMigration
optional

BandwidthPerMigration limits the amount of network bandwidth live migrations are allowed to use. The value is in quantity per second. Defaults to 0 (no limit)

completionTimeoutPerGiB
optional

CompletionTimeoutPerGiB is the maximum number of seconds per GiB a migration is allowed to take. If a live-migration takes longer to migrate than this value multiplied by the size of the VMI, the migration will be cancelled, unless AllowPostCopy is true. Defaults to 800

integer (int64)

disableTLS
optional

When set to true, DisableTLS will disable the additional layer of live migration encryption provided by KubeVirt. This is usually a bad idea. Defaults to false

boolean

matchSELinuxLevelOnMigration
optional

By default, the SELinux level of target virt-launcher pods is forced to the level of the source virt-launcher. When set to true, MatchSELinuxLevelOnMigration lets the CRI auto-assign a random level to the target. That will ensure the target virt-launcher doesn’t share categories with another pod on the node. However, migrations will fail when using RWX volumes that don’t automatically deal with SELinux levels.

boolean

network
optional

Network is the name of the CNI network to use for live migrations. By default, migrations go through the pod network.

string

nodeDrainTaintKey
optional

NodeDrainTaintKey defines the taint key that indicates a node should be drained. Note: this option relies on the deprecated node taint feature. Default: kubevirt.io/drain

string

parallelMigrationsPerCluster
optional

ParallelMigrationsPerCluster is the total number of concurrent live migrations allowed cluster-wide. Defaults to 5

integer (int64)

parallelOutboundMigrationsPerNode
optional

ParallelOutboundMigrationsPerNode is the maximum number of concurrent outgoing live migrations allowed per node. Defaults to 2

integer (int64)

progressTimeout
optional

ProgressTimeout is the maximum number of seconds a live migration is allowed to make no progress. Hitting this timeout means a migration transferred 0 data for that many seconds. The migration is then considered stuck and therefore cancelled. Defaults to 150

integer (int64)

unsafeMigrationOverride
optional

UnsafeMigrationOverride allows live migrations to occur even if the compatibility check indicates the migration will be unsafe to the guest. Defaults to false

boolean

v1.MultusNetwork

Represents the multus cni network.

Name Description Schema

default
optional

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

boolean

networkName
required

References to a NetworkAttachmentDefinition CRD object. Format: <networkName>, <namespace>/<networkName>. If namespace is not specified, VMI namespace is assumed.
Default : ""

string

v1.NUMA

Name Description Schema

guestMappingPassthrough
optional

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.

v1.NUMAGuestMappingPassthrough

NUMAGuestMappingPassthrough instructs kubevirt to model numa topology which is compatible with the CPU pinning on the guest. This will result in a subset of the node numa topology being passed through, ensuring that virtual numa nodes and their memory never cross boundaries coming from the node numa mapping.

Type : object

v1.Network

Network represents a network type and a resource that should be connected to the vm.

Name Description Schema

multus
optional

name
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
Default : ""

string

pod
optional

v1.NetworkConfiguration

NetworkConfiguration holds network options

Name Description Schema

binding
optional

< string, v1.InterfaceBindingPlugin > map

defaultNetworkInterface
optional

string

permitBridgeInterfaceOnPodNetwork
optional

boolean

permitSlirpInterface
optional

DeprecatedPermitSlirpInterface is an alias for the deprecated PermitSlirpInterface. Deprecated: Removed in v1.3.

boolean

v1.NoCloudSSHPublicKeyAccessCredentialPropagation

Type : object

v1.NodeMediatedDeviceTypesConfig

NodeMediatedDeviceTypesConfig holds information about MDEV types to be defined in a specific node that matches the NodeSelector field.

Name Description Schema

mediatedDeviceTypes
optional

< string > array

mediatedDevicesTypes
optional

Deprecated. Use mediatedDeviceTypes instead.

< string > array

nodeSelector
required

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/

< string, string > map

v1.NodePlacement

NodePlacement describes node scheduling configuration.

Name Description Schema

affinity
optional

affinity enables pod affinity/anti-affinity placement expanding the types of constraints that can be expressed with nodeSelector. affinity is going to be applied to the relevant kind of pods in parallel with nodeSelector See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity

nodeSelector
optional

nodeSelector is the node selector applied to the relevant kind of pods It specifies a map of key-value pairs: for the pod to be eligible to run on a node, the node must have each of the indicated key-value pairs as labels (it can have additional labels as well). See https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector

< string, string > map

tolerations
optional

tolerations is a list of tolerations applied to the relevant kind of pods See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ for more info. These are additional tolerations other than default ones.

v1.PITTimer

Name Description Schema

present
optional

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

boolean

tickPolicy
optional

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

string

v1.PauseOptions

PauseOptions may be provided on pause request.

Name Description Schema

apiVersion
optional

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

string

dryRun
optional

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

< string > array

kind
optional

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

string

v1.PciHostDevice

PciHostDevice represents a host PCI device allowed for passthrough

Name Description Schema

externalResourceProvider
optional

If true, KubeVirt will leave the allocation and monitoring to an external device plugin

boolean

pciVendorSelector
required

The vendor_id:product_id tuple of the PCI device
Default : ""

string

resourceName
required

The name of the resource that is representing the device. Exposed by a device plugin and requested by VMs. Typically of the form vendor.com/product_name
Default : ""

string

v1.PermittedHostDevices

PermittedHostDevices holds information about devices allowed for passthrough

Name Schema

mediatedDevices
optional

pciHostDevices
optional

< v1.PciHostDevice > array

usb
optional

< v1.USBHostDevice > array

v1.PersistentVolumeClaimInfo

PersistentVolumeClaimInfo contains the relavant information virt-handler needs cached about a PVC

Name Description Schema

accessModes
optional

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

< string > array

capacity
optional

Capacity represents the capacity set on the corresponding PVC status

filesystemOverhead
optional

Percentage of filesystem’s size to be reserved when resizing the PVC

string

preallocated
optional

Preallocated indicates if the PVC’s storage is preallocated or not

boolean

requests
optional

Requests represents the resources requested by the corresponding PVC spec

volumeMode
optional

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

Possible enum values: - "Block" means the volume will not be formatted with a filesystem and will remain a raw block device. - "Filesystem" means the volume will be or is formatted with a filesystem.

enum (Block, Filesystem)

v1.PersistentVolumeClaimVolumeSource

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

Name Description Schema

claimName
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
Default : ""

string

hotpluggable
optional

Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

boolean

readOnly
optional

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

boolean

v1.PluginBinding

PluginBinding represents a binding implemented in a plugin.

Name Description Schema

name
required

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

string

v1.PodNetwork

Represents the stock pod network interface.

Name Description Schema

vmIPv6NetworkCIDR
optional

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

string

vmNetworkCIDR
optional

CIDR for vm network. Default 10.0.2.0/24 if not specified.

string

v1.Port

Port represents a port to expose from the virtual machine. Default protocol TCP. The port field is mandatory

Name Description Schema

name
optional

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.

string

port
required

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

integer (int32)

protocol
optional

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

string

v1.PreferenceMatcher

PreferenceMatcher references a set of preference that is used to fill fields in the VMI template.

Name Description Schema

inferFromVolume
optional

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.

string

inferFromVolumeFailurePolicy
optional

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.

string

kind
optional

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

string

name
optional

Name is the name of the VirtualMachinePreference or VirtualMachineClusterPreference

string

revisionName
optional

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.

string

v1.Probe

Probe describes a health check to be performed against a VirtualMachineInstance to determine whether it is alive or ready to receive traffic.

Name Description Schema

exec
optional

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.

failureThreshold
optional

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

integer (int32)

guestAgentPing
optional

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

httpGet
optional

HTTPGet specifies the http request to perform.

initialDelaySeconds
optional

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

integer (int32)

periodSeconds
optional

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

integer (int32)

successThreshold
optional

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.

integer (int32)

tcpSocket
optional

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

timeoutSeconds
optional

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

integer (int32)

v1.QemuGuestAgentSSHPublicKeyAccessCredentialPropagation

Name Description Schema

users
required

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

< string > array

v1.QemuGuestAgentUserPasswordAccessCredentialPropagation

Type : object

v1.RESTClientConfiguration

RESTClientConfiguration allows configuring certain aspects of the k8s rest client.

Name Description Schema

rateLimiter
optional

RateLimiter allows selecting and configuring different rate limiters for the k8s client.

v1.RTCTimer

Name Description Schema

present
optional

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

boolean

tickPolicy
optional

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

string

track
optional

Track the guest or the wall clock.

string

v1.RateLimiter

Name Schema

tokenBucketRateLimiter
optional

v1.Realtime

Realtime holds the tuning knobs specific for realtime workloads.

Name Description Schema

mask
optional

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"

string

v1.ReloadableComponentConfiguration

ReloadableComponentConfiguration holds all generic k8s configuration options which can be reloaded by components without requiring a restart.

Name Description Schema

restClient
optional

RestClient can be used to tune certain aspects of the k8s client in use.

v1.RemoveVolumeOptions

RemoveVolumeOptions is provided when dynamically hot unplugging volume and disk

Name Description Schema

dryRun
optional

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

< string > array

name
required

Name represents the name that maps to both the disk and volume that should be removed
Default : ""

string

v1.ResourceRequirements

Name Description Schema

limits
optional

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

object

overcommitGuestOverhead
optional

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.

boolean

requests
optional

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

object

v1.RestartOptions

RestartOptions may be provided when deleting an API object.

Name Description Schema

apiVersion
optional

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

string

dryRun
optional

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

< string > array

gracePeriodSeconds
optional

The duration in seconds before the object should be force-restarted. Value must be non-negative integer. The value zero indicates, restart immediately. If this value is nil, the default grace period for deletion of the corresponding VMI for the specified type will be used to determine on how much time to give the VMI to restart. Defaults to a per object value if not specified. zero means restart immediately. Allowed Values: nil and 0

integer (int64)

kind
optional

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

string

v1.Rng

Rng represents the random device passed from host

Type : object

v1.SEV

Name Description Schema

attestation
optional

If specified, run the attestation process for a vmi.

dhCert
optional

Base64 encoded guest owner’s Diffie-Hellman key.

string

policy
optional

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.

session
optional

Base64 encoded session blob.

string

v1.SEVAttestation

Type : object

v1.SEVMeasurementInfo

SEVMeasurementInfo contains information about the guest launch measurement.

Name Description Schema

apiMajor
optional

API major version of the SEV host.

integer (int32)

apiMinor
optional

API minor version of the SEV host.

integer (int32)

apiVersion
optional

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

string

buildID
optional

Build ID of the SEV host.

integer (int32)

kind
optional

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

string

loaderSHA
optional

SHA256 of the loader binary

string

measurement
optional

Base64 encoded launch measurement of the SEV guest.

string

policy
optional

Policy of the SEV guest.

integer (int32)

v1.SEVPlatformInfo

SEVPlatformInfo contains information about the AMD SEV features for the node.

Name Description Schema

apiVersion
optional

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

string

certChain
optional

Base64 encoded SEV certificate chain.

string

kind
optional

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

string

pdh
optional

Base64 encoded platform Diffie-Hellman key.

string

v1.SEVPolicy

Name Description Schema

encryptedState
optional

SEV-ES is required. Defaults to false.

boolean

v1.SEVSecretOptions

SEVSecretOptions is used to provide a secret for a running guest.

Name Description Schema

header
optional

Base64 encoded header needed to decrypt the secret.

string

secret
optional

Base64 encoded encrypted launch secret.

string

v1.SEVSessionOptions

SEVSessionOptions is used to provide SEV session parameters.

Name Description Schema

dhCert
optional

Base64 encoded guest owner’s Diffie-Hellman key.

string

session
optional

Base64 encoded session blob.

string

v1.SMBiosConfiguration

Name Schema

family
optional

string

manufacturer
optional

string

product
optional

string

sku
optional

string

version
optional

string

v1.SSHPublicKeyAccessCredential

SSHPublicKeyAccessCredential represents a source and propagation method for injecting ssh public keys into a vm guest

Name Description Schema

propagationMethod
required

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

source
required

Source represents where the public keys are pulled from

v1.SSHPublicKeyAccessCredentialPropagationMethod

SSHPublicKeyAccessCredentialPropagationMethod represents the method used to inject a ssh public key into the vm guest. Only one of its members may be specified.

Name Description Schema

configDrive
optional

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

noCloud
optional

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

qemuGuestAgent
optional

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.

v1.SSHPublicKeyAccessCredentialSource

SSHPublicKeyAccessCredentialSource represents where to retrieve the ssh key credentials Only one of its members may be specified.

Name Description Schema

secret
optional

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

v1.SeccompConfiguration

SeccompConfiguration holds Seccomp configuration for Kubevirt components

Name Description Schema

virtualMachineInstanceProfile
optional

VirtualMachineInstanceProfile defines what profile should be used with virt-launcher. Defaults to none

v1.SecretVolumeSource

SecretVolumeSource adapts a Secret into a volume.

Name Description Schema

optional
optional

Specify whether the Secret or it’s keys must be defined

boolean

secretName
optional

Name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

string

volumeLabel
optional

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).

string

v1.ServiceAccountVolumeSource

ServiceAccountVolumeSource adapts a ServiceAccount into a volume.

Name Description Schema

serviceAccountName
optional

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/

string

v1.SoundDevice

Represents the user’s configuration to emulate sound cards in the VMI.

Name Description Schema

model
optional

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

string

name
required

User’s defined name for this sound device
Default : ""

string

v1.StartOptions

StartOptions may be provided on start request.

Name Description Schema

apiVersion
optional

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

string

dryRun
optional

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

< string > array

kind
optional

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

string

paused
optional

Indicates that VM will be started in paused state.

boolean

v1.StopOptions

StopOptions may be provided when deleting an API object.

Name Description Schema

apiVersion
optional

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

string

dryRun
optional

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

< string > array

gracePeriod
optional

this updates the VMIs terminationGracePeriodSeconds during shutdown

integer (int64)

kind
optional

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

string

v1.SupportContainerResources

SupportContainerResources are used to specify the cpu/memory request and limits for the containers that support various features of Virtual Machines. These containers are usually idle and don’t require a lot of memory or cpu.

Name Description Schema

resources
required

type
required

Default : ""

string

v1.SyNICTimer

Name Schema

direct
optional

enabled
optional

boolean

v1.SysprepSource

Represents a Sysprep volume source.

Name Description Schema

configMap
optional

ConfigMap references a ConfigMap that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.

secret
optional

Secret references a k8s Secret that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.

v1.TLSConfiguration

TLSConfiguration holds TLS options

Name Description Schema

ciphers
optional

< string > array

minTLSVersion
optional

MinTLSVersion is a way to specify the minimum protocol version that is acceptable for TLS connections. Protocol versions are based on the following most common TLS configurations:

Note that SSLv3.0 is not a supported protocol version due to well known vulnerabilities such as POODLE: https://en.wikipedia.org/wiki/POODLE

string

v1.TPMDevice

Name Description Schema

persistent
optional

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

boolean

v1.Timer

Represents all available timers in a vmi.

Name Description Schema

hpet
optional

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

hyperv
optional

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

kvm
optional

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

pit
optional

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

rtc
optional

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

v1.TokenBucketRateLimiter

Name Description Schema

burst
required

Maximum burst for throttle. If it’s zero, the component default will be used
Default : 0

integer (int32)

qps
required

QPS indicates the maximum QPS to the apiserver from this client. If it’s zero, the component default will be used
Default : 0.0

number (float)

v1.TopologyHints

Name Schema

tscFrequency
optional

integer (int64)

v1.USBHostDevice

Name Description Schema

externalResourceProvider
optional

If true, KubeVirt will leave the allocation and monitoring to an external device plugin

boolean

resourceName
required

Identifies the list of USB host devices. e.g: kubevirt.io/storage, kubevirt.io/bootable-usb, etc
Default : ""

string

selectors
optional

< v1.USBSelector > array

v1.USBSelector

Name Description Schema

product
required

Default : ""

string

vendor
required

Default : ""

string

v1.UnpauseOptions

UnpauseOptions may be provided on unpause request.

Name Description Schema

apiVersion
optional

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

string

dryRun
optional

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

< string > array

kind
optional

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

string

v1.UserPasswordAccessCredential

UserPasswordAccessCredential represents a source and propagation method for injecting user passwords into a vm guest Only one of its members may be specified.

Name Description Schema

propagationMethod
required

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

source
required

Source represents where the user passwords are pulled from

v1.UserPasswordAccessCredentialPropagationMethod

UserPasswordAccessCredentialPropagationMethod represents the method used to inject a user passwords into the vm guest. Only one of its members may be specified.

Name Description Schema

qemuGuestAgent
optional

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.

v1.UserPasswordAccessCredentialSource

UserPasswordAccessCredentialSource represents where to retrieve the user password credentials Only one of its members may be specified.

Name Description Schema

secret
optional

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

v1.VGPUDisplayOptions

Name Description Schema

enabled
optional

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

boolean

ramFB
optional

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

v1.VGPUOptions

Name Schema

display
optional

v1.VirtualMachine

VirtualMachine handles the VirtualMachines that are not running or are in a stopped state The VirtualMachine contains the template to create the VirtualMachineInstance. It also mirrors the running state of the created VirtualMachineInstance in its status.

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

Spec contains the specification of VirtualMachineInstance created

status
optional

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

v1.VirtualMachineCondition

VirtualMachineCondition represents the state of VirtualMachine

Name Description Schema

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

Default : ""

string

v1.VirtualMachineInstance

VirtualMachineInstance is the VirtualMachineInstance Definition. It represents a virtual machine in the runtime environment of kubernetes.

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

status
optional

Status is the high level overview of how the VirtualMachineInstance is doing. It contains information available to controllers and users.

v1.VirtualMachineInstanceCondition

Name Description Schema

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

Default : ""

string

v1.VirtualMachineInstanceFileSystem

VirtualMachineInstanceFileSystem represents guest os disk

Name Description Schema

disk
optional

diskName
required

Default : ""

string

fileSystemType
required

Default : ""

string

mountPoint
required

Default : ""

string

totalBytes
required

Default : 0

integer (int32)

usedBytes
required

Default : 0

integer (int32)

v1.VirtualMachineInstanceFileSystemDisk

VirtualMachineInstanceFileSystemDisk represents the guest os FS disks

Name Description Schema

busType
required

Default : ""

string

serial
optional

string

v1.VirtualMachineInstanceFileSystemInfo

VirtualMachineInstanceFileSystemInfo represents information regarding single guest os filesystem

Name Schema

disks
required

v1.VirtualMachineInstanceFileSystemList

VirtualMachineInstanceFileSystemList comprises the list of all filesystems on guest machine

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1.VirtualMachineInstanceGuestAgentInfo

VirtualMachineInstanceGuestAgentInfo represents information from the installed guest agent

Name Description Schema

apiVersion
optional

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

string

fsFreezeStatus
optional

FSFreezeStatus is the state of the fs of the guest it can be either frozen or thawed

string

fsInfo
optional

FSInfo is a guest os filesystem information containing the disk mapping and disk mounts with usage

guestAgentVersion
optional

GAVersion is a version of currently installed guest agent

string

hostname
optional

Hostname represents FQDN of a guest

string

kind
optional

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

string

os
optional

OS contains the guest operating system information

supportedCommands
optional

Return command list the guest agent supports

timezone
optional

Timezone is guest os current timezone

string

userList
optional

UserList is a list of active guest OS users

v1.VirtualMachineInstanceGuestOSInfo

Name Description Schema

id
optional

Guest OS Id

string

kernelRelease
optional

Guest OS Kernel Release

string

kernelVersion
optional

Kernel version of the Guest OS

string

machine
optional

Machine type of the Guest OS

string

name
optional

Name of the Guest OS

string

prettyName
optional

Guest OS Pretty Name

string

version
optional

Guest OS Version

string

versionId
optional

Version ID of the Guest OS

string

v1.VirtualMachineInstanceGuestOSUser

VirtualMachineGuestOSUser is the single user of the guest os

Name Description Schema

domain
optional

string

loginTime
optional

number (double)

userName
required

Default : ""

string

v1.VirtualMachineInstanceGuestOSUserList

VirtualMachineInstanceGuestOSUserList comprises the list of all active users on guest machine

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1.VirtualMachineInstanceList

VirtualMachineInstanceList is a list of VirtualMachines

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1.VirtualMachineInstanceMigration

VirtualMachineInstanceMigration represents the object tracking a VMI’s migration to another host in the cluster

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

status
optional

v1.VirtualMachineInstanceMigrationCondition

Name Description Schema

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

Default : ""

string

v1.VirtualMachineInstanceMigrationList

VirtualMachineInstanceMigrationList is a list of VirtualMachineMigrations

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1.VirtualMachineInstanceMigrationPhaseTransitionTimestamp

VirtualMachineInstanceMigrationPhaseTransitionTimestamp gives a timestamp in relation to when a phase is set on a vmi

Name Description Schema

phase
optional

Phase is the status of the VirtualMachineInstanceMigrationPhase in kubernetes world. It is not the VirtualMachineInstanceMigrationPhase status, but partially correlates to it.

string

phaseTransitionTimestamp
optional

PhaseTransitionTimestamp is the timestamp of when the phase change occurred

v1.VirtualMachineInstanceMigrationSpec

Name Description Schema

vmiName
optional

The name of the VMI to perform the migration on. VMI must exist in the migration objects namespace

string

v1.VirtualMachineInstanceMigrationState

Name Description Schema

abortRequested
optional

Indicates that the migration has been requested to abort

boolean

abortStatus
optional

Indicates the final status of the live migration abortion

string

completed
optional

Indicates the migration completed

boolean

endTimestamp
optional

The time the migration action ended

failed
optional

Indicates that the migration failed

boolean

failureReason
optional

Contains the reason why the migration failed

string

migrationConfiguration
optional

Migration configurations to apply

migrationPolicyName
optional

Name of the migration policy. If string is empty, no policy is matched

string

migrationUid
optional

The VirtualMachineInstanceMigration object associated with this migration

string

mode
optional

Lets us know if the vmi is currently running pre or post copy migration

string

sourceNode
optional

The source node that the VMI originated on

string

sourcePod
optional

string

startTimestamp
optional

The time the migration action began

targetAttachmentPodUID
optional

The UID of the target attachment pod for hotplug volumes

string

targetCPUSet
optional

If the VMI requires dedicated CPUs, this field will hold the dedicated CPU set on the target node

< integer (int32) > array

targetDirectMigrationNodePorts
optional

The list of ports opened for live migration on the destination node

< string, integer (int32) > map

targetNode
optional

The target node that the VMI is moving to

string

targetNodeAddress
optional

The address of the target node to use for the migration

string

targetNodeDomainDetected
optional

The Target Node has seen the Domain Start Event

boolean

targetNodeDomainReadyTimestamp
optional

The timestamp at which the target node detects the domain is active

targetNodeTopology
optional

If the VMI requires dedicated CPUs, this field will hold the numa topology on the target node

string

targetPod
optional

The target pod that the VMI is moving to

string

v1.VirtualMachineInstanceMigrationStatus

VirtualMachineInstanceMigration reprents information pertaining to a VMI’s migration.

Name Description Schema

conditions
optional

migrationState
optional

Represents the status of a live migration

phase
optional

string

phaseTransitionTimestamps
optional

PhaseTransitionTimestamp is the timestamp of when the last phase change occurred

v1.VirtualMachineInstanceNetworkInterface

Name Description Schema

infoSource
optional

Specifies the origin of the interface data collected. values: domain, guest-agent, multus-status.

string

interfaceName
optional

The interface name inside the Virtual Machine

string

ipAddress
optional

IP address of a Virtual Machine interface. It is always the first item of IPs

string

ipAddresses
optional

List of all IP addresses of a Virtual Machine interface

< string > array

mac
optional

Hardware address of a Virtual Machine interface

string

name
optional

Name of the interface, corresponds to name of the network assigned to the interface

string

queueCount
optional

Specifies how many queues are allocated by MultiQueue

integer (int32)

v1.VirtualMachineInstancePhaseTransitionTimestamp

VirtualMachineInstancePhaseTransitionTimestamp gives a timestamp in relation to when a phase is set on a vmi

Name Description Schema

phase
optional

Phase is the status of the VirtualMachineInstance in kubernetes world. It is not the VirtualMachineInstance status, but partially correlates to it.

string

phaseTransitionTimestamp
optional

PhaseTransitionTimestamp is the timestamp of when the phase change occurred

v1.VirtualMachineInstancePreset

Deprecated for removal in v2, please use VirtualMachineInstanceType and VirtualMachinePreference instead.

VirtualMachineInstancePreset defines a VMI spec.domain to be applied to all VMIs that match the provided label selector More info: https://kubevirt.io/user-guide/virtual_machines/presets/#overrides

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
optional

VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

v1.VirtualMachineInstancePresetList

VirtualMachineInstancePresetList is a list of VirtualMachinePresets

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1.VirtualMachineInstancePresetSpec

Name Description Schema

domain
optional

Domain is the same object type as contained in VirtualMachineInstanceSpec

selector
required

Selector is a label query over a set of VMIs. Required.

v1.VirtualMachineInstanceProfile

Name Description Schema

customProfile
optional

CustomProfile allows to request arbitrary profile for virt-launcher

v1.VirtualMachineInstanceReplicaSet

VirtualMachineInstance is the VirtualMachineInstance Definition. It represents a virtual machine in the runtime environment of kubernetes.

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

status
optional

Status is the high level overview of how the VirtualMachineInstance is doing. It contains information available to controllers and users.

v1.VirtualMachineInstanceReplicaSetCondition

Name Description Schema

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

Default : ""

string

v1.VirtualMachineInstanceReplicaSetList

VMIList is a list of VMIs

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1.VirtualMachineInstanceReplicaSetSpec

Name Description Schema

paused
optional

Indicates that the replica set is paused.

boolean

replicas
optional

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

integer (int32)

selector
required

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.

template
required

Template describes the pods that will be created.

v1.VirtualMachineInstanceReplicaSetStatus

Name Description Schema

conditions
optional

labelSelector
optional

Canonical form of the label selector for HPA which consumes it through the scale subresource.

string

readyReplicas
optional

The number of ready replicas for this replica set.

integer (int32)

replicas
optional

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

integer (int32)

v1.VirtualMachineInstanceSpec

VirtualMachineInstanceSpec is a description of a VirtualMachineInstance.

Name Description Schema

accessCredentials
optional

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

affinity
optional

If affinity is specifies, obey all the affinity rules

architecture
optional

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

string

dnsConfig
optional

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

dnsPolicy
optional

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'.

Possible enum values: - "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings. - "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings. - "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings. - "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.

enum (ClusterFirst, ClusterFirstWithHostNet, Default, None)

domain
required

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

evictionStrategy
optional

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 by a PDB 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.

string

hostname
optional

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.

string

livenessProbe
optional

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

networks
optional

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

< v1.Network > array

nodeSelector
optional

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/

< string, string > map

priorityClassName
optional

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

string

readinessProbe
optional

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

schedulerName
optional

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

string

startStrategy
optional

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

string

subdomain
optional

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.

string

terminationGracePeriodSeconds
optional

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

integer (int64)

tolerations
optional

If toleration is specified, obey all the toleration rules.

topologySpreadConstraints
optional

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.

volumes
optional

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

< v1.Volume > array

v1.VirtualMachineInstanceStatus

VirtualMachineInstanceStatus represents information about the status of a VirtualMachineInstance. Status may trail the actual state of a system.

Name Description Schema

VSOCKCID
optional

VSOCKCID is used to track the allocated VSOCK CID in the VM.

integer (int64)

activePods
optional

ActivePods is a mapping of pod UID to node name. It is possible for multiple pods to be running for a single VMI during migration.

< string, string > map

conditions
optional

Conditions are specific points in VirtualMachineInstance’s pod runtime.

currentCPUTopology
optional

CurrentCPUTopology specifies the current CPU topology used by the VM workload. Current topology may differ from the desired topology in the spec while CPU hotplug takes place.

evacuationNodeName
optional

EvacuationNodeName is used to track the eviction process of a VMI. It stores the name of the node that we want to evacuate. It is meant to be used by KubeVirt core components only and can’t be set or modified by users.

string

fsFreezeStatus
optional

FSFreezeStatus is the state of the fs of the guest it can be either frozen or thawed

string

guestOSInfo
optional

Guest OS Information

interfaces
optional

Interfaces represent the details of available network interfaces.

kernelBootStatus
optional

KernelBootStatus contains info about the kernelBootContainer

launcherContainerImageVersion
optional

LauncherContainerImageVersion indicates what container image is currently active for the vmi.

string

machine
optional

Machine shows the final resulting qemu machine type. This can be different than the machine type selected in the spec, due to qemus machine type alias mechanism.

memory
optional

Memory shows various informations about the VirtualMachine memory.

migrationMethod
optional

Represents the method using which the vmi can be migrated: live migration or block migration

string

migrationState
optional

Represents the status of a live migration

migrationTransport
optional

This represents the migration transport

string

nodeName
optional

NodeName is the name where the VirtualMachineInstance is currently running.

string

phase
optional

Phase is the status of the VirtualMachineInstance in kubernetes world. It is not the VirtualMachineInstance status, but partially correlates to it.

string

phaseTransitionTimestamps
optional

PhaseTransitionTimestamp is the timestamp of when the last phase change occurred

qosClass
optional

The Quality of Service (QOS) classification assigned to the virtual machine instance based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

Possible enum values: - "BestEffort" is the BestEffort qos class. - "Burstable" is the Burstable qos class. - "Guaranteed" is the Guaranteed qos class.

enum (BestEffort, Burstable, Guaranteed)

reason
optional

A brief CamelCase message indicating details about why the VMI is in this state. e.g. 'NodeUnresponsive'

string

runtimeUser
optional

RuntimeUser is used to determine what user will be used in launcher
Default : 0

integer (int64)

selinuxContext
optional

SELinuxContext is the actual SELinux context of the virt-launcher pod

string

topologyHints
optional

virtualMachineRevisionName
optional

VirtualMachineRevisionName is used to get the vm revision of the vmi when doing an online vm snapshot

string

volumeStatus
optional

VolumeStatus contains the statuses of all the volumes

< v1.VolumeStatus > array

v1.VirtualMachineInstanceTemplateSpec

Name Description Schema

metadata
optional

spec
optional

VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

v1.VirtualMachineList

VirtualMachineList is a list of virtualmachines

Name Description Schema

apiVersion
optional

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

string

items
required

< v1.VirtualMachine > array

kind
optional

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

string

metadata
optional

v1.VirtualMachineMemoryDumpRequest

VirtualMachineMemoryDumpRequest represent the memory dump request phase and info

Name Description Schema

claimName
required

ClaimName is the name of the pvc that will contain the memory dump
Default : ""

string

endTimestamp
optional

EndTimestamp represents the time the memory dump was completed

fileName
optional

FileName represents the name of the output file

string

message
optional

Message is a detailed message about failure of the memory dump

string

phase
required

Phase represents the memory dump phase
Default : ""

string

remove
optional

Remove represents request of dissociating the memory dump pvc

boolean

startTimestamp
optional

StartTimestamp represents the time the memory dump started

v1.VirtualMachineOptions

VirtualMachineOptions holds the cluster level information regarding the virtual machine.

Name Description Schema

disableFreePageReporting
optional

DisableFreePageReporting disable the free page reporting of memory balloon device https://libvirt.org/formatdomain.html#memory-balloon-device. This will have effect only if AutoattachMemBalloon is not false and the vmi is not requesting any high performance feature (dedicatedCPU/realtime/hugePages), in which free page reporting is always disabled.

disableSerialConsoleLog
optional

DisableSerialConsoleLog disables logging the auto-attached default serial console. If not set, serial console logs will be written to a file and then streamed from a container named guest-console-log. The value can be individually overridden for each VM, not relevant if AutoattachSerialConsole is disabled.

v1.VirtualMachineSpec

VirtualMachineSpec describes how the proper VirtualMachine should look like

Name Description Schema

dataVolumeTemplates
optional

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.

instancetype
optional

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

preference
optional

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

runStrategy
optional

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

string

running
optional

Running controls whether the associatied VirtualMachineInstance is created or not Mutually exclusive with RunStrategy

boolean

template
required

Template is the direct specification of VirtualMachineInstance

updateVolumesStrategy
optional

UpdateVolumesStrategy is the strategy to apply on volumes updates

string

v1.VirtualMachineStartFailure

VirtualMachineStartFailure tracks VMIs which failed to transition successfully to running using the VM status

Name Schema

consecutiveFailCount
optional

integer (int32)

lastFailedVMIUID
optional

string

retryAfterTimestamp
optional

v1.VirtualMachineStateChangeRequest

Name Description Schema

action
required

Indicates the type of action that is requested. e.g. Start or Stop
Default : ""

string

data
optional

Provides additional data in order to perform the Action

< string, string > map

uid
optional

Indicates the UUID of an existing Virtual Machine Instance that this change request applies to – if applicable

string

v1.VirtualMachineStatus

VirtualMachineStatus represents the status returned by the controller to describe how the VirtualMachine is doing

Name Description Schema

conditions
optional

Hold the state information of the VirtualMachine and its VirtualMachineInstance

created
optional

Created indicates if the virtual machine is created in the cluster

boolean

desiredGeneration
optional

DesiredGeneration is the generation which is desired for the VMI. This will be used in comparisons with ObservedGeneration to understand when the VMI is out of sync. This will be changed at the same time as ObservedGeneration to remove errors which could occur if Generation is updated through an Update() before ObservedGeneration in Status.

integer (int64)

memoryDumpRequest
optional

MemoryDumpRequest tracks memory dump request phase and info of getting a memory dump to the given pvc

observedGeneration
optional

ObservedGeneration is the generation observed by the vmi when started.

integer (int64)

printableStatus
optional

PrintableStatus is a human readable, high-level representation of the status of the virtual machine

string

ready
optional

Ready indicates if the virtual machine is running and ready

boolean

restoreInProgress
optional

RestoreInProgress is the name of the VirtualMachineRestore currently executing

string

runStrategy
optional

RunStrategy tracks the last recorded RunStrategy used by the VM. This is needed to correctly process the next strategy (for now only the RerunOnFailure)

string

snapshotInProgress
optional

SnapshotInProgress is the name of the VirtualMachineSnapshot currently executing

string

startFailure
optional

StartFailure tracks consecutive VMI startup failures for the purposes of crash loop backoffs

stateChangeRequests
optional

StateChangeRequests indicates a list of actions that should be taken on a VMI e.g. stop a specific VMI then start a new one.

volumeRequests
optional

VolumeRequests indicates a list of volumes add or remove from the VMI template and hotplug on an active running VMI.

volumeSnapshotStatuses
optional

VolumeSnapshotStatuses indicates a list of statuses whether snapshotting is supported by each volume.

v1.VirtualMachineVolumeRequest

Name Description Schema

addVolumeOptions
optional

AddVolumeOptions when set indicates a volume should be added. The details within this field specify how to add the volume

removeVolumeOptions
optional

RemoveVolumeOptions when set indicates a volume should be removed. The details within this field specify how to add the volume

v1.Volume

Volume represents a named volume in a vmi.

Name Description Schema

cloudInitConfigDrive
optional

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

cloudInitNoCloud
optional

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

configMap
optional

ConfigMapSource represents a reference to a ConfigMap in the same namespace. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/

containerDisk
optional

ContainerDisk references a docker image, embedding a qcow or raw disk. More info: https://kubevirt.gitbooks.io/user-guide/registry-disk.html

dataVolume
optional

DataVolume represents the dynamic creation a PVC for this volume as well as the process of populating that PVC with a disk image.

downwardAPI
optional

DownwardAPI represents downward API about the pod that should populate this volume

downwardMetrics
optional

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
optional

EmptyDisk represents a temporary disk which shares the vmis lifecycle. More info: https://kubevirt.gitbooks.io/user-guide/disks-and-volumes.html

ephemeral
optional

Ephemeral is a special volume source that "wraps" specified source and provides copy-on-write image on top of it.

hostDisk
optional

HostDisk represents a disk created on the cluster level

memoryDump
optional

MemoryDump is attached to the virt launcher and is populated with a memory dump of the vmi

name
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
Default : ""

string

persistentVolumeClaim
optional

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

secret
optional

SecretVolumeSource represents a reference to a secret data in the same namespace. More info: https://kubernetes.io/docs/concepts/configuration/secret/

serviceAccount
optional

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/

sysprep
optional

Represents a Sysprep volume source.

v1.VolumeSnapshotStatus

Name Description Schema

enabled
required

True if the volume supports snapshotting
Default : false

boolean

name
required

Volume name
Default : ""

string

reason
optional

Empty if snapshotting is enabled, contains reason otherwise

string

v1.VolumeStatus

VolumeStatus represents information about the status of volumes attached to the VirtualMachineInstance.

Name Description Schema

containerDiskVolume
optional

ContainerDiskVolume shows info about the containerdisk, if the volume is a containerdisk

hotplugVolume
optional

If the volume is hotplug, this will contain the hotplug status.

memoryDumpVolume
optional

If the volume is memorydump volume, this will contain the memorydump info.

message
optional

Message is a detailed message about the current hotplug volume phase

string

name
required

Name is the name of the volume
Default : ""

string

persistentVolumeClaimInfo
optional

PersistentVolumeClaimInfo is information about the PVC that handler requires during start flow

phase
optional

Phase is the phase

string

reason
optional

Reason is a brief description of why we are in the current hotplug volume phase

string

size
optional

Represents the size of the volume

integer (int64)

target
required

Target is the target name used when adding the volume to the VM, eg: vda
Default : ""

string

v1.Watchdog

Named watchdog device.

Name Description Schema

i6300esb
optional

i6300esb watchdog device.

name
required

Name of the watchdog.
Default : ""

string

v1alpha1.Condition

Condition defines conditions

Name Description Schema

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

Default : ""

string

v1alpha1.MigrationPolicy

MigrationPolicy holds migration policy (i.e. configurations) to apply to a VM or group of VMs

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

status
optional

v1alpha1.MigrationPolicyList

MigrationPolicyList is a list of MigrationPolicy

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1alpha1.MigrationPolicySpec

Name Schema

allowAutoConverge
optional

boolean

allowPostCopy
optional

boolean

bandwidthPerMigration
optional

completionTimeoutPerGiB
optional

integer (int64)

selectors
required

v1alpha1.MigrationPolicyStatus

Type : object

v1alpha1.Selectors

Name Schema

namespaceSelector
optional

< string, string > map

virtualMachineInstanceSelector
optional

< string, string > map

v1alpha1.VirtualMachineClone

VirtualMachineClone is a CRD that clones one VM into another.

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

status
optional

v1alpha1.VirtualMachineCloneList

VirtualMachineCloneList is a list of MigrationPolicy

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1alpha1.VirtualMachineCloneSpec

Name Description Schema

annotationFilters
optional

Example use: "!some/key*". For a detailed description, please refer to https://kubevirt.io/user-guide/operations/clone_api/#label-annotation-filters.

< string > array

labelFilters
optional

Example use: "!some/key*". For a detailed description, please refer to https://kubevirt.io/user-guide/operations/clone_api/#label-annotation-filters.

< string > array

newMacAddresses
optional

NewMacAddresses manually sets that target interfaces' mac addresses. The key is the interface name and the value is the new mac address. If this field is not specified, a new MAC address will be generated automatically, as for any interface that is not included in this map.

< string, string > map

newSMBiosSerial
optional

NewSMBiosSerial manually sets that target’s SMbios serial. If this field is not specified, a new serial will be generated automatically.

string

source
required

Source is the object that would be cloned. Currently supported source types are: VirtualMachine of kubevirt.io API group, VirtualMachineSnapshot of snapshot.kubevirt.io API group

target
optional

Target is the outcome of the cloning process. Currently supported source types are: - VirtualMachine of kubevirt.io API group - Empty (nil). If the target is not provided, the target type would default to VirtualMachine and a random name would be generated for the target. The target’s name can be viewed by inspecting status "TargetName" field below.

template
optional

v1alpha1.VirtualMachineCloneStatus

Name Schema

conditions
optional

< v1alpha1.Condition > array

creationTime
optional

phase
optional

string

restoreName
optional

string

snapshotName
optional

string

targetName
optional

string

v1alpha1.VirtualMachineCloneTemplateFilters

Name Description Schema

annotationFilters
optional

Example use: "!some/key*". For a detailed description, please refer to https://kubevirt.io/user-guide/operations/clone_api/#label-annotation-filters.

< string > array

labelFilters
optional

Example use: "!some/key*". For a detailed description, please refer to https://kubevirt.io/user-guide/operations/clone_api/#label-annotation-filters.

< string > array

v1alpha1.VirtualMachineExport

VirtualMachineExport defines the operation of exporting a VM source

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

status
optional

VirtualMachineExportLink contains a list of volumes available for export, as well as the URLs to obtain these volumes

Name Description Schema

cert
required

Cert is the public CA certificate base64 encoded
Default : ""

string

manifests
optional

Manifests is a list of available manifests for the export

volumes
optional

Volumes is a list of available volumes to export

VirtualMachineExportLinks contains the links that point the exported VM resources

Name Schema

external
optional

internal
optional

v1alpha1.VirtualMachineExportList

VirtualMachineExportList is a list of VirtualMachineExport resources

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
required

v1alpha1.VirtualMachineExportManifest

VirtualMachineExportManifest contains the type and URL of the exported manifest

Name Description Schema

type
required

Type is the type of manifest returned
Default : ""

string

url
required

Url is the url of the endpoint that returns the manifest
Default : ""

string

v1alpha1.VirtualMachineExportSpec

VirtualMachineExportSpec is the spec for a VirtualMachineExport resource

Name Description Schema

source
required

tokenSecretRef
optional

TokenSecretRef is the name of the custom-defined secret that contains the token used by the export server pod

string

ttlDuration
optional

ttlDuration limits the lifetime of an export If this field is set, after this duration has passed from counting from CreationTimestamp, the export is eligible to be automatically deleted. If this field is omitted, a reasonable default is applied.

v1alpha1.VirtualMachineExportStatus

VirtualMachineExportStatus is the status for a VirtualMachineExport resource

Name Description Schema

conditions
optional

< v1alpha1.Condition > array

links
optional

phase
optional

string

serviceName
optional

ServiceName is the name of the service created associated with the Virtual Machine export. It will be used to create the internal URLs for downloading the images

string

tokenSecretRef
optional

TokenSecretRef is the name of the secret that contains the token used by the export server pod

string

ttlExpirationTime
optional

The time at which the VM Export will be completely removed according to specified TTL Formula is CreationTimestamp + TTL

virtualMachineName
optional

VirtualMachineName shows the name of the source virtual machine if the source is either a VirtualMachine or a VirtualMachineSnapshot. This is mainly to easily identify the source VirtualMachine in case of a VirtualMachineSnapshot

string

v1alpha1.VirtualMachineExportVolume

VirtualMachineExportVolume contains the name and available formats for the exported volume

Name Description Schema

formats
optional

name
required

Name is the name of the exported volume
Default : ""

string

v1alpha1.VirtualMachineExportVolumeFormat

VirtualMachineExportVolumeFormat contains the format type and URL to get the volume in that format

Name Description Schema

format
required

Format is the format of the image at the specified URL
Default : ""

string

url
required

Url is the url that contains the volume in the format specified
Default : ""

string

v1alpha1.VirtualMachinePool

VirtualMachinePool resource contains a VirtualMachine configuration that can be used to replicate multiple VirtualMachine resources.

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

status
optional

v1alpha1.VirtualMachinePoolCondition

Name Description Schema

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

Default : ""

string

v1alpha1.VirtualMachinePoolList

VirtualMachinePoolList is a list of VirtualMachinePool resources.

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1alpha1.VirtualMachinePoolSpec

Name Description Schema

paused
optional

Indicates that the pool is paused.

boolean

replicas
optional

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

integer (int32)

selector
required

Label selector for pods. Existing Poolss whose pods are selected by this will be the ones affected by this deployment.

virtualMachineTemplate
required

Template describes the VM that will be created.

v1alpha1.VirtualMachinePoolStatus

Name Description Schema

conditions
optional

labelSelector
optional

Canonical form of the label selector for HPA which consumes it through the scale subresource.

string

readyReplicas
optional

integer (int32)

replicas
optional

integer (int32)

v1alpha1.VirtualMachineTemplateSpec

Name Description Schema

metadata
optional

spec
optional

VirtualMachineSpec contains the VirtualMachine specification.

v1beta1.CPUInstancetype

CPUInstancetype contains the CPU related configuration of a given VirtualMachineInstancetypeSpec.

Guest is a required attribute and defines the number of vCPUs to be exposed to the guest by the instancetype.

Name Description Schema

dedicatedCPUPlacement
optional

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

boolean

guest
required

Required number of vCPUs to expose to the guest.

The resulting CPU topology being derived from the optional PreferredCPUTopology attribute of CPUPreferences that itself defaults to PreferSockets.
Default : 0

integer (int64)

isolateEmulatorThread
optional

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

boolean

model
optional

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.

string

numa
optional

NUMA allows specifying settings for the guest NUMA topology

realtime
optional

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

v1beta1.CPUPreferenceRequirement

Name Description Schema

guest
required

Minimal number of vCPUs required by the preference.
Default : 0

integer (int64)

v1beta1.CPUPreferences

CPUPreferences contains various optional CPU preferences.

Name Description Schema

preferredCPUFeatures
optional

PreferredCPUFeatures optionally defines a slice of preferred CPU features.

< v1.CPUFeature > array

preferredCPUTopology
optional

PreferredCPUTopology optionally defines the preferred guest visible CPU topology, defaults to PreferSockets.

string

spreadOptions
optional

v1beta1.ClockPreferences

ClockPreferences contains various optional defaults for Clock.

Name Description Schema

preferredClockOffset
optional

ClockOffset allows specifying the UTC offset or the timezone of the guest clock.

preferredTimer
optional

Timer specifies whih timers are attached to the vmi.

v1beta1.Condition

Condition defines conditions

Name Description Schema

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

Default : ""

string

v1beta1.DataVolumeBlankImage

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

Type : object

v1beta1.DataVolumeCheckpoint

DataVolumeCheckpoint defines a stage in a warm migration.

Name Description Schema

current
required

Current is the identifier of the snapshot created for this checkpoint.
Default : ""

string

previous
required

Previous is the identifier of the snapshot from the previous checkpoint.
Default : ""

string

v1beta1.DataVolumeSource

DataVolumeSource represents the source for our Data Volume, this can be HTTP, Imageio, S3, GCS, Registry or an existing PVC

Name Schema

blank
optional

gcs
optional

http
optional

imageio
optional

pvc
optional

registry
optional

s3
optional

snapshot
optional

upload
optional

vddk
optional

v1beta1.DataVolumeSourceGCS

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

Name Description Schema

secretRef
optional

SecretRef provides the secret reference needed to access the GCS source

string

url
required

URL is the url of the GCS source
Default : ""

string

v1beta1.DataVolumeSourceHTTP

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

Name Description Schema

certConfigMap
optional

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

string

extraHeaders
optional

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

< string > array

secretExtraHeaders
optional

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

< string > array

secretRef
optional

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

string

url
required

URL is the URL of the http(s) endpoint
Default : ""

string

v1beta1.DataVolumeSourceImageIO

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

Name Description Schema

certConfigMap
optional

CertConfigMap provides a reference to the CA cert

string

diskId
required

DiskID provides id of a disk to be imported
Default : ""

string

secretRef
optional

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

string

url
required

URL is the URL of the ovirt-engine
Default : ""

string

v1beta1.DataVolumeSourcePVC

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

Name Description Schema

name
required

The name of the source PVC
Default : ""

string

namespace
required

The namespace of the source PVC
Default : ""

string

v1beta1.DataVolumeSourceRef

DataVolumeSourceRef defines an indirect reference to the source of data for the DataVolume

Name Description Schema

kind
required

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

string

name
required

The name of the source reference
Default : ""

string

namespace
optional

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

string

v1beta1.DataVolumeSourceRegistry

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

Name Description Schema

certConfigMap
optional

CertConfigMap provides a reference to the Registry certs

string

imageStream
optional

ImageStream is the name of image stream for import

string

pullMethod
optional

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

string

secretRef
optional

SecretRef provides the secret reference needed to access the Registry source

string

url
optional

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

string

v1beta1.DataVolumeSourceS3

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

Name Description Schema

certConfigMap
optional

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

string

secretRef
optional

SecretRef provides the secret reference needed to access the S3 source

string

url
required

URL is the url of the S3 source
Default : ""

string

v1beta1.DataVolumeSourceSnapshot

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

Name Description Schema

name
required

The name of the source VolumeSnapshot
Default : ""

string

namespace
required

The namespace of the source VolumeSnapshot
Default : ""

string

v1beta1.DataVolumeSourceUpload

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

Type : object

v1beta1.DataVolumeSourceVDDK

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

Name Description Schema

backingFile
optional

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

string

initImageURL
optional

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

string

secretRef
optional

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

string

thumbprint
optional

Thumbprint is the certificate thumbprint of the vCenter or ESXi host

string

url
optional

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

string

uuid
optional

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

string

v1beta1.DataVolumeSpec

DataVolumeSpec defines the DataVolume type specification

Name Description Schema

checkpoints
optional

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

contentType
optional

DataVolumeContentType options: "kubevirt", "archive"

string

finalCheckpoint
optional

FinalCheckpoint indicates whether the current DataVolumeCheckpoint is the final checkpoint.

boolean

preallocation
optional

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

boolean

priorityClassName
optional

PriorityClassName for Importer, Cloner and Uploader pod

string

pvc
optional

PVC is the PVC specification

source
optional

Source is the src of the data for the requested DataVolume

sourceRef
optional

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

storage
optional

Storage is the requested storage specification

v1beta1.DevicePreferences

DevicePreferences contains various optional Device preferences.

Name Description Schema

preferredAutoattachGraphicsDevice
optional

PreferredAutoattachGraphicsDevice optionally defines the preferred value of AutoattachGraphicsDevice

boolean

preferredAutoattachInputDevice
optional

PreferredAutoattachInputDevice optionally defines the preferred value of AutoattachInputDevice

boolean

preferredAutoattachMemBalloon
optional

PreferredAutoattachMemBalloon optionally defines the preferred value of AutoattachMemBalloon

boolean

preferredAutoattachPodInterface
optional

PreferredAutoattachPodInterface optionally defines the preferred value of AutoattachPodInterface

boolean

preferredAutoattachSerialConsole
optional

PreferredAutoattachSerialConsole optionally defines the preferred value of AutoattachSerialConsole

boolean

preferredBlockMultiQueue
optional

PreferredBlockMultiQueue optionally enables the vhost multiqueue feature for virtio disks.

boolean

preferredCdromBus
optional

PreferredCdromBus optionally defines the preferred bus for Cdrom Disk devices.

string

preferredDisableHotplug
optional

PreferredDisableHotplug optionally defines the preferred value of DisableHotplug

boolean

preferredDiskBlockSize
optional

PreferredBlockSize optionally defines the block size of Disk devices.

preferredDiskBus
optional

PreferredDiskBus optionally defines the preferred bus for Disk Disk devices.

string

preferredDiskCache
optional

PreferredCache optionally defines the DriverCache to be used by Disk devices.

string

preferredDiskDedicatedIoThread
optional

PreferredDedicatedIoThread optionally enables dedicated IO threads for Disk devices.

boolean

preferredDiskIO
optional

PreferredIo optionally defines the QEMU disk IO mode to be used by Disk devices.

string

preferredInputBus
optional

PreferredInputBus optionally defines the preferred bus for Input devices.

string

preferredInputType
optional

PreferredInputType optionally defines the preferred type for Input devices.

string

preferredInterfaceMasquerade
optional

PreferredInterfaceMasquerade optionally defines the preferred masquerade configuration to use with each network interface.

preferredInterfaceModel
optional

PreferredInterfaceModel optionally defines the preferred model to be used by Interface devices.

string

preferredLunBus
optional

PreferredLunBus optionally defines the preferred bus for Lun Disk devices.

string

preferredNetworkInterfaceMultiQueue
optional

PreferredNetworkInterfaceMultiQueue optionally enables the vhost multiqueue feature for virtio interfaces.

boolean

preferredRng
optional

PreferredRng optionally defines the preferred rng device to be used.

preferredSoundModel
optional

PreferredSoundModel optionally defines the preferred model for Sound devices.

string

preferredTPM
optional

PreferredTPM optionally defines the preferred TPM device to be used.

preferredUseVirtioTransitional
optional

PreferredUseVirtioTransitional optionally defines the preferred value of UseVirtioTransitional

boolean

preferredVirtualGPUOptions
optional

PreferredVirtualGPUOptions optionally defines the preferred value of VirtualGPUOptions

v1beta1.Error

Error is the last error encountered during the snapshot/restore

Name Schema

message
optional

string

time
optional

v1beta1.FeaturePreferences

FeaturePreferences contains various optional defaults for Features.

Name Description Schema

preferredAcpi
optional

PreferredAcpi optionally enables the ACPI feature

preferredApic
optional

PreferredApic optionally enables and configures the APIC feature

preferredHyperv
optional

PreferredHyperv optionally enables and configures HyperV features

preferredKvm
optional

PreferredKvm optionally enables and configures KVM features

preferredPvspinlock
optional

PreferredPvspinlock optionally enables the Pvspinlock feature

preferredSmm
optional

PreferredSmm optionally enables the SMM feature

v1beta1.FirmwarePreferences

FirmwarePreferences contains various optional defaults for Firmware.

Name Description Schema

preferredUseBios
optional

PreferredUseBios optionally enables BIOS

boolean

preferredUseBiosSerial
optional

PreferredUseBiosSerial optionally transmitts BIOS output over the serial.

Requires PreferredUseBios to be enabled.

boolean

preferredUseEfi
optional

PreferredUseEfi optionally enables EFI

boolean

preferredUseSecureBoot
optional

PreferredUseSecureBoot optionally enables SecureBoot and the OVMF roms will be swapped for SecureBoot-enabled ones.

Requires PreferredUseEfi and PreferredSmm to be enabled.

boolean

v1beta1.MachinePreferences

MachinePreferences contains various optional defaults for Machine.

Name Description Schema

preferredMachineType
optional

PreferredMachineType optionally defines the preferred machine type to use.

string

v1beta1.MemoryInstancetype

MemoryInstancetype contains the Memory related configuration of a given VirtualMachineInstancetypeSpec.

Guest is a required attribute and defines the amount of RAM to be exposed to the guest by the instancetype.

Name Description Schema

guest
required

Required amount of memory which is visible inside the guest OS.

hugepages
optional

Optionally enables the use of hugepages for the VirtualMachineInstance instead of regular memory.

overcommitPercent
optional

OvercommitPercent is the percentage of the guest memory which will be overcommitted. This means that the VMIs parent pod (virt-launcher) will request less physical memory by a factor specified by the OvercommitPercent. Overcommits can lead to memory exhaustion, which in turn can lead to crashes. Use carefully. Defaults to 0

integer (int32)

v1beta1.MemoryPreferenceRequirement

Name Description Schema

guest
required

Minimal amount of memory required by the preference.

v1beta1.PersistentVolumeClaim

Name Description Schema

metadata
optional

spec
optional

Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

v1beta1.PreferenceRequirements

Name Description Schema

cpu
optional

Required CPU related attributes of the instancetype.

memory
optional

Required Memory related attributes of the instancetype.

v1beta1.SnapshotVolumesLists

SnapshotVolumesLists includes the list of volumes which were included in the snapshot and volumes which were excluded from the snapshot

Name Schema

excludedVolumes
optional

< string > array

includedVolumes
optional

< string > array

v1beta1.SourceSpec

SourceSpec contains the appropriate spec for the resource being snapshotted

Name Schema

virtualMachine
optional

v1beta1.SpreadOptions

Name Description Schema

across
optional

Across optionally defines how to spread vCPUs across the guest visible topology. Default: SocketsCores

string

ratio
optional

Ratio optionally defines the ratio to spread vCPUs across the guest visible topology:

CoresThreads - 1:2 - Controls the ratio of cores to threads. Only a ratio of 2 is currently accepted. SocketsCores - 1:N - Controls the ratio of socket to cores. SocketsCoresThreads - 1:N:2 - Controls the ratio of socket to cores. Each core providing 2 threads.

Default: 2

integer (int64)

v1beta1.StorageSpec

StorageSpec defines the Storage type specification

Name Description Schema

accessModes
optional

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

< string > array

dataSource
optional

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.

dataSourceRef
optional

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
optional

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

selector
optional

A label query over volumes to consider for binding.

storageClassName
optional

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

string

volumeMode
optional

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

Possible enum values: - "Block" means the volume will not be formatted with a filesystem and will remain a raw block device. - "Filesystem" means the volume will be or is formatted with a filesystem.

enum (Block, Filesystem)

volumeName
optional

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

string

v1beta1.VirtualMachine

Name Description Schema

metadata
optional

spec
optional

VirtualMachineSpec contains the VirtualMachine specification.

status
optional

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

v1beta1.VirtualMachineClusterInstancetype

VirtualMachineClusterInstancetype is a cluster scoped version of VirtualMachineInstancetype resource.

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

Required spec describing the instancetype

v1beta1.VirtualMachineClusterInstancetypeList

VirtualMachineClusterInstancetypeList is a list of VirtualMachineClusterInstancetype resources.

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1beta1.VirtualMachineClusterPreference

VirtualMachineClusterPreference is a cluster scoped version of the VirtualMachinePreference resource.

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

Required spec describing the preferences

v1beta1.VirtualMachineClusterPreferenceList

VirtualMachineClusterPreferenceList is a list of VirtualMachineClusterPreference resources.

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1beta1.VirtualMachineInstancetype

VirtualMachineInstancetype resource contains quantitative and resource related VirtualMachine configuration that can be used by multiple VirtualMachine resources.

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

Required spec describing the instancetype

v1beta1.VirtualMachineInstancetypeList

VirtualMachineInstancetypeList is a list of VirtualMachineInstancetype resources.

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1beta1.VirtualMachineInstancetypeSpec

VirtualMachineInstancetypeSpec is a description of the VirtualMachineInstancetype or VirtualMachineClusterInstancetype.

CPU and Memory are required attributes with both requiring that their Guest attribute is defined, ensuring a number of vCPUs and amount of RAM is always provided by each instancetype.

Name Description Schema

annotations
optional

Optionally defines the required Annotations to be used by the instance type and applied to the VirtualMachineInstance

< string, string > map

cpu
required

Required CPU related attributes of the instancetype.

gpus
optional

Optionally defines any GPU devices associated with the instancetype.

< v1.GPU > array

hostDevices
optional

Optionally defines any HostDevices associated with the instancetype.

< v1.HostDevice > array

ioThreadsPolicy
optional

Optionally defines the IOThreadsPolicy to be used by the instancetype.

string

launchSecurity
optional

Optionally defines the LaunchSecurity to be used by the instancetype.

memory
required

Required Memory related attributes of the instancetype.

nodeSelector
optional

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/

NodeSelector is the name of the custom node selector for the instancetype.

< string, string > map

schedulerName
optional

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

SchedulerName is the name of the custom K8s scheduler for the instancetype.

string

v1beta1.VirtualMachinePreference

VirtualMachinePreference resource contains optional preferences related to the VirtualMachine.

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

Required spec describing the preferences

v1beta1.VirtualMachinePreferenceList

VirtualMachinePreferenceList is a list of VirtualMachinePreference resources.

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
optional

v1beta1.VirtualMachinePreferenceSpec

VirtualMachinePreferenceSpec is a description of the VirtualMachinePreference or VirtualMachineClusterPreference.

Name Description Schema

annotations
optional

Optionally defines preferred Annotations to be applied to the VirtualMachineInstance

< string, string > map

clock
optional

Clock optionally defines preferences associated with the Clock attribute of a VirtualMachineInstance DomainSpec

cpu
optional

CPU optionally defines preferences associated with the CPU attribute of a VirtualMachineInstance DomainSpec

devices
optional

Devices optionally defines preferences associated with the Devices attribute of a VirtualMachineInstance DomainSpec

features
optional

Features optionally defines preferences associated with the Features attribute of a VirtualMachineInstance DomainSpec

firmware
optional

Firmware optionally defines preferences associated with the Firmware attribute of a VirtualMachineInstance DomainSpec

machine
optional

Machine optionally defines preferences associated with the Machine attribute of a VirtualMachineInstance DomainSpec

preferSpreadSocketToCoreRatio
optional

PreferSpreadSocketToCoreRatio defines the ratio to spread vCPUs between cores and sockets, it defaults to 2.

integer (int64)

preferredSubdomain
optional

Subdomain of the VirtualMachineInstance

string

preferredTerminationGracePeriodSeconds
optional

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

integer (int64)

requirements
optional

Requirements defines the minium amount of instance type defined resources required by a set of preferences

volumes
optional

Volumes optionally defines preferences associated with the Volumes attribute of a VirtualMachineInstace DomainSpec

v1beta1.VirtualMachineRestore

VirtualMachineRestore defines the operation of restoring a VM

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

status
optional

v1beta1.VirtualMachineRestoreList

VirtualMachineRestoreList is a list of VirtualMachineRestore resources

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
required

v1beta1.VirtualMachineRestoreSpec

VirtualMachineRestoreSpec is the spec for a VirtualMachineRestoreresource

Name Description Schema

patches
optional

If the target for the restore does not exist, it will be created. Patches holds JSON patches that would be applied to the target manifest before it’s created. Patches should fit the target’s Kind.

Example for a patch: {"op": "replace", "path": "/metadata/name", "value": "new-vm-name"}

< string > array

target
required

initially only VirtualMachine type supported

virtualMachineSnapshotName
required

Default : ""

string

v1beta1.VirtualMachineRestoreStatus

VirtualMachineRestoreStatus is the spec for a VirtualMachineRestoreresource

Name Schema

complete
optional

boolean

conditions
optional

< v1beta1.Condition > array

deletedDataVolumes
optional

< string > array

restoreTime
optional

restores
optional

v1beta1.VirtualMachineSnapshot

VirtualMachineSnapshot defines the operation of snapshotting a VM

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

status
optional

v1beta1.VirtualMachineSnapshotContent

VirtualMachineSnapshotContent contains the snapshot data

Name Description Schema

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

spec
required

status
optional

v1beta1.VirtualMachineSnapshotContentList

VirtualMachineSnapshotContentList is a list of VirtualMachineSnapshot resources

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
required

v1beta1.VirtualMachineSnapshotContentSpec

VirtualMachineSnapshotContentSpec is the spec for a VirtualMachineSnapshotContent resource

Name Schema

source
required

virtualMachineSnapshotName
optional

string

volumeBackups
optional

v1beta1.VirtualMachineSnapshotContentStatus

VirtualMachineSnapshotContentStatus is the status for a VirtualMachineSnapshotStatus resource

Name Schema

creationTime
optional

error
optional

readyToUse
optional

boolean

volumeSnapshotStatus
optional

v1beta1.VirtualMachineSnapshotList

VirtualMachineSnapshotList is a list of VirtualMachineSnapshot resources

Name Description Schema

apiVersion
optional

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

string

items
required

kind
optional

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

string

metadata
required

v1beta1.VirtualMachineSnapshotSpec

VirtualMachineSnapshotSpec is the spec for a VirtualMachineSnapshot resource

Name Description Schema

deletionPolicy
optional

string

failureDeadline
optional

This time represents the number of seconds we permit the vm snapshot to take. In case we pass this deadline we mark this snapshot as failed. Defaults to DefaultFailureDeadline - 5min

source
required

v1beta1.VirtualMachineSnapshotStatus

VirtualMachineSnapshotStatus is the status for a VirtualMachineSnapshot resource

Name Schema

conditions
optional

< v1beta1.Condition > array

creationTime
optional

error
optional

indications
optional

< string > array

phase
optional

string

readyToUse
optional

boolean

snapshotVolumes
optional

sourceUID
optional

string

virtualMachineSnapshotContentName
optional

string

v1beta1.VolumeBackup

VolumeBackup contains the data neeed to restore a PVC

Name Description Schema

persistentVolumeClaim
required

volumeName
required

Default : ""

string

volumeSnapshotName
optional

string

v1beta1.VolumePreferences

Name Description Schema

preferredStorageClassName
optional

PreffereedStorageClassName optionally defines the preferred storageClass

string

v1beta1.VolumeRestore

VolumeRestore contains the data neeed to restore a PVC

Name Description Schema

dataVolumeName
optional

string

persistentVolumeClaim
required

Default : ""

string

volumeName
required

Default : ""

string

volumeSnapshotName
required

Default : ""

string

v1beta1.VolumeSnapshotStatus

VolumeSnapshotStatus is the status of a VolumeSnapshot