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 to use on this file, must be a value between 0 and 0777. 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 '..'

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

string

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

string

value
required

The header field value

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.

string

operator
required

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

string

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.

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

This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.

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. This is a beta feature.

string

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

string

readOnly
optional

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.

namespaces
optional

namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list 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.

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.

integer (int32)

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

string

k8s.io.api.core.v1.ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Name Description Schema

limits
optional

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

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-compute-resources-container/

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.

string

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.

string

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

string

name
required

Name is the name of resource being referenced

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.

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: a. No precision is lost b. No fractional digits will be emitted c. 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.

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

string

name
required

name is the plural name of the resource.

string

namespaced
required

namespaced indicates if a resource is namespaced or not.

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.

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.

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"

string

version
required

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

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.

string

operator
required

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

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

selfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

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

time
optional

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

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

clusterName
optional

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

string

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.

< 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 NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

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

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

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.

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

string

uid
required

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.

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.

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

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.

 runtime.TypeMeta `json:&quot;,inline&quot;`
 MyPlugin runtime.Object `json:&quot;myPlugin&quot;`
} type PluginA struct {
 AOption string `json:&quot;aOption&quot;`
}
 runtime.TypeMeta `json:&quot;,inline&quot;`
 MyPlugin runtime.RawExtension `json:&quot;myPlugin&quot;`
} type PluginA struct {
 AOption string `json:&quot;aOption&quot;`
}
 "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.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

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

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.

string

volumeSource
required

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

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

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

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

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.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.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.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 decsribes scheduling confiuguration for specific KubeVirt components

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

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

string

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

Name Schema

patches
optional

v1.CustomizeComponentsPatch

Name Schema

patch
optional

string

resourceName
optional

string

resourceType
optional

string

type
optional

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.

integer (int32)

value
required

Value is a String value for the Option provided Required.

string

v1.DataVolumeSource

Name Description Schema

name
required

Name represents the name of the DataVolume in the same namespace

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

DeveloperConfiguration holds developer options

Name Schema

cpuAllocationRatio
optional

integer (int32)

featureGates
optional

< string > array

memoryOvercommit
optional

integer (int32)

nodeSelectors
optional

< string, string > map

pvcTolerateLessSpaceUpToPercent
optional

integer (int32)

useEmulation
optional

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

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 serial console or not. Serial console access will not be available if set to false. Defaults to true.

boolean

blockMultiQueue
optional

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

boolean

disableHotplug
optional

DisableHotplug disabled the ability to hotplug disks.

boolean

disks
optional

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

< v1.Disk > array

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

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

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

Name Description Schema

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.

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.

floppy
optional

Attach a volume as a floppy to the vmi.

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

string

serial
optional

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

string

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.

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

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

If set, EFI will be used instead of BIOS.

Name Description Schema

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.

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

string

virtiofs
required

Virtiofs is supported

v1.FilesystemVirtiofs

Type : object

v1.Firmware

Name Description Schema

bootloader
optional

Settings to control the bootloader that is used.

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

Name Description Schema

readonly
optional

ReadOnly. Defaults to false.

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

Name Description Schema

deviceName
required

string

name
required

Name of the GPU device as exposed by a device plugin

string

v1.GuestAgentCommandInfo

List of commands that QEMU guest agent supports

Name Schema

enabled
optional

boolean

name
required

string

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

string

name
required

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

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'

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

string

type
required

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

string

v1.Interface

Name Description Schema

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

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.

string

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

sriov
optional

tag
optional

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

string

v1.InterfaceBridge

Type : object

v1.InterfaceMacvtap

Type : object

v1.InterfaceMasquerade

Type : object

v1.InterfaceSRIOV

Type : object

v1.InterfaceSlirp

Type : object

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

message
optional

string

reason
optional

string

status
required

string

type
required

string

v1.KubeVirtConfiguration

KubeVirtConfiguration holds all kubevirt configurations

Name Schema

cpuModel
optional

string

cpuRequest
optional

developerConfiguration
optional

emulatedMachines
optional

< string > array

imagePullPolicy
optional

string

machineType
optional

string

memBalloonStatsPeriod
optional

integer (int64)

migrations
optional

network
optional

ovmfPath
optional

string

permittedHostDevices
optional

selinuxLauncherType
optional

string

smbios
optional

supportedGuestAgentVersions
optional

< string > array

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 Schema

caOverlapInterval
optional

caRotateInterval
optional

certRotateInterval
optional

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.

string

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

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

uninstallStrategy
optional

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

string

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

observedDeploymentConfig
optional

string

observedDeploymentID
optional

string

observedKubeVirtRegistry
optional

string

observedKubeVirtVersion
optional

string

operatorVersion
optional

string

phase
optional

string

targetDeploymentConfig
optional

string

targetDeploymentID
optional

string

targetKubeVirtRegistry
optional

string

targetKubeVirtVersion
optional

string

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

v1.Machine

Name Description Schema

type
required

QEMU machine type is the actual chipset of the VirtualMachineInstance.

string

v1.MediatedHostDevice

MediatedHostDevice represents a host mediated device allowed for passthrough

Name Schema

externalResourceProvider
optional

boolean

mdevNameSelector
required

string

resourceName
required

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.

v1.MigrationConfiguration

MigrationConfiguration holds migration options

Name Schema

allowAutoConverge
optional

boolean

allowPostCopy
optional

boolean

bandwidthPerMigration
optional

completionTimeoutPerGiB
optional

integer (int64)

nodeDrainTaintKey
optional

string

parallelMigrationsPerCluster
optional

integer (int64)

parallelOutboundMigrationsPerNode
optional

integer (int64)

progressTimeout
optional

integer (int64)

unsafeMigrationOverride
optional

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.

string

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

string

pod
optional

v1.NetworkConfiguration

NetworkConfiguration holds network options

Name Schema

defaultNetworkInterface
optional

string

permitBridgeInterfaceOnPodNetwork
optional

boolean

permitSlirpInterface
optional

boolean

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

PciHostDevice represents a host PCI device allowed for passthrough

Name Schema

externalResourceProvider
optional

boolean

pciVendorSelector
required

string

resourceName
required

string

v1.PermittedHostDevices

PermittedHostDevices holds inforamtion about devices allowed for passthrough

Name Schema

mediatedDevices
optional

pciHostDevices
optional

< v1.PciHostDevice > array

v1.PodNetwork

Represents the stock pod network interface.

Name Description Schema

vmNetworkCIDR
optional

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

string

v1.Port

Port repesents 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.

integer (int32)

protocol
optional

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

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

failureThreshold
optional

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

integer (int32)

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

RemoveVolumeOptions is provided when dynamically hot unplugging volume and disk

Name Description Schema

name
required

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

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

gracePeriodSeconds
optional

The duration in seconds before the object should be force-restared. 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.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

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

message
optional

string

reason
optional

string

status
required

string

type
required

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 Schema

message
optional

string

reason
optional

string

status
required

string

type
required

string

v1.VirtualMachineInstanceFileSystem

VirtualMachineInstanceFileSystem represents guest os disk

Name Schema

diskName
required

string

fileSystemType
required

string

mountPoint
required

string

totalBytes
required

integer (int32)

usedBytes
required

integer (int32)

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

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 Schema

domain
optional

string

loginTime
optional

number (double)

userName
required

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 Schema

message
optional

string

reason
optional

string

status
required

string

type
required

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

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

startTimestamp
optional

The time the migration action began

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

targetPod
optional

The target pod that the VMI is moving to

string

v1.VirtualMachineInstanceMigrationStatus

VirtualMachineInstanceMigration reprents information pertaining to a VMI’s migration.

Name Schema

conditions
optional

phase
optional

string

v1.VirtualMachineInstanceNetworkInterface

Name Description Schema

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

v1.VirtualMachineInstancePreset

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

message
optional

string

reason
optional

string

status
required

string

type
required

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

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

string

domain
required

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

evictionStrategy
optional

EvictionStrategy can be set to "LiveMigrate" if the VirtualMachineInstance should be migrated instead of shut-off in case of a node drain.

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

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.

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

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.

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

guestOSInfo
optional

Guest OS Information

interfaces
optional

Interfaces represent the details of available network interfaces.

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

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

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

string

reason
optional

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

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

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

v1.VirtualMachineStateChangeRequest

Name Description Schema

action
required

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

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

ready
optional

Ready indicates if the virtual machine is running and ready

boolean

snapshotInProgress
optional

SnapshotInProgress is the name of the VirtualMachineSnapshot currently executing

string

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

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

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

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/

v1.VolumeSnapshotStatus

Name Description Schema

enabled
required

True if the volume supports snapshotting

boolean

name
required

Volume name

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

hotplugVolume
optional

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

message
optional

Message is a detailed message about the current hotplug volume phase

string

name
required

Name is the name of the volume

string

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

string

v1.Watchdog

Named watchdog device.

Name Description Schema

i6300esb
optional

i6300esb watchdog device.

name
required

Name of the watchdog.

string

v1alpha1.Condition

Condition defines conditions

Name Schema

message
optional

string

reason
optional

string

status
required

string

type
required

string

v1alpha1.DataVolumeBlankImage

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

Type : object

v1alpha1.DataVolumeSource

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

Name Schema

blank
optional

http
optional

imageio
optional

pvc
optional

registry
optional

s3
optional

upload
optional

vddk
optional

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

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

string

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

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

string

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

string

namespace
required

The namespace of the source PVC

string

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

secretRef
optional

SecretRef provides the secret reference needed to access the Registry source

string

url
required

URL is the url of the Docker registry source

string

v1alpha1.DataVolumeSourceS3

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

Name Description Schema

secretRef
optional

SecretRef provides the secret reference needed to access the S3 source

string

url
required

URL is the url of the S3 source

string

v1alpha1.DataVolumeSourceUpload

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

Type : object

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

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

v1alpha1.DataVolumeSpec

DataVolumeSpec defines the DataVolume type specification

Name Description Schema

contentType
optional

DataVolumeContentType options: "kubevirt", "archive"

string

pvc
required

PVC is the PVC specification

source
required

Source is the src of the data for the requested DataVolume

v1alpha1.Error

Error is the last error encountered during the snapshot/restore

Name Schema

message
optional

string

time
optional

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

v1alpha1.SourceSpec

SourceSpec contains the appropriate spec for the resource being snapshotted

Name Schema

virtualMachine
optional

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

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

v1alpha1.VirtualMachineRestoreSpec

VirtualMachineRestoreSpec is the spec for a VirtualMachineRestoreresource

Name Description Schema

target
required

initially only VirtualMachine type supported

virtualMachineSnapshotName
required

string

v1alpha1.VirtualMachineRestoreStatus

VirtualMachineRestoreStatus is the spec for a VirtualMachineRestoreresource

Name Schema

complete
optional

boolean

conditions
optional

< v1alpha1.Condition > array

deletedDataVolumes
optional

< string > array

restoreTime
optional

restores
optional

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

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

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

v1alpha1.VirtualMachineSnapshotContentSpec

VirtualMachineSnapshotContentSpec is the spec for a VirtualMachineSnapshotContent resource

Name Schema

source
required

virtualMachineSnapshotName
optional

string

volumeBackups
optional

v1alpha1.VirtualMachineSnapshotContentStatus

VirtualMachineSnapshotContentStatus is the status for a VirtualMachineSnapshotStatus resource

Name Schema

creationTime
optional

error
optional

readyToUse
optional

boolean

volumeSnapshotStatus
optional

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

v1alpha1.VirtualMachineSnapshotSpec

VirtualMachineSnapshotSpec is the spec for a VirtualMachineSnapshot resource

Name Schema

deletionPolicy
optional

string

source
required

v1alpha1.VirtualMachineSnapshotStatus

VirtualMachineSnapshotStatus is the status for a VirtualMachineSnapshot resource

Name Schema

conditions
optional

< v1alpha1.Condition > array

creationTime
optional

error
optional

readyToUse
optional

boolean

sourceUID
optional

string

virtualMachineSnapshotContentName
optional

string

v1alpha1.VolumeBackup

VolumeBackup contains the data neeed to restore a PVC

Name Schema

persistentVolumeClaim
required

volumeName
required

string

volumeSnapshotName
optional

string

v1alpha1.VolumeRestore

VolumeRestore contains the data neeed to restore a PVC

Name Schema

dataVolumeName
optional

string

persistentVolumeClaim
required

string

volumeName
required

string

volumeSnapshotName
required

string

v1alpha1.VolumeSnapshotStatus

VolumeSnapshotStatus is the status of a VolumeSnapshot

Name Schema

creationTime
optional

error
optional

readyToUse
optional

boolean

volumeSnapshotName
required

string