Skip to main content

batch/Job@v1

Properties

PropertyTypeAttributesDescription
metadataIoK8SApimachineryPkgApisMetaV1ObjectMetaRequired, IdentifierObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
apiVersion'batch/v1'Read-only, Deploy-time constantAPIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind'Job'Read-only, Deploy-time constantKind 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
specIoK8SApiBatchV1JobSpecJobSpec describes how the job execution will look like.
statusIoK8SApiBatchV1JobStatusJobStatus represents the current state of a Job.

IoK8SApimachineryPkgApisMetaV1ObjectMeta

PropertyTypeAttributesDescription
namestringRequired, Deploy-time constant, IdentifierName 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
annotationsIoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotationsAnnotations 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
creationTimestampstringRead-onlyTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
deletionGracePeriodSecondsintRead-onlyNumber 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.
deletionTimestampstringRead-onlyTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
finalizersstring[]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.
generationintRead-onlyA sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labelsIoK8SApimachineryPkgApisMetaV1ObjectMetaLabelsMap 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
managedFieldsIoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry[]Read-onlyManagedFields 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.
namespacestringDeploy-time constant, IdentifierNamespace 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
ownerReferencesIoK8SApimachineryPkgApisMetaV1OwnerReference[]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.
resourceVersionstringRead-onlyAn 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
selfLinkstringRead-onlyDeprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uidstringRead-onlyUID 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

IoK8SApiBatchV1JobSpec

PropertyTypeAttributesDescription
templateIoK8SApiCoreV1PodTemplateSpecRequiredPodTemplateSpec describes the data a pod should have when created from a template
activeDeadlineSecondsintSpecifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.
backoffLimitintSpecifies the number of retries before marking this job failed. Defaults to 6
backoffLimitPerIndexintSpecifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable.
completionModestringcompletionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job.
completionsintSpecifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
managedBystringManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string `kubernetes.io/job-controller`, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first "/" must be a valid subdomain as defined by RFC 1123. All characters trailing the first "/" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. This field is immutable. This field is beta-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (enabled by default).
manualSelectorboolmanualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector
maxFailedIndexesintSpecifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5.
parallelismintSpecifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
podFailurePolicyIoK8SApiBatchV1PodFailurePolicyPodFailurePolicy describes how failed pods influence the backoffLimit.
podReplacementPolicystringpodReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed. - Failed means to wait until a previously created Pod is fully terminated (has phase Failed or Succeeded) before creating a replacement Pod. When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default.
selectorIoK8SApimachineryPkgApisMetaV1LabelSelectorA label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
successPolicyIoK8SApiBatchV1SuccessPolicySuccessPolicy describes when a Job can be declared as succeeded based on the success of some indexes.
suspendboolsuspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false.
ttlSecondsAfterFinishedintttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes.

IoK8SApiBatchV1JobStatus

PropertyTypeAttributesDescription
activeintThe number of pending and running pods which are not terminating (without a deletionTimestamp). The value is zero for finished jobs.
completedIndexesstringcompletedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7".
completionTimestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
conditionsIoK8SApiBatchV1JobCondition[]The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true. A job is considered finished when it is in a terminal condition, either "Complete" or "Failed". A Job cannot have both the "Complete" and "Failed" conditions. Additionally, it cannot be in the "Complete" and "FailureTarget" conditions. The "Complete", "Failed" and "FailureTarget" conditions cannot be disabled. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
failedintThe number of pods which reached phase Failed. The value increases monotonically.
failedIndexesstringFailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". The set of failed indexes cannot overlap with the set of completed indexes.
readyintThe number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).
startTimestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
succeededintThe number of pods which reached phase Succeeded. The value increases monotonically for a given spec. However, it may decrease in reaction to scale down of elastic indexed jobs.
terminatingintThe number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp). This field is beta-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (enabled by default).
uncountedTerminatedPodsIoK8SApiBatchV1UncountedTerminatedPodsUncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters.

IoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotations

Additional properties of type string are allowed.

IoK8SApimachineryPkgApisMetaV1ObjectMetaLabels

Additional properties of type string are allowed.

IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry

PropertyTypeAttributesDescription
apiVersionstringAPIVersion 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.
fieldsTypestringFieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1anyAny object
managerstringManager is an identifier of the workflow managing these fields.
operationstringOperation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresourcestringSubresource 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.
timestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

IoK8SApimachineryPkgApisMetaV1OwnerReference

PropertyTypeAttributesDescription
apiVersionstringRequiredAPI version of the referent.
kindstringRequiredKind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namestringRequiredName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uidstringRequiredUID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
blockOwnerDeletionboolIf 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.
controllerboolIf true, this reference points to the managing controller.

IoK8SApiCoreV1PodTemplateSpec

PropertyTypeAttributesDescription
metadataIoK8SApimachineryPkgApisMetaV1ObjectMetaObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
specIoK8SApiCoreV1PodSpecPodSpec is a description of a pod.

IoK8SApiBatchV1PodFailurePolicy

PropertyTypeAttributesDescription
rulesIoK8SApiBatchV1PodFailurePolicyRule[]RequiredA list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed.

IoK8SApimachineryPkgApisMetaV1LabelSelector

PropertyTypeAttributesDescription
matchExpressionsIoK8SApimachineryPkgApisMetaV1LabelSelectorRequirement[]matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabelsIoK8SApimachineryPkgApisMetaV1LabelSelectorMatchLabelsmatchLabels 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.

IoK8SApiBatchV1SuccessPolicy

PropertyTypeAttributesDescription
rulesIoK8SApiBatchV1SuccessPolicyRule[]Requiredrules represents the list of alternative rules for the declaring the Jobs as successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met, the "SucceededCriteriaMet" condition is added, and the lingering pods are removed. The terminal state for such a Job has the "Complete" condition. Additionally, these rules are evaluated in order; Once the Job meets one of the rules, other rules are ignored. At most 20 elements are allowed.

IoK8SApiBatchV1JobCondition

PropertyTypeAttributesDescription
statusstringRequiredStatus of the condition, one of True, False, Unknown.
typestringRequiredType of job condition, Complete or Failed.
lastProbeTimestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
lastTransitionTimestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
messagestringHuman readable message indicating details about last transition.
reasonstring(brief) reason for the condition's last transition.

IoK8SApiBatchV1UncountedTerminatedPods

PropertyTypeAttributesDescription
failedstring[]failed holds UIDs of failed Pods.
succeededstring[]succeeded holds UIDs of succeeded Pods.

IoK8SApiCoreV1PodSpec

PropertyTypeAttributesDescription
containersIoK8SApiCoreV1Container[]RequiredList of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
activeDeadlineSecondsintOptional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
affinityIoK8SApiCoreV1AffinityAffinity is a group of affinity scheduling rules.
automountServiceAccountTokenboolAutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
dnsConfigIoK8SApiCoreV1PodDNSConfigPodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
dnsPolicystringSet DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
enableServiceLinksboolEnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.
ephemeralContainersIoK8SApiCoreV1EphemeralContainer[]List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.
hostAliasesIoK8SApiCoreV1HostAlias[]HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified.
hostIPCboolUse the host's ipc namespace. Optional: Default to false.
hostnamestringSpecifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
hostNetworkboolHost networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
hostPIDboolUse the host's pid namespace. Optional: Default to false.
hostUsersboolUse the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.
imagePullSecretsIoK8SApiCoreV1LocalObjectReference[]ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
initContainersIoK8SApiCoreV1Container[]List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
nodeNamestringNodeName indicates in which node this pod is scheduled. If empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName. Once this field is set, the kubelet for this node becomes responsible for the lifecycle of this pod. This field should not be used to express a desire for the pod to be scheduled on a specific node. https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename
nodeSelectorIoK8SApiCoreV1PodSpecNodeSelectorNodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
osIoK8SApiCoreV1PodOSPodOS defines the OS parameters of a pod.
overheadIoK8SApiCoreV1PodSpecOverheadOverhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md
preemptionPolicystringPreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
priorityintThe priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
priorityClassNamestringIf specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
readinessGatesIoK8SApiCoreV1PodReadinessGate[]If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
resourceClaimsIoK8SApiCoreV1PodResourceClaim[]ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable.
resourcesIoK8SApiCoreV1ResourceRequirementsResourceRequirements describes the compute resource requirements.
restartPolicystringRestart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
runtimeClassNamestringRuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class
schedulerNamestringIf specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
schedulingGatesIoK8SApiCoreV1PodSchedulingGate[]SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod. SchedulingGates can only be set at pod creation time, and be removed only afterwards.
securityContextIoK8SApiCoreV1PodSecurityContextPodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
serviceAccountstringDeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
serviceAccountNamestringServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
setHostnameAsFQDNboolIf true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
shareProcessNamespaceboolShare a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.
subdomainstringIf specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
terminationGracePeriodSecondsintOptional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
tolerationsIoK8SApiCoreV1Toleration[]If specified, the pod's tolerations.
topologySpreadConstraintsIoK8SApiCoreV1TopologySpreadConstraint[]TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
volumesIoK8SApiCoreV1Volume[]List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

IoK8SApiBatchV1PodFailurePolicyRule

PropertyTypeAttributesDescription
actionstringRequiredSpecifies the action taken on a pod failure when the requirements are satisfied. Possible values are: - FailJob: indicates that the pod's job is marked as Failed and all running pods are terminated. - FailIndex: indicates that the pod's index is marked as Failed and will not be restarted. - Ignore: indicates that the counter towards the .backoffLimit is not incremented and a replacement pod is created. - Count: indicates that the pod is handled in the default way - the counter towards the .backoffLimit is incremented. Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule.
onExitCodesIoK8SApiBatchV1PodFailurePolicyOnExitCodesRequirementPodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .state.terminated.exitCode for each app container and init container status, represented by the .status.containerStatuses and .status.initContainerStatuses fields in the Pod status, respectively. Containers completed with success (exit code 0) are excluded from the requirement check.
onPodConditionsIoK8SApiBatchV1PodFailurePolicyOnPodConditionsPattern[]Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed.

IoK8SApimachineryPkgApisMetaV1LabelSelectorRequirement

PropertyTypeAttributesDescription
keystringRequiredkey is the label key that the selector applies to.
operatorstringRequiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
valuesstring[]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.

IoK8SApimachineryPkgApisMetaV1LabelSelectorMatchLabels

Additional properties of type string are allowed.

IoK8SApiBatchV1SuccessPolicyRule

PropertyTypeAttributesDescription
succeededCountintsucceededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job. When succeededCount is used along with succeededIndexes, the check is constrained only to the set of indexes specified by succeededIndexes. For example, given that succeededIndexes is "1-4", succeededCount is "3", and completed indexes are "1", "3", and "5", the Job isn't declared as succeeded because only "1" and "3" indexes are considered in that rules. When this field is null, this doesn't default to any value and is never evaluated at any time. When specified it needs to be a positive integer.
succeededIndexesstringsucceededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job. The list of indexes must be within 0 to ".spec.completions-1" and must not contain duplicates. At least one element is required. The indexes are represented as intervals separated by commas. The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen. The number are listed in represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". When this field is null, this field doesn't default to any value and is never evaluated at any time.

IoK8SApiCoreV1Container

PropertyTypeAttributesDescription
namestringRequiredName of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
argsstring[]Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
commandstring[]Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
envIoK8SApiCoreV1EnvVar[]List of environment variables to set in the container. Cannot be updated.
envFromIoK8SApiCoreV1EnvFromSource[]List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
imagestringContainer image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
imagePullPolicystringImage 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
lifecycleIoK8SApiCoreV1LifecycleLifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
livenessProbeIoK8SApiCoreV1ProbeProbe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
portsIoK8SApiCoreV1ContainerPort[]List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
readinessProbeIoK8SApiCoreV1ProbeProbe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
resizePolicyIoK8SApiCoreV1ContainerResizePolicy[]Resources resize policy for the container.
resourcesIoK8SApiCoreV1ResourceRequirementsResourceRequirements describes the compute resource requirements.
restartPolicystringRestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
securityContextIoK8SApiCoreV1SecurityContextSecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
startupProbeIoK8SApiCoreV1ProbeProbe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
stdinboolWhether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
stdinOnceboolWhether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
terminationMessagePathstringOptional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
terminationMessagePolicystringIndicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
ttyboolWhether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevicesIoK8SApiCoreV1VolumeDevice[]volumeDevices is the list of block devices to be used by the container.
volumeMountsIoK8SApiCoreV1VolumeMount[]Pod volumes to mount into the container's filesystem. Cannot be updated.
workingDirstringContainer's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

IoK8SApiCoreV1Affinity

PropertyTypeAttributesDescription
nodeAffinityIoK8SApiCoreV1NodeAffinityNode affinity is a group of node affinity scheduling rules.
podAffinityIoK8SApiCoreV1PodAffinityPod affinity is a group of inter pod affinity scheduling rules.
podAntiAffinityIoK8SApiCoreV1PodAntiAffinityPod anti affinity is a group of inter pod anti affinity scheduling rules.

IoK8SApiCoreV1PodDNSConfig

PropertyTypeAttributesDescription
nameserversstring[]A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
optionsIoK8SApiCoreV1PodDNSConfigOption[]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.
searchesstring[]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.

IoK8SApiCoreV1EphemeralContainer

PropertyTypeAttributesDescription
namestringRequiredName of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
argsstring[]Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
commandstring[]Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
envIoK8SApiCoreV1EnvVar[]List of environment variables to set in the container. Cannot be updated.
envFromIoK8SApiCoreV1EnvFromSource[]List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
imagestringContainer image name. More info: https://kubernetes.io/docs/concepts/containers/images
imagePullPolicystringImage 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
lifecycleIoK8SApiCoreV1LifecycleLifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
livenessProbeIoK8SApiCoreV1ProbeProbe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
portsIoK8SApiCoreV1ContainerPort[]Ports are not allowed for ephemeral containers.
readinessProbeIoK8SApiCoreV1ProbeProbe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
resizePolicyIoK8SApiCoreV1ContainerResizePolicy[]Resources resize policy for the container.
resourcesIoK8SApiCoreV1ResourceRequirementsResourceRequirements describes the compute resource requirements.
restartPolicystringRestart policy for the container to manage the restart behavior of each container within a pod. This may only be set for init containers. You cannot set this field on ephemeral containers.
securityContextIoK8SApiCoreV1SecurityContextSecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
startupProbeIoK8SApiCoreV1ProbeProbe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
stdinboolWhether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
stdinOnceboolWhether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
targetContainerNamestringIf set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.
terminationMessagePathstringOptional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
terminationMessagePolicystringIndicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
ttyboolWhether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevicesIoK8SApiCoreV1VolumeDevice[]volumeDevices is the list of block devices to be used by the container.
volumeMountsIoK8SApiCoreV1VolumeMount[]Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.
workingDirstringContainer's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

IoK8SApiCoreV1HostAlias

PropertyTypeAttributesDescription
ipstringRequiredIP address of the host file entry.
hostnamesstring[]Hostnames for the above IP address.

IoK8SApiCoreV1LocalObjectReference

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

IoK8SApiCoreV1PodSpecNodeSelector

Additional properties of type string are allowed.

IoK8SApiCoreV1PodOS

PropertyTypeAttributesDescription
namestringRequiredName is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null

IoK8SApiCoreV1PodSpecOverhead

Additional properties of type string are allowed.

IoK8SApiCoreV1PodReadinessGate

PropertyTypeAttributesDescription
conditionTypestringRequiredConditionType refers to a condition in the pod's condition list with matching type.

IoK8SApiCoreV1PodResourceClaim

PropertyTypeAttributesDescription
namestringRequiredName uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL.
resourceClaimNamestringResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
resourceClaimTemplateNamestringResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod. The template will be used to create a new ResourceClaim, which will be bound to this pod. When this pod is deleted, the ResourceClaim will also be deleted. The pod name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses. This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.

IoK8SApiCoreV1ResourceRequirements

PropertyTypeAttributesDescription
claimsIoK8SApiCoreV1ResourceClaim[]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.
limitsIoK8SApiCoreV1ResourceRequirementsLimitsLimits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requestsIoK8SApiCoreV1ResourceRequirementsRequestsRequests 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/

IoK8SApiCoreV1PodSchedulingGate

PropertyTypeAttributesDescription
namestringRequiredName of the scheduling gate. Each scheduling gate must have a unique name field.

IoK8SApiCoreV1PodSecurityContext

PropertyTypeAttributesDescription
appArmorProfileIoK8SApiCoreV1AppArmorProfileAppArmorProfile defines a pod or container's AppArmor settings.
fsGroupintA special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.
fsGroupChangePolicystringfsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.
runAsGroupintThe GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
runAsNonRootboolIndicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUserintThe UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
seccompProfileIoK8SApiCoreV1SeccompProfileSeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
seLinuxChangePolicystringseLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are "MountOption" and "Recursive". "Recursive" means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node. "MountOption" mounts all eligible Pod volumes with `-o context` mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. "MountOption" value is allowed only when SELinuxMount feature gate is enabled. If not specified and SELinuxMount feature gate is enabled, "MountOption" is used. If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes and "Recursive" for all other volumes. This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers. All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows.
seLinuxOptionsIoK8SApiCoreV1SELinuxOptionsSELinuxOptions are the labels to be applied to the container
supplementalGroupsint[]A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows.
supplementalGroupsPolicystringDefines how supplemental groups of the first container processes are calculated. Valid values are "Merge" and "Strict". If not specified, "Merge" is used. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature. Note that this field cannot be set when spec.os.name is windows.
sysctlsIoK8SApiCoreV1Sysctl[]Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
windowsOptionsIoK8SApiCoreV1WindowsSecurityContextOptionsWindowsSecurityContextOptions contain Windows-specific options and credentials.

IoK8SApiCoreV1Toleration

PropertyTypeAttributesDescription
effectstringEffect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
keystringKey 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.
operatorstringOperator 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.
tolerationSecondsintTolerationSeconds 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.
valuestringValue is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

IoK8SApiCoreV1TopologySpreadConstraint

PropertyTypeAttributesDescription
maxSkewintRequiredMaxSkew 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.
topologyKeystringRequiredTopologyKey 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.
whenUnsatisfiablestringRequiredWhenUnsatisfiable 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.
labelSelectorIoK8SApimachineryPkgApisMetaV1LabelSelectorA label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
matchLabelKeysstring[]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).
minDomainsintMinDomains 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.
nodeAffinityPolicystringNodeAffinityPolicy 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.
nodeTaintsPolicystringNodeTaintsPolicy 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.

IoK8SApiCoreV1Volume

PropertyTypeAttributesDescription
namestringRequiredname of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
awsElasticBlockStoreIoK8SApiCoreV1AWSElasticBlockStoreVolumeSourceRepresents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
azureDiskIoK8SApiCoreV1AzureDiskVolumeSourceAzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureFileIoK8SApiCoreV1AzureFileVolumeSourceAzureFile represents an Azure File Service mount on the host and bind mount to the pod.
cephfsIoK8SApiCoreV1CephFSVolumeSourceRepresents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
cinderIoK8SApiCoreV1CinderVolumeSourceRepresents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
configMapIoK8SApiCoreV1ConfigMapVolumeSourceAdapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
csiIoK8SApiCoreV1CSIVolumeSourceRepresents a source location of a volume to mount, managed by an external CSI driver
downwardAPIIoK8SApiCoreV1DownwardAPIVolumeSourceDownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
emptyDirIoK8SApiCoreV1EmptyDirVolumeSourceRepresents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
ephemeralIoK8SApiCoreV1EphemeralVolumeSourceRepresents an ephemeral volume that is handled by a normal storage driver.
fcIoK8SApiCoreV1FCVolumeSourceRepresents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
flexVolumeIoK8SApiCoreV1FlexVolumeSourceFlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
flockerIoK8SApiCoreV1FlockerVolumeSourceRepresents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
gcePersistentDiskIoK8SApiCoreV1GCEPersistentDiskVolumeSourceRepresents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
gitRepoIoK8SApiCoreV1GitRepoVolumeSourceRepresents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
glusterfsIoK8SApiCoreV1GlusterfsVolumeSourceRepresents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
hostPathIoK8SApiCoreV1HostPathVolumeSourceRepresents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
imageIoK8SApiCoreV1ImageVolumeSourceImageVolumeSource represents a image volume resource.
iscsiIoK8SApiCoreV1IscsiVolumeSourceRepresents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
nfsIoK8SApiCoreV1NFSVolumeSourceRepresents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
persistentVolumeClaimIoK8SApiCoreV1PersistentVolumeClaimVolumeSourcePersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
photonPersistentDiskIoK8SApiCoreV1PhotonPersistentDiskVolumeSourceRepresents a Photon Controller persistent disk resource.
portworxVolumeIoK8SApiCoreV1PortworxVolumeSourcePortworxVolumeSource represents a Portworx volume resource.
projectedIoK8SApiCoreV1ProjectedVolumeSourceRepresents a projected volume source
quobyteIoK8SApiCoreV1QuobyteVolumeSourceRepresents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
rbdIoK8SApiCoreV1RBDVolumeSourceRepresents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
scaleIOIoK8SApiCoreV1ScaleIOVolumeSourceScaleIOVolumeSource represents a persistent ScaleIO volume
secretIoK8SApiCoreV1SecretVolumeSourceAdapts a Secret into a volume. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
storageosIoK8SApiCoreV1StorageOSVolumeSourceRepresents a StorageOS persistent volume resource.
vsphereVolumeIoK8SApiCoreV1VsphereVirtualDiskVolumeSourceRepresents a vSphere volume resource.

IoK8SApiBatchV1PodFailurePolicyOnExitCodesRequirement

PropertyTypeAttributesDescription
operatorstringRequiredRepresents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are: - In: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the 'containerName' field) is in the set of specified values. - NotIn: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the 'containerName' field) is not in the set of specified values. Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied.
valuesint[]RequiredSpecifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value '0' cannot be used for the In operator. At least one element is required. At most 255 elements are allowed.
containerNamestringRestricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template.

IoK8SApiBatchV1PodFailurePolicyOnPodConditionsPattern

PropertyTypeAttributesDescription
statusstringRequiredSpecifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True.
typestringRequiredSpecifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type.

IoK8SApiCoreV1EnvVar

PropertyTypeAttributesDescription
namestringRequiredName of the environment variable. Must be a C_IDENTIFIER.
valuestringVariable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
valueFromIoK8SApiCoreV1EnvVarSourceEnvVarSource represents a source for the value of an EnvVar.

IoK8SApiCoreV1EnvFromSource

PropertyTypeAttributesDescription
configMapRefIoK8SApiCoreV1ConfigMapEnvSourceConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
prefixstringOptional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.
secretRefIoK8SApiCoreV1SecretEnvSourceSecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

IoK8SApiCoreV1Lifecycle

PropertyTypeAttributesDescription
postStartIoK8SApiCoreV1LifecycleHandlerLifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.
preStopIoK8SApiCoreV1LifecycleHandlerLifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.
stopSignalstringStopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name

IoK8SApiCoreV1Probe

PropertyTypeAttributesDescription
execIoK8SApiCoreV1ExecActionExecAction describes a "run in container" action.
failureThresholdintMinimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpcIoK8SApiCoreV1GrpcActionGRPCAction specifies an action involving a GRPC service.
httpGetIoK8SApiCoreV1HttpGetActionHTTPGetAction describes an action based on HTTP Get requests.
initialDelaySecondsintNumber of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
periodSecondsintHow often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
successThresholdintMinimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
tcpSocketIoK8SApiCoreV1TCPSocketActionTCPSocketAction describes an action based on opening a socket
terminationGracePeriodSecondsintOptional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
timeoutSecondsintNumber of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

IoK8SApiCoreV1ContainerPort

PropertyTypeAttributesDescription
containerPortintRequiredNumber of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
hostIPstringWhat host IP to bind the external port to.
hostPortintNumber of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
namestringIf specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocolstringProtocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

IoK8SApiCoreV1ContainerResizePolicy

PropertyTypeAttributesDescription
resourceNamestringRequiredName of the resource to which this resource resize policy applies. Supported values: cpu, memory.
restartPolicystringRequiredRestart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

IoK8SApiCoreV1SecurityContext

PropertyTypeAttributesDescription
allowPrivilegeEscalationboolAllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
appArmorProfileIoK8SApiCoreV1AppArmorProfileAppArmorProfile defines a pod or container's AppArmor settings.
capabilitiesIoK8SApiCoreV1CapabilitiesAdds and removes POSIX capabilities from running containers.
privilegedboolRun container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
procMountstringprocMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
readOnlyRootFilesystemboolWhether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
runAsGroupintThe GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
runAsNonRootboolIndicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUserintThe UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
seccompProfileIoK8SApiCoreV1SeccompProfileSeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
seLinuxOptionsIoK8SApiCoreV1SELinuxOptionsSELinuxOptions are the labels to be applied to the container
windowsOptionsIoK8SApiCoreV1WindowsSecurityContextOptionsWindowsSecurityContextOptions contain Windows-specific options and credentials.

IoK8SApiCoreV1VolumeDevice

PropertyTypeAttributesDescription
devicePathstringRequireddevicePath is the path inside of the container that the device will be mapped to.
namestringRequiredname must match the name of a persistentVolumeClaim in the pod

IoK8SApiCoreV1VolumeMount

PropertyTypeAttributesDescription
mountPathstringRequiredPath within the container at which the volume should be mounted. Must not contain ':'.
namestringRequiredThis must match the Name of a Volume.
mountPropagationstringmountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
readOnlyboolMounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
recursiveReadOnlystringRecursiveReadOnly specifies whether read-only mounts should be handled recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled.
subPathstringPath within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
subPathExprstringExpanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

IoK8SApiCoreV1NodeAffinity

PropertyTypeAttributesDescription
preferredDuringSchedulingIgnoredDuringExecutionIoK8SApiCoreV1PreferredSchedulingTerm[]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.
requiredDuringSchedulingIgnoredDuringExecutionIoK8SApiCoreV1NodeSelectorA node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

IoK8SApiCoreV1PodAffinity

PropertyTypeAttributesDescription
preferredDuringSchedulingIgnoredDuringExecutionIoK8SApiCoreV1WeightedPodAffinityTerm[]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.
requiredDuringSchedulingIgnoredDuringExecutionIoK8SApiCoreV1PodAffinityTerm[]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.

IoK8SApiCoreV1PodAntiAffinity

PropertyTypeAttributesDescription
preferredDuringSchedulingIgnoredDuringExecutionIoK8SApiCoreV1WeightedPodAffinityTerm[]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.
requiredDuringSchedulingIgnoredDuringExecutionIoK8SApiCoreV1PodAffinityTerm[]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.

IoK8SApiCoreV1PodDNSConfigOption

PropertyTypeAttributesDescription
namestringName is this DNS resolver option's name. Required.
valuestringValue is this DNS resolver option's value.

IoK8SApiCoreV1ResourceClaim

PropertyTypeAttributesDescription
namestringRequiredName 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.
requeststringRequest is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

IoK8SApiCoreV1ResourceRequirementsLimits

Additional properties of type string are allowed.

IoK8SApiCoreV1ResourceRequirementsRequests

Additional properties of type string are allowed.

IoK8SApiCoreV1AppArmorProfile

PropertyTypeAttributesDescription
typestringRequiredtype indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.
localhostProfilestringlocalhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".

IoK8SApiCoreV1SeccompProfile

PropertyTypeAttributesDescription
typestringRequiredtype indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
localhostProfilestringlocalhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.

IoK8SApiCoreV1SELinuxOptions

PropertyTypeAttributesDescription
levelstringLevel is SELinux level label that applies to the container.
rolestringRole is a SELinux role label that applies to the container.
typestringType is a SELinux type label that applies to the container.
userstringUser is a SELinux user label that applies to the container.

IoK8SApiCoreV1Sysctl

PropertyTypeAttributesDescription
namestringRequiredName of a property to set
valuestringRequiredValue of a property to set

IoK8SApiCoreV1WindowsSecurityContextOptions

PropertyTypeAttributesDescription
gmsaCredentialSpecstringGMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
gmsaCredentialSpecNamestringGMSACredentialSpecName is the name of the GMSA credential spec to use.
hostProcessboolHostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
runAsUserNamestringThe UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

IoK8SApiCoreV1AWSElasticBlockStoreVolumeSource

PropertyTypeAttributesDescription
volumeIDstringRequiredvolumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
fsTypestringfsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
partitionintpartition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
readOnlyboolreadOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

IoK8SApiCoreV1AzureDiskVolumeSource

PropertyTypeAttributesDescription
diskNamestringRequireddiskName is the Name of the data disk in the blob storage
diskURIstringRequireddiskURI is the URI of data disk in the blob storage
cachingModestringcachingMode is the Host Caching mode: None, Read Only, Read Write.
fsTypestringfsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
kindstringkind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
readOnlyboolreadOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

IoK8SApiCoreV1AzureFileVolumeSource

PropertyTypeAttributesDescription
secretNamestringRequiredsecretName is the name of secret that contains Azure Storage Account Name and Key
shareNamestringRequiredshareName is the azure share Name
readOnlyboolreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

IoK8SApiCoreV1CephFSVolumeSource

PropertyTypeAttributesDescription
monitorsstring[]Requiredmonitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
pathstringpath is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnlyboolreadOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretFilestringsecretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretRefIoK8SApiCoreV1LocalObjectReferenceLocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
userstringuser is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

IoK8SApiCoreV1CinderVolumeSource

PropertyTypeAttributesDescription
volumeIDstringRequiredvolumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
readOnlyboolreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
secretRefIoK8SApiCoreV1LocalObjectReferenceLocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

IoK8SApiCoreV1ConfigMapVolumeSource

PropertyTypeAttributesDescription
defaultModeintdefaultMode is optional: mode bits used to set permissions on created files by default. 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. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
itemsIoK8SApiCoreV1KeyToPath[]items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
namestringName 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
optionalbooloptional specify whether the ConfigMap or its keys must be defined

IoK8SApiCoreV1CSIVolumeSource

PropertyTypeAttributesDescription
driverstringRequireddriver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
fsTypestringfsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
nodePublishSecretRefIoK8SApiCoreV1LocalObjectReferenceLocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
readOnlyboolreadOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
volumeAttributesIoK8SApiCoreV1CSIVolumeSourceVolumeAttributesvolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

IoK8SApiCoreV1DownwardAPIVolumeSource

PropertyTypeAttributesDescription
defaultModeintOptional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. 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. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
itemsIoK8SApiCoreV1DownwardAPIVolumeFile[]Items is a list of downward API volume file

IoK8SApiCoreV1EmptyDirVolumeSource

PropertyTypeAttributesDescription
mediumstringmedium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
sizeLimitstringQuantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` <quantity> ::= <signedNumber><suffix> (Note that <suffix> may be empty, from the "" case in <decimalSI>.) <digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) <decimalSI> ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) <decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

IoK8SApiCoreV1EphemeralVolumeSource

PropertyTypeAttributesDescription
volumeClaimTemplateIoK8SApiCoreV1PersistentVolumeClaimTemplatePersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.

IoK8SApiCoreV1FCVolumeSource

PropertyTypeAttributesDescription
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
lunintlun is Optional: FC target lun number
readOnlyboolreadOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNsstring[]targetWWNs is Optional: FC target worldwide names (WWNs)
wwidsstring[]wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

IoK8SApiCoreV1FlexVolumeSource

PropertyTypeAttributesDescription
driverstringRequireddriver is the name of the driver to use for this volume.
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
optionsIoK8SApiCoreV1FlexVolumeSourceOptionsoptions is Optional: this field holds extra command options if any.
readOnlyboolreadOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRefIoK8SApiCoreV1LocalObjectReferenceLocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

IoK8SApiCoreV1FlockerVolumeSource

PropertyTypeAttributesDescription
datasetNamestringdatasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
datasetUUIDstringdatasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

IoK8SApiCoreV1GCEPersistentDiskVolumeSource

PropertyTypeAttributesDescription
pdNamestringRequiredpdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
fsTypestringfsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
partitionintpartition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnlyboolreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

IoK8SApiCoreV1GitRepoVolumeSource

PropertyTypeAttributesDescription
repositorystringRequiredrepository is the URL
directorystringdirectory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
revisionstringrevision is the commit hash for the specified revision.

IoK8SApiCoreV1GlusterfsVolumeSource

PropertyTypeAttributesDescription
endpointsstringRequiredendpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
pathstringRequiredpath is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnlyboolreadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

IoK8SApiCoreV1HostPathVolumeSource

PropertyTypeAttributesDescription
pathstringRequiredpath of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
typestringtype for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

IoK8SApiCoreV1ImageVolumeSource

PropertyTypeAttributesDescription
pullPolicystringPolicy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
referencestringRequired: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

IoK8SApiCoreV1IscsiVolumeSource

PropertyTypeAttributesDescription
iqnstringRequirediqn is the target iSCSI Qualified Name.
lunintRequiredlun represents iSCSI Target Lun number.
targetPortalstringRequiredtargetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
chapAuthDiscoveryboolchapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
chapAuthSessionboolchapAuthSession defines whether support iSCSI Session CHAP authentication
fsTypestringfsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorNamestringinitiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
iscsiInterfacestringiscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
portalsstring[]portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
readOnlyboolreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secretRefIoK8SApiCoreV1LocalObjectReferenceLocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

IoK8SApiCoreV1NFSVolumeSource

PropertyTypeAttributesDescription
pathstringRequiredpath that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
serverstringRequiredserver is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnlyboolreadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

IoK8SApiCoreV1PersistentVolumeClaimVolumeSource

PropertyTypeAttributesDescription
claimNamestringRequiredclaimName 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
readOnlyboolreadOnly Will force the ReadOnly setting in VolumeMounts. Default false.

IoK8SApiCoreV1PhotonPersistentDiskVolumeSource

PropertyTypeAttributesDescription
pdIDstringRequiredpdID is the ID that identifies Photon Controller persistent disk
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

IoK8SApiCoreV1PortworxVolumeSource

PropertyTypeAttributesDescription
volumeIDstringRequiredvolumeID uniquely identifies a Portworx volume
fsTypestringfSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
readOnlyboolreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

IoK8SApiCoreV1ProjectedVolumeSource

PropertyTypeAttributesDescription
defaultModeintdefaultMode are the mode bits used to set permissions on created files by default. 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. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
sourcesIoK8SApiCoreV1VolumeProjection[]sources is the list of volume projections. Each entry in this list handles one source.

IoK8SApiCoreV1QuobyteVolumeSource

PropertyTypeAttributesDescription
registrystringRequiredregistry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
volumestringRequiredvolume is a string that references an already created Quobyte volume by name.
groupstringgroup to map volume access to Default is no group
readOnlyboolreadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
tenantstringtenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
userstringuser to map volume access to Defaults to serivceaccount user

IoK8SApiCoreV1RBDVolumeSource

PropertyTypeAttributesDescription
imagestringRequiredimage is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
monitorsstring[]Requiredmonitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
fsTypestringfsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
keyringstringkeyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
poolstringpool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
readOnlyboolreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
secretRefIoK8SApiCoreV1LocalObjectReferenceLocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
userstringuser is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

IoK8SApiCoreV1ScaleIOVolumeSource

PropertyTypeAttributesDescription
gatewaystringRequiredgateway is the host address of the ScaleIO API Gateway.
secretRefIoK8SApiCoreV1LocalObjectReferenceRequiredLocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
systemstringRequiredsystem is the name of the storage system as configured in ScaleIO.
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
protectionDomainstringprotectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
readOnlyboolreadOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
sslEnabledboolsslEnabled Flag enable/disable SSL communication with Gateway, default false
storageModestringstorageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storagePoolstringstoragePool is the ScaleIO Storage Pool associated with the protection domain.
volumeNamestringvolumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

IoK8SApiCoreV1SecretVolumeSource

PropertyTypeAttributesDescription
defaultModeintdefaultMode is Optional: mode bits used to set permissions on created files by default. 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. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
itemsIoK8SApiCoreV1KeyToPath[]items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
optionalbooloptional field specify whether the Secret or its keys must be defined
secretNamestringsecretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

IoK8SApiCoreV1StorageOSVolumeSource

PropertyTypeAttributesDescription
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
readOnlyboolreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRefIoK8SApiCoreV1LocalObjectReferenceLocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
volumeNamestringvolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespacestringvolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

IoK8SApiCoreV1VsphereVirtualDiskVolumeSource

PropertyTypeAttributesDescription
volumePathstringRequiredvolumePath is the path that identifies vSphere volume vmdk
fsTypestringfsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
storagePolicyIDstringstoragePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyNamestringstoragePolicyName is the storage Policy Based Management (SPBM) profile name.

IoK8SApiCoreV1EnvVarSource

PropertyTypeAttributesDescription
configMapKeyRefIoK8SApiCoreV1ConfigMapKeySelectorSelects a key from a ConfigMap.
fieldRefIoK8SApiCoreV1ObjectFieldSelectorObjectFieldSelector selects an APIVersioned field of an object.
resourceFieldRefIoK8SApiCoreV1ResourceFieldSelectorResourceFieldSelector represents container resources (cpu, memory) and their output format
secretKeyRefIoK8SApiCoreV1SecretKeySelectorSecretKeySelector selects a key of a Secret.

IoK8SApiCoreV1ConfigMapEnvSource

PropertyTypeAttributesDescription
namestringName 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
optionalboolSpecify whether the ConfigMap must be defined

IoK8SApiCoreV1SecretEnvSource

PropertyTypeAttributesDescription
namestringName 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
optionalboolSpecify whether the Secret must be defined

IoK8SApiCoreV1LifecycleHandler

PropertyTypeAttributesDescription
execIoK8SApiCoreV1ExecActionExecAction describes a "run in container" action.
httpGetIoK8SApiCoreV1HttpGetActionHTTPGetAction describes an action based on HTTP Get requests.
sleepIoK8SApiCoreV1SleepActionSleepAction describes a "sleep" action.
tcpSocketIoK8SApiCoreV1TCPSocketActionTCPSocketAction describes an action based on opening a socket

IoK8SApiCoreV1ExecAction

PropertyTypeAttributesDescription
commandstring[]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.

IoK8SApiCoreV1GrpcAction

PropertyTypeAttributesDescription
portintRequiredPort number of the gRPC service. Number must be in the range 1 to 65535.
servicestringService is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

IoK8SApiCoreV1HttpGetAction

PropertyTypeAttributesDescription
portstringRequiredIntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.
hoststringHost name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
httpHeadersIoK8SApiCoreV1HttpHeader[]Custom headers to set in the request. HTTP allows repeated headers.
pathstringPath to access on the HTTP server.
schemestringScheme to use for connecting to the host. Defaults to HTTP.

IoK8SApiCoreV1TCPSocketAction

PropertyTypeAttributesDescription
portstringRequiredIntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.
hoststringOptional: Host name to connect to, defaults to the pod IP.

IoK8SApiCoreV1Capabilities

PropertyTypeAttributesDescription
addstring[]Added capabilities
dropstring[]Removed capabilities

IoK8SApiCoreV1PreferredSchedulingTerm

PropertyTypeAttributesDescription
preferenceIoK8SApiCoreV1NodeSelectorTermRequiredA null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
weightintRequiredWeight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

IoK8SApiCoreV1NodeSelector

PropertyTypeAttributesDescription
nodeSelectorTermsIoK8SApiCoreV1NodeSelectorTerm[]RequiredRequired. A list of node selector terms. The terms are ORed.

IoK8SApiCoreV1WeightedPodAffinityTerm

PropertyTypeAttributesDescription
podAffinityTermIoK8SApiCoreV1PodAffinityTermRequiredDefines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
weightintRequiredweight associated with matching the corresponding podAffinityTerm, in the range 1-100.

IoK8SApiCoreV1PodAffinityTerm

PropertyTypeAttributesDescription
topologyKeystringRequiredThis 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.
labelSelectorIoK8SApimachineryPkgApisMetaV1LabelSelectorA label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
matchLabelKeysstring[]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.
mismatchLabelKeysstring[]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.
namespacesstring[]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".
namespaceSelectorIoK8SApimachineryPkgApisMetaV1LabelSelectorA label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

IoK8SApiCoreV1KeyToPath

PropertyTypeAttributesDescription
keystringRequiredkey is the key to project.
pathstringRequiredpath is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
modeintmode is 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.

IoK8SApiCoreV1CSIVolumeSourceVolumeAttributes

Additional properties of type string are allowed.

IoK8SApiCoreV1DownwardAPIVolumeFile

PropertyTypeAttributesDescription
pathstringRequiredRequired: 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 '..'
fieldRefIoK8SApiCoreV1ObjectFieldSelectorObjectFieldSelector selects an APIVersioned field of an object.
modeintOptional: 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.
resourceFieldRefIoK8SApiCoreV1ResourceFieldSelectorResourceFieldSelector represents container resources (cpu, memory) and their output format

IoK8SApiCoreV1PersistentVolumeClaimTemplate

PropertyTypeAttributesDescription
specIoK8SApiCoreV1PersistentVolumeClaimSpecRequiredPersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
metadataIoK8SApimachineryPkgApisMetaV1ObjectMetaObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

IoK8SApiCoreV1FlexVolumeSourceOptions

Additional properties of type string are allowed.

IoK8SApiCoreV1VolumeProjection

PropertyTypeAttributesDescription
clusterTrustBundleIoK8SApiCoreV1ClusterTrustBundleProjectionClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.
configMapIoK8SApiCoreV1ConfigMapProjectionAdapts a ConfigMap into a projected volume. The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.
downwardAPIIoK8SApiCoreV1DownwardAPIProjectionRepresents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.
secretIoK8SApiCoreV1SecretProjectionAdapts a secret into a projected volume. The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.
serviceAccountTokenIoK8SApiCoreV1ServiceAccountTokenProjectionServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).

IoK8SApiCoreV1ConfigMapKeySelector

PropertyTypeAttributesDescription
keystringRequiredThe key to select.
namestringName 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
optionalboolSpecify whether the ConfigMap or its key must be defined

IoK8SApiCoreV1ObjectFieldSelector

PropertyTypeAttributesDescription
fieldPathstringRequiredPath of the field to select in the specified API version.
apiVersionstringVersion of the schema the FieldPath is written in terms of, defaults to "v1".

IoK8SApiCoreV1ResourceFieldSelector

PropertyTypeAttributesDescription
resourcestringRequiredRequired: resource to select
containerNamestringContainer name: required for volumes, optional for env vars
divisorstringQuantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` <quantity> ::= <signedNumber><suffix> (Note that <suffix> may be empty, from the "" case in <decimalSI>.) <digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) <decimalSI> ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) <decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

IoK8SApiCoreV1SecretKeySelector

PropertyTypeAttributesDescription
keystringRequiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalboolSpecify whether the Secret or its key must be defined

IoK8SApiCoreV1SleepAction

PropertyTypeAttributesDescription
secondsintRequiredSeconds is the number of seconds to sleep.

IoK8SApiCoreV1HttpHeader

PropertyTypeAttributesDescription
namestringRequiredThe header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
valuestringRequiredThe header field value

IoK8SApiCoreV1NodeSelectorTerm

PropertyTypeAttributesDescription
matchExpressionsIoK8SApiCoreV1NodeSelectorRequirement[]A list of node selector requirements by node's labels.
matchFieldsIoK8SApiCoreV1NodeSelectorRequirement[]A list of node selector requirements by node's fields.

IoK8SApiCoreV1PersistentVolumeClaimSpec

PropertyTypeAttributesDescription
accessModesstring[]accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSourceIoK8SApiCoreV1TypedLocalObjectReferenceTypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
dataSourceRefIoK8SApiCoreV1TypedObjectReferenceTypedObjectReference contains enough information to let you locate the typed referenced object
resourcesIoK8SApiCoreV1VolumeResourceRequirementsVolumeResourceRequirements describes the storage resource requirements for a volume.
selectorIoK8SApimachineryPkgApisMetaV1LabelSelectorA label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
storageClassNamestringstorageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeAttributesClassNamestringvolumeAttributesClassName 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).
volumeModestringvolumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeNamestringvolumeName is the binding reference to the PersistentVolume backing this claim.

IoK8SApiCoreV1ClusterTrustBundleProjection

PropertyTypeAttributesDescription
pathstringRequiredRelative path from the volume root to write the bundle.
labelSelectorIoK8SApimachineryPkgApisMetaV1LabelSelectorA label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
namestringSelect a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
optionalboolIf true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.
signerNamestringSelect all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

IoK8SApiCoreV1ConfigMapProjection

PropertyTypeAttributesDescription
itemsIoK8SApiCoreV1KeyToPath[]items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
namestringName 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
optionalbooloptional specify whether the ConfigMap or its keys must be defined

IoK8SApiCoreV1DownwardAPIProjection

PropertyTypeAttributesDescription
itemsIoK8SApiCoreV1DownwardAPIVolumeFile[]Items is a list of DownwardAPIVolume file

IoK8SApiCoreV1SecretProjection

PropertyTypeAttributesDescription
itemsIoK8SApiCoreV1KeyToPath[]items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
namestringName 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
optionalbooloptional field specify whether the Secret or its key must be defined

IoK8SApiCoreV1ServiceAccountTokenProjection

PropertyTypeAttributesDescription
pathstringRequiredpath is the path relative to the mount point of the file to project the token into.
audiencestringaudience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSecondsintexpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

IoK8SApiCoreV1NodeSelectorRequirement

PropertyTypeAttributesDescription
keystringRequiredThe label key that the selector applies to.
operatorstringRequiredRepresents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
valuesstring[]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.

IoK8SApiCoreV1TypedLocalObjectReference

PropertyTypeAttributesDescription
kindstringRequiredKind is the type of resource being referenced
namestringRequiredName is the name of resource being referenced
apiGroupstringAPIGroup 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.

IoK8SApiCoreV1TypedObjectReference

PropertyTypeAttributesDescription
kindstringRequiredKind is the type of resource being referenced
namestringRequiredName is the name of resource being referenced
apiGroupstringAPIGroup 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.
namespacestringNamespace 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.

IoK8SApiCoreV1VolumeResourceRequirements

PropertyTypeAttributesDescription
limitsIoK8SApiCoreV1VolumeResourceRequirementsLimitsLimits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requestsIoK8SApiCoreV1VolumeResourceRequirementsRequestsRequests 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/

IoK8SApiCoreV1VolumeResourceRequirementsLimits

Additional properties of type string are allowed.

IoK8SApiCoreV1VolumeResourceRequirementsRequests

Additional properties of type string are allowed.