nodeAffinity
optional

Describes node affinity scheduling rules for the pod.

k8s.io.api.core.v1.NodeAffinity

podAffinity
optional

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

k8s.io.api.core.v1.PodAffinity

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

fieldRef
optional

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

k8s.io.api.core.v1.ObjectFieldSelector

mode
optional

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

integer (int32)

path
required

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
Default : ""

string

resourceFieldRef
optional

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

k8s.io.api.core.v1.ResourceFieldSelector

command
optional

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

< string > array

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.

< k8s.io.api.core.v1.HTTPHeader > array

path
optional

Path to access on the HTTP server.

string

scheme
optional

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

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

enum (HTTP, HTTPS)

name
required

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

string

value
required

The header field value
Default : ""

string

name
optional

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Default : ""

string

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.

< k8s.io.api.core.v1.PreferredSchedulingTerm > array

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

nodeSelectorTerms
required

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

< k8s.io.api.core.v1.NodeSelectorTerm > array

key
required

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

string

operator
required

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

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

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

values
optional

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

< string > array

matchExpressions
optional

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

< k8s.io.api.core.v1.NodeSelectorRequirement > array

matchFields
optional

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

< k8s.io.api.core.v1.NodeSelectorRequirement > array

apiVersion
optional

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

string

fieldPath
required

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

string

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

< enum (ReadOnlyMany, ReadWriteMany, ReadWriteOnce, ReadWriteOncePod) > array

dataSource
optional

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

k8s.io.api.core.v1.TypedLocalObjectReference

dataSourceRef
optional

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn’t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

k8s.io.api.core.v1.TypedObjectReference

resources
optional

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

k8s.io.api.core.v1.VolumeResourceRequirements

selector
optional

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

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

storageClassName
optional

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

string

volumeAttributesClassName
optional

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

string

volumeMode
optional

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

Possible enum values: - "Block" means the volume will not be formatted with a filesystem and will remain a raw block device. - "Filesystem" means the volume will be or is formatted with a filesystem. - "FromStorageProfile" means the volume mode will be auto selected by CDI according to a matching StorageProfile

enum (Block, Filesystem, FromStorageProfile)

volumeName
optional

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

string

claimName
required

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
Default : ""

string

readOnly
optional

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

boolean

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.

< k8s.io.api.core.v1.WeightedPodAffinityTerm > array

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

labelSelector
optional

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

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

matchLabelKeys
optional

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

< string > array

mismatchLabelKeys
optional

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

< string > array

namespaceSelector
optional

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

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

namespaces
optional

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

< string > array

topologyKey
required

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

string

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.

< k8s.io.api.core.v1.WeightedPodAffinityTerm > array

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

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.

< k8s.io.api.core.v1.PodDNSConfigOption > array

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

name
optional

Required.

string

value
optional

string

preference
required

A node selector term, associated with the corresponding weight.

k8s.io.api.core.v1.NodeSelectorTerm

weight
required

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

integer (int32)

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"

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

resource
required

Required: resource to select
Default : ""

string

host
optional

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

string

effect
optional

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

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

enum (NoExecute, NoSchedule, PreferNoSchedule)

key
optional

Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

string

operator
optional

Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

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

enum (Equal, Exists)

tolerationSeconds
optional

TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

integer (int64)

value
optional

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

string

labelSelector
optional

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

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

matchLabelKeys
optional

MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn’t set. Keys that don’t exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.

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

< string > array

maxSkew
required

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It’s a required field. Default value is 1 and 0 is not allowed.
Default : 0

integer (int32)

minDomains
optional

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won’t schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

integer (int32)

nodeAffinityPolicy
optional

NodeAffinityPolicy indicates how we will treat Pod’s nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

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

enum (Honor, Ignore)

nodeTaintsPolicy
optional

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

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

enum (Honor, Ignore)

topologyKey
required

TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It’s a required field.
Default : ""

string

whenUnsatisfiable
required

WhenUnsatisfiable indicates how to deal with a pod if it doesn’t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won’t make it more imbalanced. It’s a required field.

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

enum (DoNotSchedule, ScheduleAnyway)

apiGroup
optional

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

string

kind
required

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

string

name
required

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

string

apiGroup
optional

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

string

kind
required

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

string

name
required

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

string

namespace
optional

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

string

limits
optional

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

< string, k8s.io.apimachinery.pkg.api.resource.Quantity > map

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

< string, k8s.io.apimachinery.pkg.api.resource.Quantity > map

podAffinityTerm
required

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

k8s.io.api.core.v1.PodAffinityTerm

weight
required

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

integer (int32)

apiVersion
optional

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

string

kind
optional

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

string

name
required

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

string

preferredVersion
optional

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

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

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.

< k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR > array

versions
required

versions are the versions supported in this group.

< k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery > array

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.

< k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup > 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

categories
optional

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

< string > array

group
optional

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

string

kind
required

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

string

name
required

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

string

namespaced
required

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

boolean

shortNames
optional

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

< string > array

singularName
required

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

string

storageVersionHash
optional

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

string

verbs
required

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

< string > array

version
optional

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

string

apiVersion
optional

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

string

groupVersion
required

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

string

kind
optional

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

string

resources
required

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

< k8s.io.apimachinery.pkg.apis.meta.v1.APIResource > array

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.

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

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

groupVersion
required

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

string

version
required

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

string

matchExpressions
optional

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

< k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement > array

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

key
required

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

string

operator
required

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

string

values
optional

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

< string > array

continue
optional

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

string

remainingItemCount
optional

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

integer (int64)

resourceVersion
optional

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

string

selfLink
optional

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

string

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.

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

manager
optional

Manager is an identifier of the workflow managing these fields.

string

operation
optional

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

string

subresource
optional

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

string

time
optional

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

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

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

< string, string > map

deletionGracePeriodSeconds
optional

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

integer (int64)

deletionTimestamp
optional

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

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

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

finalizers
optional

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

< string > array

generateName
optional

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

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

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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.

< k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry > array

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

string

namespace
optional

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

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/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.

< k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference > array

resourceVersion
optional

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

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

string

selfLink
optional

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

string

uid
optional

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

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

string

apiVersion
required

API version of the referent.
Default : ""

string

blockOwnerDeletion
optional

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

boolean

controller
optional

If true, this reference points to the managing controller.

boolean

kind
required

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Default : ""

string

name
required

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Default : ""

string

uid
required

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
Default : ""

string

resourceVersion
optional

Specifies the target ResourceVersion

string

uid
optional

Specifies the target UID.

string

paths
required

paths are the paths available at root.

< string > array

clientCIDR
required

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

string

serverAddress
required

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

string

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.

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

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

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

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

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

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

causes
optional

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

< k8s.io.apimachinery.pkg.apis.meta.v1.StatusCause > array

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

string

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.

k8s.io.apimachinery.pkg.runtime.RawExtension

type
required

Default : ""

string

slicNameRef
optional

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

string

sshPublicKey
optional

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

v1.SSHPublicKeyAccessCredential

userPassword
optional

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

v1.UserPasswordAccessCredential

secretName
required

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

string

disk
required

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

v1.Disk

dryRun
optional

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

< string > array

name
required

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

string

volumeSource
required

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

v1.HotplugVolumeSource

amd64
optional

v1.ArchSpecificConfiguration

arm64
optional

v1.ArchSpecificConfiguration

defaultArchitecture
optional

string

ppc64le
optional

v1.ArchSpecificConfiguration

emulatedMachines
optional

< string > array

machineType
optional

string

ovmfPath
optional

string

useSerial
optional

If set, the BIOS output will be transmitted over serial

boolean

custom
optional

v1.CustomBlockSize

matchVolume
optional

v1.FeatureState

bios
optional

If set (default), BIOS will be used.

v1.BIOS

efi
optional

If set, EFI will be used instead of BIOS.

v1.EFI

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

cores
optional

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

integer (int64)

dedicatedCpuPlacement
optional

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

boolean

features
optional

Features specifies the CPU features list inside the VMI.

< v1.CPUFeature > array

isolateEmulatorThread
optional

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

boolean

maxSockets
optional

MaxSockets specifies the maximum amount of sockets that can be hotplugged

integer (int64)

model
optional

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

string

numa
optional

NUMA allows specifying settings for the guest NUMA topology

v1.NUMA

realtime
optional

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

v1.Realtime

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)

name
required

Name of the CPU feature
Default : ""

string

policy
optional

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

string

cores
optional

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

integer (int64)

sockets
optional

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

integer (int64)

threads
optional

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

integer (int64)

duration
optional

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

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

renewBefore
optional

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

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

asset
optional

string

manufacturer
optional

string

serial
optional

string

sku
optional

string

version
optional

string

timer
optional

Timer specifies whih timers are attached to the vmi.

v1.Timer

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

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

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)

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.

k8s.io.api.core.v1.LocalObjectReference

secretRef
optional

UserDataSecretRef references a k8s secret that contains config drive userdata.

k8s.io.api.core.v1.LocalObjectReference

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

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.

k8s.io.api.core.v1.LocalObjectReference

secretRef
optional

UserDataSecretRef references a k8s secret that contains NoCloud userdata.

k8s.io.api.core.v1.LocalObjectReference

userData
optional

UserData contains NoCloud inline cloud-init userdata.

string

userDataBase64
optional

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

string

enabled
optional

Enabled controls the deployment of common-instancetypes resources, defaults to True.

boolean

nodePlacement
optional

nodePlacement describes scheduling configuration for specific KubeVirt components

v1.NodePlacement

replicas
optional

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

integer (byte)

name
optional

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Default : ""

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

checksum
optional

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

integer (int64)

image
required

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

string

imagePullPolicy
optional

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

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

enum (Always, IfNotPresent, Never)

imagePullSecret
optional

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

string

path
optional

Path defines the path to disk file in the container

string

logical
required

Default : 0

integer (int32)

physical
required

Default : 0

integer (int32)

localhostProfile
optional

string

runtimeDefaultProfile
optional

boolean

flags
optional

Configure the value used for deployment and daemonset resources

v1.Flags

patches
optional

< v1.CustomizeComponentsPatch > array

patch
required

Default : ""

string

resourceName
required

Default : ""

string

resourceType
required

Default : ""

string

type
required

Default : ""

string

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

< v1.DHCPPrivateOptions > array

tftpServerName
optional

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

string

option
required

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

integer (int32)

value
required

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

string

hotpluggable
optional

Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

boolean

name
required

Name of both the DataVolume and the PVC in the same namespace.
Default : ""

string

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

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

spec
required

DataVolumeSpec contains the DataVolume specification.

v1beta1.DataVolumeSpec

status
optional

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

v1.DataVolumeTemplateDummyStatus

cpuAllocationRatio
optional

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

integer (int32)

diskVerification
optional

v1.DiskVerification

featureGates
optional

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

< string > array

logVerbosity
optional

v1.LogVerbosity

memoryOvercommit
optional

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

integer (int32)

minimumClusterTSCFrequency
optional

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

integer (int64)

minimumReservePVCBytes
optional

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

integer (int64)

nodeSelectors
optional

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

< string, string > map

pvcTolerateLessSpaceUpToPercent
optional

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

integer (int32)

useEmulation
optional

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

boolean

autoattachGraphicsDevice
optional

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

boolean

autoattachInputDevice
optional

Whether to attach an Input Device. Defaults to false.

boolean

autoattachMemBalloon
optional

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

boolean

autoattachPodInterface
optional

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

boolean

autoattachSerialConsole
optional

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

boolean

autoattachVSOCK
optional

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

boolean

blockMultiQueue
optional

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

boolean

clientPassthrough
optional

To configure and access client devices such as redirecting USB

v1.ClientPassthroughDevices

disableHotplug
optional

DisableHotplug disabled the ability to hotplug disks.

boolean

disks
optional

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

< v1.Disk > array

downwardMetrics
optional

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

v1.DownwardMetrics

filesystems
optional

Filesystems describes filesystem which is connected to the vmi.

< v1.Filesystem > array

gpus
optional

Whether to attach a GPU device to the vmi.

< v1.GPU > array

hostDevices
optional

Whether to attach a host device to the vmi.

< v1.HostDevice > array

inputs
optional

Inputs describe input devices

< v1.Input > array

interfaces
optional

Interfaces describe network interfaces which are added to the vmi.

< v1.Interface > array

logSerialConsole
optional

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

boolean

networkInterfaceMultiqueue
optional

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

boolean

rng
optional

Whether to have random number generator from host

v1.Rng

sound
optional

Whether to emulate a sound device.

v1.SoundDevice

tpm
optional

Whether to emulate a TPM device.

v1.TPMDevice

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

blockSize
optional

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

v1.BlockSize

bootOrder
optional

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

integer (int32)

cache
optional

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

string

cdrom
optional

Attach a volume as a cdrom to the vmi.

v1.CDRomTarget

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.

v1.DiskTarget

errorPolicy
optional

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

string

io
optional

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

string

lun
optional

Attach a volume as a LUN to the vmi.

v1.LunTarget

name
required

Name is the device name
Default : ""

string

serial
optional

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

string

shareable
optional

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

boolean

tag
optional

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

string

bus
optional

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

string

pciAddress
optional

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

string

readonly
optional

ReadOnly. Defaults to false.

boolean

memoryLimit
required

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

claimName
optional

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

string

endTimestamp
optional

EndTimestamp is the time when the memory dump completed

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

startTimestamp
optional

StartTimestamp is the time when the memory dump started

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

targetFileName
optional

TargetFileName is the name of the memory dump output

string

chassis
optional

Chassis specifies the chassis info passed to the domain.

v1.Chassis

clock
optional

Clock sets the clock and timers of the vmi.

v1.Clock

cpu
optional

CPU allow specified the detailed CPU topology inside the vmi.

v1.CPU

devices
required

Devices allows adding disks, network interfaces, and others

v1.Devices

features
optional

Features like acpi, apic, hyperv, smm.

v1.Features

firmware
optional

Firmware.

v1.Firmware

ioThreadsPolicy
optional

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

string

launchSecurity
optional

Launch Security setting of the vmi.

v1.LaunchSecurity

machine
optional

Machine type.

v1.Machine

memory
optional

Memory allow specifying the VMI memory features.

v1.Memory

resources
optional

Resources describes the Compute Resources required by this vmi.

v1.ResourceRequirements

fields
optional

Fields is a list of downward API volume file

< k8s.io.api.core.v1.DownwardAPIVolumeFile > array

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

persistent
optional

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

boolean

secureBoot
optional

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

boolean

capacity
required

Capacity of the sparse disk.

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

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

k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource