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

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

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.

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.

< v1.ServerAddressByClientCIDR > array

versions
required

versions are the versions supported in this group.

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

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

< v1.APIResource > array

nodeAffinity
optional

Describes node affinity scheduling rules for the pod.

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

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

v1.PodAntiAffinity

lastHeartbeatTime
optional

v1.Time

lastTransitionTime
optional

v1.Time

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

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

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.

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.

< 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

name
optional

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

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.

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.

v1.Time

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.

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

v1.NodeSelector

nodeSelectorTerms
required

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

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

< v1.NodeSelectorRequirement > array

matchFields
optional

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

< v1.NodeSelectorRequirement > array

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

creationTimestamp
optional

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

v1.Time

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

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.

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

< 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

accessModes
optional

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

< string > array

dataSource
optional

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

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.

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

v1.ResourceRequirements

selector
optional

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

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

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

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.

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

< v1.PodAffinityTerm > array

labelSelector
optional

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

v1.LabelSelector

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.

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.

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

< v1.PodAffinityTerm > array

resourceVersion
optional

Specifies the target ResourceVersion

string

uid
optional

Specifies the target UID.

string

preference
required

A node selector term, associated with the corresponding weight.

v1.NodeSelectorTerm

weight
required

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

integer (int32)

name
required

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

string

claims
optional

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

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

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

< v1.ResourceClaim > array

limits
optional

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

< string, 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, resource.Quantity > map

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.

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

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.

< 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

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

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

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.

runtime.RawExtension

type
required

Default : ""

string

podAffinityTerm
required

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

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

metadata
optional

v1.ObjectMeta

spec
required

v1beta1.CDISpec

status
optional

v1beta1.CDIStatus

ca
optional

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

v1beta1.CertConfig

server
optional

Server configuration Certs are rotated and discarded

v1beta1.CertConfig

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

v1.ObjectMeta

spec
required

v1beta1.CDIConfigSpec

status
optional

v1beta1.CDIConfigStatus

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

Items provides a list of CDIConfigs

< v1beta1.CDIConfig > 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
required

v1.ListMeta

dataVolumeTTLSeconds
optional

DataVolumeTTLSeconds is the time in seconds after DataVolume completion it can be garbage collected. Disabled by default.

integer (int32)

featureGates
optional

FeatureGates are a list of specific enabled feature gates

< string > array

filesystemOverhead
optional

FilesystemOverhead describes the space reserved for overhead when using Filesystem volumes. A value is between 0 and 1, if not defined it is 0.055 (5.5% overhead)

v1beta1.FilesystemOverhead

imagePullSecrets
optional

The imagePullSecrets used to pull the container images

< v1.LocalObjectReference > array

importProxy
optional

ImportProxy contains importer pod proxy configuration.

v1beta1.ImportProxy

insecureRegistries
optional

InsecureRegistries is a list of TLS disabled registries

< string > array

logVerbosity
optional

LogVerbosity overrides the default verbosity level used to initialize loggers

integer (int32)

podResourceRequirements
optional

ResourceRequirements describes the compute resource requirements.

v1.ResourceRequirements

preallocation
optional

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

boolean

scratchSpaceStorageClass
optional

Override the storage class to used for scratch space during transfer operations. The scratch space storage class is determined in the following order: 1. value of scratchSpaceStorageClass, if that doesn’t exist, use the default storage class, if there is no default storage class, use the storage class of the DataVolume, if no storage class specified, use no storage class for scratch space

string

tlsSecurityProfile
optional

TLSSecurityProfile is used by operators to apply cluster-wide TLS security settings to operands.

v1beta1.TLSSecurityProfile

uploadProxyURLOverride
optional

Override the URL used when uploading to a DataVolume

string

defaultPodResourceRequirements
optional

ResourceRequirements describes the compute resource requirements.

v1.ResourceRequirements

filesystemOverhead
optional

FilesystemOverhead describes the space reserved for overhead when using Filesystem volumes. A percentage value is between 0 and 1

v1beta1.FilesystemOverhead

imagePullSecrets
optional

The imagePullSecrets used to pull the container images

< v1.LocalObjectReference > array

importProxy
optional

ImportProxy contains importer pod proxy configuration.

v1beta1.ImportProxy

preallocation
optional

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

boolean

scratchSpaceStorageClass
optional

The calculated storage class to be used for scratch space

string

uploadProxyURL
optional

The calculated upload proxy URL

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

items
required

Items provides a list of CDIs

< v1beta1.CDI > 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
required

v1.ListMeta

certConfig
optional

certificate configuration

v1beta1.CDICertConfig

cloneStrategyOverride
optional

Clone strategy override: should we use a host-assisted copy even if snapshots are available?

string

config
optional

CDIConfig at CDI level

v1beta1.CDIConfigSpec

customizeComponents
optional

v1beta1.CustomizeComponents

imagePullPolicy
optional

PullPolicy describes a policy for if/when to pull a container image

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)

infra
optional

Selectors and tolerations that should apply to cdi infrastructure components

v1beta1.ComponentConfig

priorityClass
optional

PriorityClass of the CDI control plane

string

uninstallStrategy
optional

CDIUninstallStrategy defines the state to leave CDI on uninstall

string

workload
optional

Restrict on which nodes CDI workload pods will be scheduled

api.NodePlacement

conditions
optional

A list of current conditions of the resource

< v1.Condition > array

observedVersion
optional

The observed version of the resource

string

operatorVersion
optional

The version of the resource as defined by the operator

string

phase
optional

string

targetVersion
optional

The desired version of the resource

string

duration
optional

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

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.

v1.Duration

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

v1.Affinity

apiServerReplicas
optional

ApiserverReplicas set Replicas for cdi-apiserver

integer (int32)

deploymentReplicas
optional

DeploymentReplicas set Replicas for cdi-deployment

integer (int32)

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

uploadProxyReplicas
optional

UploadproxyReplicas set Replicas for cdi-uploadproxy

integer (int32)

ciphers
required

ciphers is used to specify the cipher algorithms that are negotiated during the TLS handshake. Operators may remove entries their operands do not support. For example, to use DES-CBC3-SHA (yaml):

ciphers: - DES-CBC3-SHA

< string > array

minTLSVersion
required

minTLSVersion is used to specify the minimal version of the TLS protocol that is negotiated during the TLS handshake. For example, to use TLS versions 1.1, 1.2 and 1.3 (yaml):

minTLSVersion: VersionTLS11

string

flags
optional

Configure the value used for deployment and daemonset resources

v1beta1.Flags

patches
optional

< v1beta1.CustomizeComponentsPatch > array

patch
required

Default : ""

string

resourceName
required

Default : ""

string

resourceType
required

Default : ""

string

type
required

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

v1.ObjectMeta

spec
required

v1beta1.DataImportCronSpec

status
optional

v1beta1.DataImportCronStatus

lastHeartbeatTime
optional

v1.Time

lastTransitionTime
optional

v1.Time

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

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

items
required

Items provides a list of DataImportCrons

< v1beta1.DataImportCron > 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
required

v1.ListMeta

garbageCollect
optional

GarbageCollect specifies whether old PVCs should be cleaned up after a new PVC is imported. Options are currently "Outdated" and "Never", defaults to "Outdated".

string

importsToKeep
optional

Number of import PVCs to keep when garbage collecting. Default is 3.

integer (int32)

managedDataSource
required

ManagedDataSource specifies the name of the corresponding DataSource this cron will manage. DataSource has to be in the same namespace.
Default : ""

string

retentionPolicy
optional

RetentionPolicy specifies whether the created DataVolumes and DataSources are retained when their DataImportCron is deleted. Default is RatainAll.

string

schedule
required

Schedule specifies in cron format when and how often to look for new imports
Default : ""

string

template
required

Template specifies template for the DVs to be created

v1beta1.DataVolume

conditions
optional

< v1beta1.DataImportCronCondition > array

currentImports
optional

CurrentImports are the imports in progress. Currently only a single import is supported.

< v1beta1.ImportStatus > array

lastExecutionTimestamp
optional

LastExecutionTimestamp is the time of the last polling

v1.Time

lastImportTimestamp
optional

LastImportTimestamp is the time of the last import

v1.Time

lastImportedPVC
optional

LastImportedPVC is the last imported PVC

v1beta1.DataVolumeSourcePVC

sourceFormat
optional

SourceFormat defines the format of the DataImportCron-created disk image sources

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

v1.ObjectMeta

spec
required

v1beta1.DataSourceSpec

status
optional

v1beta1.DataSourceStatus

lastHeartbeatTime
optional

v1.Time

lastTransitionTime
optional

v1.Time

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

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

items
required

Items provides a list of DataSources

< v1beta1.DataSource > 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
required

v1.ListMeta

pvc
optional

v1beta1.DataVolumeSourcePVC

snapshot
optional

v1beta1.DataVolumeSourceSnapshot

source
required

Source is the source of the data referenced by the DataSource

v1beta1.DataSourceSource

conditions
optional

< v1beta1.DataSourceCondition > array

source
optional

Source is the current source of the data referenced by the DataSource

v1beta1.DataSourceSource

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

v1.ObjectMeta

spec
required

v1beta1.DataVolumeSpec

status
optional

v1beta1.DataVolumeStatus

current
required

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

string

previous
required

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

string

lastHeartbeatTime
optional

v1.Time

lastTransitionTime
optional

v1.Time

message
optional

string

reason
optional

string

status
required

Default : ""

string

type
required

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

items
required

Items provides a list of DataVolumes

< v1beta1.DataVolume > 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
required

v1.ListMeta

blank
optional

v1beta1.DataVolumeBlankImage

gcs
optional

v1beta1.DataVolumeSourceGCS

http
optional

v1beta1.DataVolumeSourceHTTP

imageio
optional

v1beta1.DataVolumeSourceImageIO

pvc
optional

v1beta1.DataVolumeSourcePVC

registry
optional

v1beta1.DataVolumeSourceRegistry

s3
optional

v1beta1.DataVolumeSourceS3

snapshot
optional

v1beta1.DataVolumeSourceSnapshot

upload
optional

v1beta1.DataVolumeSourceUpload

vddk
optional

v1beta1.DataVolumeSourceVDDK

secretRef
optional

SecretRef provides the secret reference needed to access the GCS source

string

url
required

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

string

certConfigMap
optional

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

string

extraHeaders
optional

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

< string > array

secretExtraHeaders
optional

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

< string > array

secretRef
optional

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

string

url
required

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

string

certConfigMap
optional

CertConfigMap provides a reference to the CA cert

string

diskId
required

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

string

secretRef
optional

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

string

url
required

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

string

name
required

The name of the source PVC
Default : ""

string

namespace
required

The namespace of the source PVC
Default : ""

string

kind
required

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

string

name
required

The name of the source reference
Default : ""

string

namespace
optional

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

string

certConfigMap
optional

CertConfigMap provides a reference to the Registry certs

string

imageStream
optional

ImageStream is the name of image stream for import

string

pullMethod
optional

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

string

secretRef
optional

SecretRef provides the secret reference needed to access the Registry source

string

url
optional

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

string

certConfigMap
optional

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

string

secretRef
optional

SecretRef provides the secret reference needed to access the S3 source

string

url
required

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

string

name
required

The name of the source VolumeSnapshot
Default : ""

string

namespace
required

The namespace of the source VolumeSnapshot
Default : ""

string

backingFile
optional

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

string

initImageURL
optional

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

string

secretRef
optional

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

string

thumbprint
optional

Thumbprint is the certificate thumbprint of the vCenter or ESXi host

string

url
optional

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

string

uuid
optional

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

string

checkpoints
optional

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

< v1beta1.DataVolumeCheckpoint > array

contentType
optional

DataVolumeContentType options: "kubevirt", "archive"

string

finalCheckpoint
optional

FinalCheckpoint indicates whether the current DataVolumeCheckpoint is the final checkpoint.

boolean

preallocation
optional

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

boolean

priorityClassName
optional

PriorityClassName for Importer, Cloner and Uploader pod

string

pvc
optional

PVC is the PVC specification

v1.PersistentVolumeClaimSpec

source
optional

Source is the src of the data for the requested DataVolume

v1beta1.DataVolumeSource

sourceRef
optional

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

v1beta1.DataVolumeSourceRef

storage
optional

Storage is the requested storage specification

v1beta1.StorageSpec

claimName
optional

ClaimName is the name of the underlying PVC used by the DataVolume.

string

conditions
optional

< v1beta1.DataVolumeCondition > array

phase
optional

Phase is the current phase of the data volume

string

progress
optional

string

restartCount
optional

RestartCount is the number of times the pod populating the DataVolume has restarted

integer (int32)

global
optional

Global is how much space of a Filesystem volume should be reserved for overhead. This value is used unless overridden by a more specific value (per storageClass)

string

storageClass
optional

StorageClass specifies how much space of a Filesystem volume should be reserved for safety. The keys are the storageClass and the values are the overhead. This value overrides the global value

< string, string > map

api
optional

< string, string > map

controller
optional

< string, string > map

uploadProxy
optional

< string, string > map

HTTPProxy
optional

HTTPProxy is the URL http://<username>:<pswd>@<ip>:<port>; of the import proxy for HTTP requests. Empty means unset and will not result in the import pod env var.

string

HTTPSProxy
optional

HTTPSProxy is the URL https://<username>:<pswd>@<ip>:<port>; of the import proxy for HTTPS requests. Empty means unset and will not result in the import pod env var.

string

noProxy
optional

NoProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used. Empty means unset and will not result in the import pod env var.

string

trustedCAProxy
optional

TrustedCAProxy is the name of a ConfigMap in the cdi namespace that contains a user-provided trusted certificate authority (CA) bundle. The TrustedCAProxy ConfigMap is consumed by the DataImportCron controller for creating cronjobs, and by the import controller referring a copy of the ConfigMap in the import namespace. Here is an example of the ConfigMap (in yaml):

apiVersion: v1 kind: ConfigMap metadata: name: my-ca-proxy-cm namespace: cdi data: ca.pem: | —–BEGIN CERTIFICATE—– … <base64 encoded cert> … —–END CERTIFICATE—–

string

DataVolumeName
required

DataVolumeName is the currently in progress import DataVolume
Default : ""

string

Digest
required

Digest of the currently imported image
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

< string > array

dataSource
optional

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

v1.TypedLocalObjectReference

dataSourceRef
optional

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

v1.TypedObjectReference

resources
optional

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

v1.ResourceRequirements

selector
optional

A label query over volumes to consider for binding.

v1.LabelSelector

storageClassName
optional

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

string

volumeMode
optional

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

Possible enum values: - "Block" means the volume will not be formatted with a filesystem and will remain a raw block device. - "Filesystem" means the volume will be or is formatted with a filesystem. - "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

custom
optional

custom is a user-defined TLS security profile. Be extremely careful using a custom profile as invalid configurations can be catastrophic. An example custom profile looks like this:

ciphers: - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 minTLSVersion: VersionTLS11

v1beta1.CustomTLSProfile

intermediate
optional

intermediate is a TLS security profile based on:

https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29

and looks like this (yaml):

ciphers: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 minTLSVersion: VersionTLS12

v1beta1.IntermediateTLSProfile

modern
optional

modern is a TLS security profile based on:

https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility

and looks like this (yaml):

ciphers: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 minTLSVersion: VersionTLS13

v1beta1.ModernTLSProfile

old
optional

old is a TLS security profile based on:

https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility

and looks like this (yaml):

ciphers: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 - DHE-RSA-CHACHA20-POLY1305 - ECDHE-ECDSA-AES128-SHA256 - ECDHE-RSA-AES128-SHA256 - ECDHE-ECDSA-AES128-SHA - ECDHE-RSA-AES128-SHA - ECDHE-ECDSA-AES256-SHA384 - ECDHE-RSA-AES256-SHA384 - ECDHE-ECDSA-AES256-SHA - ECDHE-RSA-AES256-SHA - DHE-RSA-AES128-SHA256 - DHE-RSA-AES256-SHA256 - AES128-GCM-SHA256 - AES256-GCM-SHA384 - AES128-SHA256 - AES256-SHA256 - AES128-SHA - AES256-SHA - DES-CBC3-SHA minTLSVersion: VersionTLS10

v1beta1.OldTLSProfile

type
optional

type is one of Old, Intermediate, Modern or Custom. Custom provides the ability to specify individual TLS security profile parameters. Old, Intermediate and Modern are TLS security profiles based on:

https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations

The profiles are intent based, so they may change over time as new ciphers are developed and existing ciphers are found to be insecure. Depending on precisely which ciphers are available to a process, the list may be reduced.

Note that the Modern profile is currently not supported because it is not yet well adopted by common software libraries.
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
required

v1.ObjectMeta

spec
required

Spec contains the parameters of the request

v1beta1.UploadTokenRequestSpec

status
required

Status contains the status of the request

v1beta1.UploadTokenRequestStatus

pvcName
required

PvcName is the name of the PVC to upload to
Default : ""

string

token
optional

Token is a JWT token to be inserted in "Authentication Bearer header"

string