This product is not supported for your selected
Datadog site. (
).
이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우
언제든지 연락주시기 바랍니다.gcp_k8s_stateful_set
ancestors
Type: UNORDERED_LIST_STRING
api_version
Type: STRING
Provider name: apiVersion
Description: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
gcp_status
Type: STRUCT
Provider name: status
Description: Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
available_replicas
Type: INT32
Provider name: availableReplicas
Description: Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset.
collision_count
Type: INT32
Provider name: collisionCount
Description: collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
Type: UNORDERED_LIST_STRUCT
Provider name: conditions
Description: Represents the latest available observations of a statefulset’s current state.
gcp_status
Type: STRING
Provider name: status
Description: Status of the condition, one of True, False, Unknown.
last_transition_time
Type: TIMESTAMP
Provider name: lastTransitionTime
Description: Last time the condition transitioned from one status to another.
message
Type: STRING
Provider name: message
Description: A human readable message indicating details about the transition.
reason
Type: STRING
Provider name: reason
Description: The reason for the condition’s last transition.
type
Type: STRING
Provider name: type
Description: Type of statefulset condition.
current_replicas
Type: INT32
Provider name: currentReplicas
Description: currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
current_revision
Type: STRING
Provider name: currentRevision
Description: currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
observed_generation
Type: INT64
Provider name: observedGeneration
Description: observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet’s generation, which is updated on mutation by the API Server.
ready_replicas
Type: INT32
Provider name: readyReplicas
Description: readyReplicas is the number of pods created for this StatefulSet with a Ready Condition.
replicas
Type: INT32
Provider name: replicas
Description: replicas is the number of Pods created by the StatefulSet controller.
update_revision
Type: STRING
Provider name: updateRevision
Description: updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
updated_replicas
Type: INT32
Provider name: updatedReplicas
Description: updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
kind
Type: STRING
Provider name: kind
Description: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
labels
Type: UNORDERED_LIST_STRING
Type: STRUCT
Provider name: metadata
Description: Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
annotations
Type: MAP_STRING_STRING
Provider name: annotations
Description: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
creation_timestamp
Type: TIMESTAMP
Provider name: creationTimestamp
Description: CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletion_grace_period_seconds
Type: INT64
Provider name: deletionGracePeriodSeconds
Description: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletion_timestamp
Type: TIMESTAMP
Provider name: deletionTimestamp
Description: DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
finalizers
Type: UNORDERED_LIST_STRING
Provider name: finalizers
Description: 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.
generate_name
Type: STRING
Provider name: generateName
Description: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.If this field is specified and the generated name exists, the server will return a 409.Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generation
Type: INT64
Provider name: generation
Description: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
managed_fields
Type: UNORDERED_LIST_STRUCT
Provider name: managedFields
Description: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
api_version
Type: STRING
Provider name: apiVersion
Description: APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fields_type
Type: STRING
Provider name: fieldsType
Description: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
manager
Type: STRING
Provider name: manager
Description: Manager is an identifier of the workflow managing these fields.
operation
Type: STRING
Provider name: operation
Description: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
subresource
Type: STRING
Provider name: subresource
Description: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time
Type: TIMESTAMP
Provider name: time
Description: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
name
Type: STRING
Provider name: name
Description: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
namespace
Type: STRING
Provider name: namespace
Description: Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
owner_references
Type: UNORDERED_LIST_STRUCT
Provider name: ownerReferences
Description: 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.
resource_version
Type: STRING
Provider name: resourceVersion
Description: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
self_link
Type: STRING
Provider name: selfLink
Description: Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uid
Type: STRING
Provider name: uid
Description: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
organization_id
Type: STRING
parent
Type: STRING
project_id
Type: STRING
project_number
Type: STRING
region_id
Type: STRING
resource_name
Type: STRING
spec
Type: STRUCT
Provider name: spec
Description: Spec defines the desired identities of pods in this set.
min_ready_seconds
Type: INT32
Provider name: minReadySeconds
Description: Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
ordinals
Type: STRUCT
Provider name: ordinals
Description: ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a “0” index to the first replica and increments the index by one for each additional replica requested.
start
Type: INT32
Provider name: start
Description: start is the number representing the first replica’s index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names, or to orchestrate progressive movement of replicas from one StatefulSet to another. If set, replica indices will be in the range: [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).If unset, defaults to 0. Replica indices will be in the range: [0, .spec.replicas).
persistent_volume_claim_retention_policy
Type: STRUCT
Provider name: persistentVolumeClaimRetentionPolicy
Description: persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down.
when_deleted
Type: STRING
Provider name: whenDeleted
Description: WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of Retain causes PVCs to not be affected by StatefulSet deletion. The Delete policy causes those PVCs to be deleted.
when_scaled
Type: STRING
Provider name: whenScaled
Description: WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of Retain causes PVCs to not be affected by a scaledown. The Delete policy causes the associated PVCs for any excess pods above the replica count to be deleted.
pod_management_policy
Type: STRING
Provider name: podManagementPolicy
Description: podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
replicas
Type: INT32
Provider name: replicas
Description: replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
revision_history_limit
Type: INT32
Provider name: revisionHistoryLimit
Description: revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet’s revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
selector
Type: STRUCT
Provider name: selector
Description: selector is a label query over pods that should match the replica count. It must match the pod template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
service_name
Type: STRING
Provider name: serviceName
Description: serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where “pod-specific-string” is managed by the StatefulSet controller.
template
Type: STRUCT
Provider name: template
Description: template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. Each pod will be named with the format -. For example, a pod in a StatefulSet named “web” with index number “3” would be named “web-3”. The only allowed template.spec.restartPolicy value is “Always”.
metadata
Type: STRUCT
Provider name: metadata
Description: Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
annotations
Type: MAP_STRING_STRING
Provider name: annotations
Description: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
creation_timestamp
Type: TIMESTAMP
Provider name: creationTimestamp
Description: CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletion_grace_period_seconds
Type: INT64
Provider name: deletionGracePeriodSeconds
Description: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletion_timestamp
Type: TIMESTAMP
Provider name: deletionTimestamp
Description: DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
finalizers
Type: UNORDERED_LIST_STRING
Provider name: finalizers
Description: 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.
generate_name
Type: STRING
Provider name: generateName
Description: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.If this field is specified and the generated name exists, the server will return a 409.Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generation
Type: INT64
Provider name: generation
Description: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
managed_fields
Type: UNORDERED_LIST_STRUCT
Provider name: managedFields
Description: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
api_version
Type: STRING
Provider name: apiVersion
Description: APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fields_type
Type: STRING
Provider name: fieldsType
Description: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
manager
Type: STRING
Provider name: manager
Description: Manager is an identifier of the workflow managing these fields.
operation
Type: STRING
Provider name: operation
Description: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
subresource
Type: STRING
Provider name: subresource
Description: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time
Type: TIMESTAMP
Provider name: time
Description: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
name
Type: STRING
Provider name: name
Description: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
namespace
Type: STRING
Provider name: namespace
Description: Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
owner_references
Type: UNORDERED_LIST_STRUCT
Provider name: ownerReferences
Description: 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.
resource_version
Type: STRING
Provider name: resourceVersion
Description: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
self_link
Type: STRING
Provider name: selfLink
Description: Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uid
Type: STRING
Provider name: uid
Description: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
spec
Type: STRUCT
Provider name: spec
Description: Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
active_deadline_seconds
Type: INT64
Provider name: activeDeadlineSeconds
Description: Optional 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.
affinity
Type: STRUCT
Provider name: affinity
Description: If specified, the pod’s scheduling constraints
node_affinity
Type: STRUCT
Provider name: nodeAffinity
Description: Describes node affinity scheduling rules for the pod.
preferred_during_scheduling_ignored_during_execution
Type: UNORDERED_LIST_STRUCT
Provider name: preferredDuringSchedulingIgnoredDuringExecution
Description: 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.
preference
Type: STRUCT
Provider name: preference
Description: A node selector term, associated with the corresponding weight.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: A list of node selector requirements by node’s labels.
key
Type: STRING
Provider name: key
Description: The label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
match_fields
Type: UNORDERED_LIST_STRUCT
Provider name: matchFields
Description: A list of node selector requirements by node’s fields.
key
Type: STRING
Provider name: key
Description: The label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
weight
Type: INT32
Provider name: weight
Description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
required_during_scheduling_ignored_during_execution
Type: STRUCT
Provider name: requiredDuringSchedulingIgnoredDuringExecution
Description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
node_selector_terms
Type: UNORDERED_LIST_STRUCT
Provider name: nodeSelectorTerms
Description: Required. A list of node selector terms. The terms are ORed.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: A list of node selector requirements by node’s labels.
key
Type: STRING
Provider name: key
Description: The label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
match_fields
Type: UNORDERED_LIST_STRUCT
Provider name: matchFields
Description: A list of node selector requirements by node’s fields.
key
Type: STRING
Provider name: key
Description: The label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
pod_affinity
Type: STRUCT
Provider name: podAffinity
Description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
preferred_during_scheduling_ignored_during_execution
Type: UNORDERED_LIST_STRUCT
Provider name: preferredDuringSchedulingIgnoredDuringExecution
Description: 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.
pod_affinity_term
Type: STRUCT
Provider name: podAffinityTerm
Description: Required. A pod affinity term, associated with the corresponding weight.
label_selector
Type: STRUCT
Provider name: labelSelector
Description: A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
match_label_keys
Type: UNORDERED_LIST_STRING
Provider name: matchLabelKeys
Description: 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.
mismatch_label_keys
Type: UNORDERED_LIST_STRING
Provider name: mismatchLabelKeys
Description: 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.
namespace_selector
Type: STRUCT
Provider name: namespaceSelector
Description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
namespaces
Type: UNORDERED_LIST_STRING
Provider name: namespaces
Description: 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”.
topology_key
Type: STRING
Provider name: topologyKey
Description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
weight
Type: INT32
Provider name: weight
Description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
required_during_scheduling_ignored_during_execution
Type: UNORDERED_LIST_STRUCT
Provider name: requiredDuringSchedulingIgnoredDuringExecution
Description: 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.
label_selector
Type: STRUCT
Provider name: labelSelector
Description: A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
match_label_keys
Type: UNORDERED_LIST_STRING
Provider name: matchLabelKeys
Description: 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.
mismatch_label_keys
Type: UNORDERED_LIST_STRING
Provider name: mismatchLabelKeys
Description: 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.
namespace_selector
Type: STRUCT
Provider name: namespaceSelector
Description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
namespaces
Type: UNORDERED_LIST_STRING
Provider name: namespaces
Description: 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”.
topology_key
Type: STRING
Provider name: topologyKey
Description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
pod_anti_affinity
Type: STRUCT
Provider name: podAntiAffinity
Description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
preferred_during_scheduling_ignored_during_execution
Type: UNORDERED_LIST_STRUCT
Provider name: preferredDuringSchedulingIgnoredDuringExecution
Description: 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 subtracting “weight” from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
pod_affinity_term
Type: STRUCT
Provider name: podAffinityTerm
Description: Required. A pod affinity term, associated with the corresponding weight.
label_selector
Type: STRUCT
Provider name: labelSelector
Description: A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
match_label_keys
Type: UNORDERED_LIST_STRING
Provider name: matchLabelKeys
Description: 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.
mismatch_label_keys
Type: UNORDERED_LIST_STRING
Provider name: mismatchLabelKeys
Description: 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.
namespace_selector
Type: STRUCT
Provider name: namespaceSelector
Description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
namespaces
Type: UNORDERED_LIST_STRING
Provider name: namespaces
Description: 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”.
topology_key
Type: STRING
Provider name: topologyKey
Description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
weight
Type: INT32
Provider name: weight
Description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
required_during_scheduling_ignored_during_execution
Type: UNORDERED_LIST_STRUCT
Provider name: requiredDuringSchedulingIgnoredDuringExecution
Description: 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.
label_selector
Type: STRUCT
Provider name: labelSelector
Description: A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
match_label_keys
Type: UNORDERED_LIST_STRING
Provider name: matchLabelKeys
Description: 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.
mismatch_label_keys
Type: UNORDERED_LIST_STRING
Provider name: mismatchLabelKeys
Description: 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.
namespace_selector
Type: STRUCT
Provider name: namespaceSelector
Description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
namespaces
Type: UNORDERED_LIST_STRING
Provider name: namespaces
Description: 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”.
topology_key
Type: STRING
Provider name: topologyKey
Description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
automount_service_account_token
Type: BOOLEAN
Provider name: automountServiceAccountToken
Description: AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
containers
Type: UNORDERED_LIST_STRUCT
Provider name: containers
Description: List 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.
args
Type: UNORDERED_LIST_STRING
Provider name: args
Description: 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
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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
env
Type: UNORDERED_LIST_STRUCT
Provider name: env
Description: List of environment variables to set in the container. Cannot be updated.
name
Type: STRING
Provider name: name
Description: Name of the environment variable. May consist of any printable ASCII characters except ‘=’.
value
Type: STRING
Provider name: value
Description: Variable 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 “”.
value_from
Type: STRUCT
Provider name: valueFrom
Description: Source for the environment variable’s value. Cannot be used if value is not empty.
config_map_key_ref
Type: STRUCT
Provider name: configMapKeyRef
Description: Selects a key of a ConfigMap.
key
Type: STRING
Provider name: key
Description: The key to select.
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the ConfigMap or its key must be defined
field_ref
Type: STRUCT
Provider name: fieldRef
Description: Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
api_version
Type: STRING
Provider name: apiVersion
Description: Version of the schema the FieldPath is written in terms of, defaults to “v1”.
field_path
Type: STRING
Provider name: fieldPath
Description: Path of the field to select in the specified API version.
file_key_ref
Type: STRUCT
Provider name: fileKeyRef
Description: FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
key
Type: STRING
Provider name: key
Description: The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except ‘=’. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod’s containers.If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.
path
Type: STRING
Provider name: path
Description: The path within the volume from which to select the file. Must be relative and may not contain the ‘..’ path or start with ‘..’.
volume_name
Type: STRING
Provider name: volumeName
Description: The name of the volume mount containing the env file.
resource_field_ref
Type: STRUCT
Provider name: resourceFieldRef
Description: Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
container_name
Type: STRING
Provider name: containerName
Description: Container name: required for volumes, optional for env vars
divisor
Type: STRING
Provider name: divisor
Description: Specifies the output format of the exposed resources, defaults to “1”
resource
Type: STRING
Provider name: resource
Description: Required: resource to select
secret_key_ref
Type: STRUCT
Provider name: secretKeyRef
Description: Selects a key of a secret in the pod’s namespace
key
Type: STRING
Provider name: key
Description: The key of the secret to select from. Must be a valid secret key.
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the Secret or its key must be defined
env_from
Type: UNORDERED_LIST_STRUCT
Provider name: envFrom
Description: List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except ‘=’. 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.
config_map_ref
Type: STRUCT
Provider name: configMapRef
Description: The ConfigMap to select from
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the ConfigMap must be defined
prefix
Type: STRING
Provider name: prefix
Description: Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except ‘=’.
secret_ref
Type: STRUCT
Provider name: secretRef
Description: The Secret to select from
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the Secret must be defined
image
Type: STRING
Provider name: image
Description: Container 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.
image_pull_policy
Type: STRING
Provider name: imagePullPolicy
Description: Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
lifecycle
Type: STRUCT
Provider name: lifecycle
Description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
post_start
Type: STRUCT
Provider name: postStart
Description: PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
sleep
Type: STRUCT
Provider name: sleep
Description: Sleep represents a duration that the container should sleep.
seconds
Type: INT64
Provider name: seconds
Description: Seconds is the number of seconds to sleep.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
pre_stop
Type: STRUCT
Provider name: preStop
Description: PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod’s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
sleep
Type: STRUCT
Provider name: sleep
Description: Sleep represents a duration that the container should sleep.
seconds
Type: INT64
Provider name: seconds
Description: Seconds is the number of seconds to sleep.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
stop_signal
Type: STRING
Provider name: stopSignal
Description: StopSignal 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
liveness_probe
Type: STRUCT
Provider name: livenessProbe
Description: Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
failure_threshold
Type: INT32
Provider name: failureThreshold
Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc
Type: STRUCT
Provider name: grpc
Description: GRPC specifies a GRPC HealthCheckRequest.
port
Type: INT32
Provider name: port
Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
service
Type: STRING
Provider name: service
Description: Service 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
initial_delay_seconds
Type: INT32
Provider name: initialDelaySeconds
Description: Number 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
period_seconds
Type: INT32
Provider name: periodSeconds
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
success_threshold
Type: INT32
Provider name: successThreshold
Description: Minimum 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.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: TCPSocket specifies a connection to a TCP port.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
termination_grace_period_seconds
Type: INT64
Provider name: terminationGracePeriodSeconds
Description: Optional 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.
timeout_seconds
Type: INT32
Provider name: timeoutSeconds
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
name
Type: STRING
Provider name: name
Description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
ports
Type: UNORDERED_LIST_STRUCT
Provider name: ports
Description: 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.
container_port
Type: INT32
Provider name: containerPort
Description: Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
host_ip
Type: STRING
Provider name: hostIP
Description: What host IP to bind the external port to.
host_port
Type: INT32
Provider name: hostPort
Description: Number 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.
name
Type: STRING
Provider name: name
Description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocol
Type: STRING
Provider name: protocol
Description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.
readiness_probe
Type: STRUCT
Provider name: readinessProbe
Description: Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
failure_threshold
Type: INT32
Provider name: failureThreshold
Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc
Type: STRUCT
Provider name: grpc
Description: GRPC specifies a GRPC HealthCheckRequest.
port
Type: INT32
Provider name: port
Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
service
Type: STRING
Provider name: service
Description: Service 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
initial_delay_seconds
Type: INT32
Provider name: initialDelaySeconds
Description: Number 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
period_seconds
Type: INT32
Provider name: periodSeconds
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
success_threshold
Type: INT32
Provider name: successThreshold
Description: Minimum 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.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: TCPSocket specifies a connection to a TCP port.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
termination_grace_period_seconds
Type: INT64
Provider name: terminationGracePeriodSeconds
Description: Optional 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.
timeout_seconds
Type: INT32
Provider name: timeoutSeconds
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
resize_policy
Type: UNORDERED_LIST_STRUCT
Provider name: resizePolicy
Description: Resources resize policy for the container. This field cannot be set on ephemeral containers.
resource_name
Type: STRING
Provider name: resourceName
Description: Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
restart_policy
Type: STRING
Provider name: restartPolicy
Description: Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
resources
Type: STRUCT
Provider name: resources
Description: Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
claims
Type: UNORDERED_LIST_STRUCT
Provider name: claims
Description: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.This field depends on the DynamicResourceAllocation feature gate.This field is immutable. It can only be set for containers.
name
Type: STRING
Provider name: name
Description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
request
Type: STRING
Provider name: request
Description: Request 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.
restart_policy
Type: STRING
Provider name: restartPolicy
Description: RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Additionally, 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.
restart_policy_rules
Type: UNORDERED_LIST_STRUCT
Provider name: restartPolicyRules
Description: Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.
action
Type: STRING
Provider name: action
Description: Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is “Restart” to restart the container.
exit_codes
Type: STRUCT
Provider name: exitCodes
Description: Represents the exit codes to check on container exits.
operator
Type: STRING
Provider name: operator
Description: Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values.- NotIn: the requirement is satisfied if the container exit code is not in the set of specified values.
values
Type: UNORDERED_LIST_INT32
Provider name: values
Description: Specifies the set of values to check for container exit codes. At most 255 elements are allowed.
security_context
Type: STRUCT
Provider name: securityContext
Description: SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
allow_privilege_escalation
Type: BOOLEAN
Provider name: allowPrivilegeEscalation
Description: AllowPrivilegeEscalation 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.
app_armor_profile
Type: STRUCT
Provider name: appArmorProfile
Description: appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod’s appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
localhost_profile
Type: STRING
Provider name: localhostProfile
Description: localhostProfile 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”.
type
Type: STRING
Provider name: type
Description: type 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.
capabilities
Type: STRUCT
Provider name: capabilities
Description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
add
Type: UNORDERED_LIST_STRING
Provider name: add
Description: Added capabilities
drop
Type: UNORDERED_LIST_STRING
Provider name: drop
Description: Removed capabilities
privileged
Type: BOOLEAN
Provider name: privileged
Description: Run 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.
proc_mount
Type: STRING
Provider name: procMount
Description: procMount 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.
read_only_root_filesystem
Type: BOOLEAN
Provider name: readOnlyRootFilesystem
Description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
run_as_group
Type: INT64
Provider name: runAsGroup
Description: The 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.
run_as_non_root
Type: BOOLEAN
Provider name: runAsNonRoot
Description: Indicates 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.
run_as_user
Type: INT64
Provider name: runAsUser
Description: The 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.
se_linux_options
Type: STRUCT
Provider name: seLinuxOptions
Description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. 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.
level
Type: STRING
Provider name: level
Description: Level is SELinux level label that applies to the container.
role
Type: STRING
Provider name: role
Description: Role is a SELinux role label that applies to the container.
type
Type: STRING
Provider name: type
Description: Type is a SELinux type label that applies to the container.
user
Type: STRING
Provider name: user
Description: User is a SELinux user label that applies to the container.
seccomp_profile
Type: STRUCT
Provider name: seccompProfile
Description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
localhost_profile
Type: STRING
Provider name: localhostProfile
Description: localhostProfile 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.
type
Type: STRING
Provider name: type
Description: type 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.
windows_options
Type: STRUCT
Provider name: windowsOptions
Description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. 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 linux.
gmsa_credential_spec
Type: STRING
Provider name: gmsaCredentialSpec
Description: GMSACredentialSpec 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.
gmsa_credential_spec_name
Type: STRING
Provider name: gmsaCredentialSpecName
Description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
host_process
Type: BOOLEAN
Provider name: hostProcess
Description: HostProcess 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.
run_as_user_name
Type: STRING
Provider name: runAsUserName
Description: The 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.
startup_probe
Type: STRUCT
Provider name: startupProbe
Description: StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
failure_threshold
Type: INT32
Provider name: failureThreshold
Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc
Type: STRUCT
Provider name: grpc
Description: GRPC specifies a GRPC HealthCheckRequest.
port
Type: INT32
Provider name: port
Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
service
Type: STRING
Provider name: service
Description: Service 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
initial_delay_seconds
Type: INT32
Provider name: initialDelaySeconds
Description: Number 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
period_seconds
Type: INT32
Provider name: periodSeconds
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
success_threshold
Type: INT32
Provider name: successThreshold
Description: Minimum 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.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: TCPSocket specifies a connection to a TCP port.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
termination_grace_period_seconds
Type: INT64
Provider name: terminationGracePeriodSeconds
Description: Optional 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.
timeout_seconds
Type: INT32
Provider name: timeoutSeconds
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
stdin
Type: BOOLEAN
Provider name: stdin
Description: Whether 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.
stdin_once
Type: BOOLEAN
Provider name: stdinOnce
Description: Whether 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
termination_message_path
Type: STRING
Provider name: terminationMessagePath
Description: Optional: 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.
termination_message_policy
Type: STRING
Provider name: terminationMessagePolicy
Description: Indicate 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.
tty
Type: BOOLEAN
Provider name: tty
Description: Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.
volume_devices
Type: UNORDERED_LIST_STRUCT
Provider name: volumeDevices
Description: volumeDevices is the list of block devices to be used by the container.
device_path
Type: STRING
Provider name: devicePath
Description: devicePath is the path inside of the container that the device will be mapped to.
name
Type: STRING
Provider name: name
Description: name must match the name of a persistentVolumeClaim in the pod
volume_mounts
Type: UNORDERED_LIST_STRUCT
Provider name: volumeMounts
Description: Pod volumes to mount into the container’s filesystem. Cannot be updated.
mount_path
Type: STRING
Provider name: mountPath
Description: Path within the container at which the volume should be mounted. Must not contain ‘:’.
mount_propagation
Type: STRING
Provider name: mountPropagation
Description: mountPropagation 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).
name
Type: STRING
Provider name: name
Description: This must match the Name of a Volume.
read_only
Type: BOOLEAN
Provider name: readOnly
Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
recursive_read_only
Type: STRING
Provider name: recursiveReadOnly
Description: RecursiveReadOnly 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.
sub_path
Type: STRING
Provider name: subPath
Description: Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).
sub_path_expr
Type: STRING
Provider name: subPathExpr
Description: Expanded 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.
working_dir
Type: STRING
Provider name: workingDir
Description: Container’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.
dns_config
Type: STRUCT
Provider name: dnsConfig
Description: Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
nameservers
Type: UNORDERED_LIST_STRING
Provider name: nameservers
Description: A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
options
Type: UNORDERED_LIST_STRUCT
Provider name: options
Description: 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.
name
Type: STRING
Provider name: name
Description: Name is this DNS resolver option’s name. Required.
value
Type: STRING
Provider name: value
Description: Value is this DNS resolver option’s value.
searches
Type: UNORDERED_LIST_STRING
Provider name: searches
Description: 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.
dns_policy
Type: STRING
Provider name: dnsPolicy
Description: Set DNS policy for the pod. Defaults to “ClusterFirst”. Valid values are ‘ClusterFirstWithHostNet’, ‘ClusterFirst’, ‘Default’ or ‘None’. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to ‘ClusterFirstWithHostNet’.
enable_service_links
Type: BOOLEAN
Provider name: enableServiceLinks
Description: EnableServiceLinks indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. Optional: Defaults to true.
ephemeral_containers
Type: UNORDERED_LIST_STRUCT
Provider name: ephemeralContainers
Description: 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.
args
Type: UNORDERED_LIST_STRING
Provider name: args
Description: 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
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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
env
Type: UNORDERED_LIST_STRUCT
Provider name: env
Description: List of environment variables to set in the container. Cannot be updated.
name
Type: STRING
Provider name: name
Description: Name of the environment variable. May consist of any printable ASCII characters except ‘=’.
value
Type: STRING
Provider name: value
Description: Variable 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 “”.
value_from
Type: STRUCT
Provider name: valueFrom
Description: Source for the environment variable’s value. Cannot be used if value is not empty.
config_map_key_ref
Type: STRUCT
Provider name: configMapKeyRef
Description: Selects a key of a ConfigMap.
key
Type: STRING
Provider name: key
Description: The key to select.
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the ConfigMap or its key must be defined
field_ref
Type: STRUCT
Provider name: fieldRef
Description: Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
api_version
Type: STRING
Provider name: apiVersion
Description: Version of the schema the FieldPath is written in terms of, defaults to “v1”.
field_path
Type: STRING
Provider name: fieldPath
Description: Path of the field to select in the specified API version.
file_key_ref
Type: STRUCT
Provider name: fileKeyRef
Description: FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
key
Type: STRING
Provider name: key
Description: The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except ‘=’. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod’s containers.If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.
path
Type: STRING
Provider name: path
Description: The path within the volume from which to select the file. Must be relative and may not contain the ‘..’ path or start with ‘..’.
volume_name
Type: STRING
Provider name: volumeName
Description: The name of the volume mount containing the env file.
resource_field_ref
Type: STRUCT
Provider name: resourceFieldRef
Description: Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
container_name
Type: STRING
Provider name: containerName
Description: Container name: required for volumes, optional for env vars
divisor
Type: STRING
Provider name: divisor
Description: Specifies the output format of the exposed resources, defaults to “1”
resource
Type: STRING
Provider name: resource
Description: Required: resource to select
secret_key_ref
Type: STRUCT
Provider name: secretKeyRef
Description: Selects a key of a secret in the pod’s namespace
key
Type: STRING
Provider name: key
Description: The key of the secret to select from. Must be a valid secret key.
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the Secret or its key must be defined
env_from
Type: UNORDERED_LIST_STRUCT
Provider name: envFrom
Description: List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except ‘=’. 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.
config_map_ref
Type: STRUCT
Provider name: configMapRef
Description: The ConfigMap to select from
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the ConfigMap must be defined
prefix
Type: STRING
Provider name: prefix
Description: Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except ‘=’.
secret_ref
Type: STRUCT
Provider name: secretRef
Description: The Secret to select from
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the Secret must be defined
image
Type: STRING
Provider name: image
Description: Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
image_pull_policy
Type: STRING
Provider name: imagePullPolicy
Description: Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
lifecycle
Type: STRUCT
Provider name: lifecycle
Description: Lifecycle is not allowed for ephemeral containers.
post_start
Type: STRUCT
Provider name: postStart
Description: PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
sleep
Type: STRUCT
Provider name: sleep
Description: Sleep represents a duration that the container should sleep.
seconds
Type: INT64
Provider name: seconds
Description: Seconds is the number of seconds to sleep.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
pre_stop
Type: STRUCT
Provider name: preStop
Description: PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod’s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
sleep
Type: STRUCT
Provider name: sleep
Description: Sleep represents a duration that the container should sleep.
seconds
Type: INT64
Provider name: seconds
Description: Seconds is the number of seconds to sleep.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
stop_signal
Type: STRING
Provider name: stopSignal
Description: StopSignal 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
liveness_probe
Type: STRUCT
Provider name: livenessProbe
Description: Probes are not allowed for ephemeral containers.
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
failure_threshold
Type: INT32
Provider name: failureThreshold
Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc
Type: STRUCT
Provider name: grpc
Description: GRPC specifies a GRPC HealthCheckRequest.
port
Type: INT32
Provider name: port
Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
service
Type: STRING
Provider name: service
Description: Service 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
initial_delay_seconds
Type: INT32
Provider name: initialDelaySeconds
Description: Number 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
period_seconds
Type: INT32
Provider name: periodSeconds
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
success_threshold
Type: INT32
Provider name: successThreshold
Description: Minimum 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.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: TCPSocket specifies a connection to a TCP port.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
termination_grace_period_seconds
Type: INT64
Provider name: terminationGracePeriodSeconds
Description: Optional 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.
timeout_seconds
Type: INT32
Provider name: timeoutSeconds
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
name
Type: STRING
Provider name: name
Description: Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
ports
Type: UNORDERED_LIST_STRUCT
Provider name: ports
Description: Ports are not allowed for ephemeral containers.
container_port
Type: INT32
Provider name: containerPort
Description: Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
host_ip
Type: STRING
Provider name: hostIP
Description: What host IP to bind the external port to.
host_port
Type: INT32
Provider name: hostPort
Description: Number 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.
name
Type: STRING
Provider name: name
Description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocol
Type: STRING
Provider name: protocol
Description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.
readiness_probe
Type: STRUCT
Provider name: readinessProbe
Description: Probes are not allowed for ephemeral containers.
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
failure_threshold
Type: INT32
Provider name: failureThreshold
Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc
Type: STRUCT
Provider name: grpc
Description: GRPC specifies a GRPC HealthCheckRequest.
port
Type: INT32
Provider name: port
Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
service
Type: STRING
Provider name: service
Description: Service 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
initial_delay_seconds
Type: INT32
Provider name: initialDelaySeconds
Description: Number 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
period_seconds
Type: INT32
Provider name: periodSeconds
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
success_threshold
Type: INT32
Provider name: successThreshold
Description: Minimum 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.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: TCPSocket specifies a connection to a TCP port.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
termination_grace_period_seconds
Type: INT64
Provider name: terminationGracePeriodSeconds
Description: Optional 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.
timeout_seconds
Type: INT32
Provider name: timeoutSeconds
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
resize_policy
Type: UNORDERED_LIST_STRUCT
Provider name: resizePolicy
Description: Resources resize policy for the container.
resource_name
Type: STRING
Provider name: resourceName
Description: Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
restart_policy
Type: STRING
Provider name: restartPolicy
Description: Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
resources
Type: STRUCT
Provider name: resources
Description: Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
claims
Type: UNORDERED_LIST_STRUCT
Provider name: claims
Description: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.This field depends on the DynamicResourceAllocation feature gate.This field is immutable. It can only be set for containers.
name
Type: STRING
Provider name: name
Description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
request
Type: STRING
Provider name: request
Description: Request 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.
restart_policy
Type: STRING
Provider name: restartPolicy
Description: Restart policy for the container to manage the restart behavior of each container within a pod. You cannot set this field on ephemeral containers.
restart_policy_rules
Type: UNORDERED_LIST_STRUCT
Provider name: restartPolicyRules
Description: Represents a list of rules to be checked to determine if the container should be restarted on exit. You cannot set this field on ephemeral containers.
action
Type: STRING
Provider name: action
Description: Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is “Restart” to restart the container.
exit_codes
Type: STRUCT
Provider name: exitCodes
Description: Represents the exit codes to check on container exits.
operator
Type: STRING
Provider name: operator
Description: Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values.- NotIn: the requirement is satisfied if the container exit code is not in the set of specified values.
values
Type: UNORDERED_LIST_INT32
Provider name: values
Description: Specifies the set of values to check for container exit codes. At most 255 elements are allowed.
security_context
Type: STRUCT
Provider name: securityContext
Description: Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
allow_privilege_escalation
Type: BOOLEAN
Provider name: allowPrivilegeEscalation
Description: AllowPrivilegeEscalation 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.
app_armor_profile
Type: STRUCT
Provider name: appArmorProfile
Description: appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod’s appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
localhost_profile
Type: STRING
Provider name: localhostProfile
Description: localhostProfile 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”.
type
Type: STRING
Provider name: type
Description: type 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.
capabilities
Type: STRUCT
Provider name: capabilities
Description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
add
Type: UNORDERED_LIST_STRING
Provider name: add
Description: Added capabilities
drop
Type: UNORDERED_LIST_STRING
Provider name: drop
Description: Removed capabilities
privileged
Type: BOOLEAN
Provider name: privileged
Description: Run 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.
proc_mount
Type: STRING
Provider name: procMount
Description: procMount 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.
read_only_root_filesystem
Type: BOOLEAN
Provider name: readOnlyRootFilesystem
Description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
run_as_group
Type: INT64
Provider name: runAsGroup
Description: The 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.
run_as_non_root
Type: BOOLEAN
Provider name: runAsNonRoot
Description: Indicates 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.
run_as_user
Type: INT64
Provider name: runAsUser
Description: The 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.
se_linux_options
Type: STRUCT
Provider name: seLinuxOptions
Description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. 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.
level
Type: STRING
Provider name: level
Description: Level is SELinux level label that applies to the container.
role
Type: STRING
Provider name: role
Description: Role is a SELinux role label that applies to the container.
type
Type: STRING
Provider name: type
Description: Type is a SELinux type label that applies to the container.
user
Type: STRING
Provider name: user
Description: User is a SELinux user label that applies to the container.
seccomp_profile
Type: STRUCT
Provider name: seccompProfile
Description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
localhost_profile
Type: STRING
Provider name: localhostProfile
Description: localhostProfile 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.
type
Type: STRING
Provider name: type
Description: type 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.
windows_options
Type: STRUCT
Provider name: windowsOptions
Description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. 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 linux.
gmsa_credential_spec
Type: STRING
Provider name: gmsaCredentialSpec
Description: GMSACredentialSpec 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.
gmsa_credential_spec_name
Type: STRING
Provider name: gmsaCredentialSpecName
Description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
host_process
Type: BOOLEAN
Provider name: hostProcess
Description: HostProcess 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.
run_as_user_name
Type: STRING
Provider name: runAsUserName
Description: The 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.
startup_probe
Type: STRUCT
Provider name: startupProbe
Description: Probes are not allowed for ephemeral containers.
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
failure_threshold
Type: INT32
Provider name: failureThreshold
Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc
Type: STRUCT
Provider name: grpc
Description: GRPC specifies a GRPC HealthCheckRequest.
port
Type: INT32
Provider name: port
Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
service
Type: STRING
Provider name: service
Description: Service 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
initial_delay_seconds
Type: INT32
Provider name: initialDelaySeconds
Description: Number 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
period_seconds
Type: INT32
Provider name: periodSeconds
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
success_threshold
Type: INT32
Provider name: successThreshold
Description: Minimum 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.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: TCPSocket specifies a connection to a TCP port.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
termination_grace_period_seconds
Type: INT64
Provider name: terminationGracePeriodSeconds
Description: Optional 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.
timeout_seconds
Type: INT32
Provider name: timeoutSeconds
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
stdin
Type: BOOLEAN
Provider name: stdin
Description: Whether 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.
stdin_once
Type: BOOLEAN
Provider name: stdinOnce
Description: Whether 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
target_container_name
Type: STRING
Provider name: targetContainerName
Description: If 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.
termination_message_path
Type: STRING
Provider name: terminationMessagePath
Description: Optional: 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.
termination_message_policy
Type: STRING
Provider name: terminationMessagePolicy
Description: Indicate 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.
tty
Type: BOOLEAN
Provider name: tty
Description: Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.
volume_devices
Type: UNORDERED_LIST_STRUCT
Provider name: volumeDevices
Description: volumeDevices is the list of block devices to be used by the container.
device_path
Type: STRING
Provider name: devicePath
Description: devicePath is the path inside of the container that the device will be mapped to.
name
Type: STRING
Provider name: name
Description: name must match the name of a persistentVolumeClaim in the pod
volume_mounts
Type: UNORDERED_LIST_STRUCT
Provider name: volumeMounts
Description: Pod volumes to mount into the container’s filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.
mount_path
Type: STRING
Provider name: mountPath
Description: Path within the container at which the volume should be mounted. Must not contain ‘:’.
mount_propagation
Type: STRING
Provider name: mountPropagation
Description: mountPropagation 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).
name
Type: STRING
Provider name: name
Description: This must match the Name of a Volume.
read_only
Type: BOOLEAN
Provider name: readOnly
Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
recursive_read_only
Type: STRING
Provider name: recursiveReadOnly
Description: RecursiveReadOnly 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.
sub_path
Type: STRING
Provider name: subPath
Description: Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).
sub_path_expr
Type: STRING
Provider name: subPathExpr
Description: Expanded 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.
working_dir
Type: STRING
Provider name: workingDir
Description: Container’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.
host_aliases
Type: UNORDERED_LIST_STRUCT
Provider name: hostAliases
Description: HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified.
hostnames
Type: UNORDERED_LIST_STRING
Provider name: hostnames
Description: Hostnames for the above IP address.
ip
Type: STRING
Provider name: ip
Description: IP address of the host file entry.
host_ipc
Type: BOOLEAN
Provider name: hostIPC
Description: Use the host’s ipc namespace. Optional: Default to false.
host_network
Type: BOOLEAN
Provider name: hostNetwork
Description: Host networking requested for this pod. Use the host’s network namespace. When using HostNetwork you should specify ports so the scheduler is aware. When hostNetwork is true, specified hostPort fields in port definitions must match containerPort, and unspecified hostPort fields in port definitions are defaulted to match containerPort. Default to false.
host_pid
Type: BOOLEAN
Provider name: hostPID
Description: Use the host’s pid namespace. Optional: Default to false.
host_users
Type: BOOLEAN
Provider name: hostUsers
Description: Use 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.
hostname
Type: STRING
Provider name: hostname
Description: Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.
hostname_override
Type: STRING
Provider name: hostnameOverride
Description: HostnameOverride specifies an explicit override for the pod’s hostname as perceived by the pod. This field only specifies the pod’s hostname and does not affect its DNS records. When this field is set to a non-empty string: - It takes precedence over the values set in hostname and subdomain. - The Pod’s hostname will be set to this value. - setHostnameAsFQDN must be nil or set to false. - hostNetwork must be set to false.This field must be a valid DNS subdomain as defined in RFC 1123 and contain at most 64 characters. Requires the HostnameOverride feature gate to be enabled.
image_pull_secrets
Type: UNORDERED_LIST_STRUCT
Provider name: imagePullSecrets
Description: 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
init_containers
Type: UNORDERED_LIST_STRUCT
Provider name: initContainers
Description: 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/
args
Type: UNORDERED_LIST_STRING
Provider name: args
Description: 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
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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
env
Type: UNORDERED_LIST_STRUCT
Provider name: env
Description: List of environment variables to set in the container. Cannot be updated.
name
Type: STRING
Provider name: name
Description: Name of the environment variable. May consist of any printable ASCII characters except ‘=’.
value
Type: STRING
Provider name: value
Description: Variable 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 “”.
value_from
Type: STRUCT
Provider name: valueFrom
Description: Source for the environment variable’s value. Cannot be used if value is not empty.
config_map_key_ref
Type: STRUCT
Provider name: configMapKeyRef
Description: Selects a key of a ConfigMap.
key
Type: STRING
Provider name: key
Description: The key to select.
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the ConfigMap or its key must be defined
field_ref
Type: STRUCT
Provider name: fieldRef
Description: Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
api_version
Type: STRING
Provider name: apiVersion
Description: Version of the schema the FieldPath is written in terms of, defaults to “v1”.
field_path
Type: STRING
Provider name: fieldPath
Description: Path of the field to select in the specified API version.
file_key_ref
Type: STRUCT
Provider name: fileKeyRef
Description: FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
key
Type: STRING
Provider name: key
Description: The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except ‘=’. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod’s containers.If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.
path
Type: STRING
Provider name: path
Description: The path within the volume from which to select the file. Must be relative and may not contain the ‘..’ path or start with ‘..’.
volume_name
Type: STRING
Provider name: volumeName
Description: The name of the volume mount containing the env file.
resource_field_ref
Type: STRUCT
Provider name: resourceFieldRef
Description: Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
container_name
Type: STRING
Provider name: containerName
Description: Container name: required for volumes, optional for env vars
divisor
Type: STRING
Provider name: divisor
Description: Specifies the output format of the exposed resources, defaults to “1”
resource
Type: STRING
Provider name: resource
Description: Required: resource to select
secret_key_ref
Type: STRUCT
Provider name: secretKeyRef
Description: Selects a key of a secret in the pod’s namespace
key
Type: STRING
Provider name: key
Description: The key of the secret to select from. Must be a valid secret key.
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the Secret or its key must be defined
env_from
Type: UNORDERED_LIST_STRUCT
Provider name: envFrom
Description: List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except ‘=’. 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.
config_map_ref
Type: STRUCT
Provider name: configMapRef
Description: The ConfigMap to select from
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the ConfigMap must be defined
prefix
Type: STRING
Provider name: prefix
Description: Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except ‘=’.
secret_ref
Type: STRUCT
Provider name: secretRef
Description: The Secret to select from
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: Specify whether the Secret must be defined
image
Type: STRING
Provider name: image
Description: Container 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.
image_pull_policy
Type: STRING
Provider name: imagePullPolicy
Description: Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
lifecycle
Type: STRUCT
Provider name: lifecycle
Description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
post_start
Type: STRUCT
Provider name: postStart
Description: PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
sleep
Type: STRUCT
Provider name: sleep
Description: Sleep represents a duration that the container should sleep.
seconds
Type: INT64
Provider name: seconds
Description: Seconds is the number of seconds to sleep.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
pre_stop
Type: STRUCT
Provider name: preStop
Description: PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod’s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
sleep
Type: STRUCT
Provider name: sleep
Description: Sleep represents a duration that the container should sleep.
seconds
Type: INT64
Provider name: seconds
Description: Seconds is the number of seconds to sleep.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
stop_signal
Type: STRING
Provider name: stopSignal
Description: StopSignal 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
liveness_probe
Type: STRUCT
Provider name: livenessProbe
Description: Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
failure_threshold
Type: INT32
Provider name: failureThreshold
Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc
Type: STRUCT
Provider name: grpc
Description: GRPC specifies a GRPC HealthCheckRequest.
port
Type: INT32
Provider name: port
Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
service
Type: STRING
Provider name: service
Description: Service 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
initial_delay_seconds
Type: INT32
Provider name: initialDelaySeconds
Description: Number 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
period_seconds
Type: INT32
Provider name: periodSeconds
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
success_threshold
Type: INT32
Provider name: successThreshold
Description: Minimum 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.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: TCPSocket specifies a connection to a TCP port.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
termination_grace_period_seconds
Type: INT64
Provider name: terminationGracePeriodSeconds
Description: Optional 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.
timeout_seconds
Type: INT32
Provider name: timeoutSeconds
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
name
Type: STRING
Provider name: name
Description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
ports
Type: UNORDERED_LIST_STRUCT
Provider name: ports
Description: 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.
container_port
Type: INT32
Provider name: containerPort
Description: Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
host_ip
Type: STRING
Provider name: hostIP
Description: What host IP to bind the external port to.
host_port
Type: INT32
Provider name: hostPort
Description: Number 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.
name
Type: STRING
Provider name: name
Description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocol
Type: STRING
Provider name: protocol
Description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.
readiness_probe
Type: STRUCT
Provider name: readinessProbe
Description: Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
failure_threshold
Type: INT32
Provider name: failureThreshold
Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc
Type: STRUCT
Provider name: grpc
Description: GRPC specifies a GRPC HealthCheckRequest.
port
Type: INT32
Provider name: port
Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
service
Type: STRING
Provider name: service
Description: Service 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
initial_delay_seconds
Type: INT32
Provider name: initialDelaySeconds
Description: Number 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
period_seconds
Type: INT32
Provider name: periodSeconds
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
success_threshold
Type: INT32
Provider name: successThreshold
Description: Minimum 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.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: TCPSocket specifies a connection to a TCP port.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
termination_grace_period_seconds
Type: INT64
Provider name: terminationGracePeriodSeconds
Description: Optional 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.
timeout_seconds
Type: INT32
Provider name: timeoutSeconds
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
resize_policy
Type: UNORDERED_LIST_STRUCT
Provider name: resizePolicy
Description: Resources resize policy for the container. This field cannot be set on ephemeral containers.
resource_name
Type: STRING
Provider name: resourceName
Description: Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
restart_policy
Type: STRING
Provider name: restartPolicy
Description: Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
resources
Type: STRUCT
Provider name: resources
Description: Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
claims
Type: UNORDERED_LIST_STRUCT
Provider name: claims
Description: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.This field depends on the DynamicResourceAllocation feature gate.This field is immutable. It can only be set for containers.
name
Type: STRING
Provider name: name
Description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
request
Type: STRING
Provider name: request
Description: Request 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.
restart_policy
Type: STRING
Provider name: restartPolicy
Description: RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Additionally, 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.
restart_policy_rules
Type: UNORDERED_LIST_STRUCT
Provider name: restartPolicyRules
Description: Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.
action
Type: STRING
Provider name: action
Description: Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is “Restart” to restart the container.
exit_codes
Type: STRUCT
Provider name: exitCodes
Description: Represents the exit codes to check on container exits.
operator
Type: STRING
Provider name: operator
Description: Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values.- NotIn: the requirement is satisfied if the container exit code is not in the set of specified values.
values
Type: UNORDERED_LIST_INT32
Provider name: values
Description: Specifies the set of values to check for container exit codes. At most 255 elements are allowed.
security_context
Type: STRUCT
Provider name: securityContext
Description: SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
allow_privilege_escalation
Type: BOOLEAN
Provider name: allowPrivilegeEscalation
Description: AllowPrivilegeEscalation 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.
app_armor_profile
Type: STRUCT
Provider name: appArmorProfile
Description: appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod’s appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
localhost_profile
Type: STRING
Provider name: localhostProfile
Description: localhostProfile 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”.
type
Type: STRING
Provider name: type
Description: type 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.
capabilities
Type: STRUCT
Provider name: capabilities
Description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
add
Type: UNORDERED_LIST_STRING
Provider name: add
Description: Added capabilities
drop
Type: UNORDERED_LIST_STRING
Provider name: drop
Description: Removed capabilities
privileged
Type: BOOLEAN
Provider name: privileged
Description: Run 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.
proc_mount
Type: STRING
Provider name: procMount
Description: procMount 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.
read_only_root_filesystem
Type: BOOLEAN
Provider name: readOnlyRootFilesystem
Description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
run_as_group
Type: INT64
Provider name: runAsGroup
Description: The 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.
run_as_non_root
Type: BOOLEAN
Provider name: runAsNonRoot
Description: Indicates 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.
run_as_user
Type: INT64
Provider name: runAsUser
Description: The 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.
se_linux_options
Type: STRUCT
Provider name: seLinuxOptions
Description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. 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.
level
Type: STRING
Provider name: level
Description: Level is SELinux level label that applies to the container.
role
Type: STRING
Provider name: role
Description: Role is a SELinux role label that applies to the container.
type
Type: STRING
Provider name: type
Description: Type is a SELinux type label that applies to the container.
user
Type: STRING
Provider name: user
Description: User is a SELinux user label that applies to the container.
seccomp_profile
Type: STRUCT
Provider name: seccompProfile
Description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
localhost_profile
Type: STRING
Provider name: localhostProfile
Description: localhostProfile 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.
type
Type: STRING
Provider name: type
Description: type 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.
windows_options
Type: STRUCT
Provider name: windowsOptions
Description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. 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 linux.
gmsa_credential_spec
Type: STRING
Provider name: gmsaCredentialSpec
Description: GMSACredentialSpec 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.
gmsa_credential_spec_name
Type: STRING
Provider name: gmsaCredentialSpecName
Description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
host_process
Type: BOOLEAN
Provider name: hostProcess
Description: HostProcess 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.
run_as_user_name
Type: STRING
Provider name: runAsUserName
Description: The 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.
startup_probe
Type: STRUCT
Provider name: startupProbe
Description: StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
exec
Type: STRUCT
Provider name: exec
Description: Exec specifies a command to execute in the container.
command
Type: UNORDERED_LIST_STRING
Provider name: command
Description: 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.
failure_threshold
Type: INT32
Provider name: failureThreshold
Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc
Type: STRUCT
Provider name: grpc
Description: GRPC specifies a GRPC HealthCheckRequest.
port
Type: INT32
Provider name: port
Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
service
Type: STRING
Provider name: service
Description: Service 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.
http_get
Type: STRUCT
Provider name: httpGet
Description: HTTPGet specifies an HTTP GET request to perform.
host
Type: STRING
Provider name: host
Description: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
http_headers
Type: UNORDERED_LIST_STRUCT
Provider name: httpHeaders
Description: Custom headers to set in the request. HTTP allows repeated headers.
name
Type: STRING
Provider name: name
Description: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value
Type: STRING
Provider name: value
Description: The header field value
path
Type: STRING
Provider name: path
Description: Path to access on the HTTP server.
port
Type: STRING
Provider name: port
Description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
Type: STRING
Provider name: scheme
Description: Scheme to use for connecting to the host. Defaults to HTTP.
initial_delay_seconds
Type: INT32
Provider name: initialDelaySeconds
Description: Number 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
period_seconds
Type: INT32
Provider name: periodSeconds
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
success_threshold
Type: INT32
Provider name: successThreshold
Description: Minimum 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.
tcp_socket
Type: STRUCT
Provider name: tcpSocket
Description: TCPSocket specifies a connection to a TCP port.
host
Type: STRING
Provider name: host
Description: Optional: Host name to connect to, defaults to the pod IP.
port
Type: STRING
Provider name: port
Description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
termination_grace_period_seconds
Type: INT64
Provider name: terminationGracePeriodSeconds
Description: Optional 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.
timeout_seconds
Type: INT32
Provider name: timeoutSeconds
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
stdin
Type: BOOLEAN
Provider name: stdin
Description: Whether 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.
stdin_once
Type: BOOLEAN
Provider name: stdinOnce
Description: Whether 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
termination_message_path
Type: STRING
Provider name: terminationMessagePath
Description: Optional: 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.
termination_message_policy
Type: STRING
Provider name: terminationMessagePolicy
Description: Indicate 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.
tty
Type: BOOLEAN
Provider name: tty
Description: Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.
volume_devices
Type: UNORDERED_LIST_STRUCT
Provider name: volumeDevices
Description: volumeDevices is the list of block devices to be used by the container.
device_path
Type: STRING
Provider name: devicePath
Description: devicePath is the path inside of the container that the device will be mapped to.
name
Type: STRING
Provider name: name
Description: name must match the name of a persistentVolumeClaim in the pod
volume_mounts
Type: UNORDERED_LIST_STRUCT
Provider name: volumeMounts
Description: Pod volumes to mount into the container’s filesystem. Cannot be updated.
mount_path
Type: STRING
Provider name: mountPath
Description: Path within the container at which the volume should be mounted. Must not contain ‘:’.
mount_propagation
Type: STRING
Provider name: mountPropagation
Description: mountPropagation 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).
name
Type: STRING
Provider name: name
Description: This must match the Name of a Volume.
read_only
Type: BOOLEAN
Provider name: readOnly
Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
recursive_read_only
Type: STRING
Provider name: recursiveReadOnly
Description: RecursiveReadOnly 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.
sub_path
Type: STRING
Provider name: subPath
Description: Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).
sub_path_expr
Type: STRING
Provider name: subPathExpr
Description: Expanded 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.
working_dir
Type: STRING
Provider name: workingDir
Description: Container’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.
node_name
Type: STRING
Provider name: nodeName
Description: NodeName 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
os
Type: STRUCT
Provider name: os
Description: Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set.If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptionsIf the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.resources - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.securityContext.supplementalGroupsPolicy - spec.containers[].securityContext.appArmorProfile - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[].securityContext.runAsGroup
preemption_policy
Type: STRING
Provider name: preemptionPolicy
Description: PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
priority
Type: INT32
Provider name: priority
Description: The 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.
priority_class_name
Type: STRING
Provider name: priorityClassName
Description: If 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.
readiness_gates
Type: UNORDERED_LIST_STRUCT
Provider name: readinessGates
Description: 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
condition_type
Type: STRING
Provider name: conditionType
Description: ConditionType refers to a condition in the pod’s condition list with matching type.
resource_claims
Type: UNORDERED_LIST_STRUCT
Provider name: resourceClaims
Description: 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 a stable field but requires that the DynamicResourceAllocation feature gate is enabled.This field is immutable.
name
Type: STRING
Provider name: name
Description: Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL.
resource_claim_name
Type: STRING
Provider name: resourceClaimName
Description: ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod.Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
resource_claim_template_name
Type: STRING
Provider name: resourceClaimTemplateName
Description: ResourceClaimTemplateName 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.
resources
Type: STRUCT
Provider name: resources
Description: Resources is the total amount of CPU and Memory resources required by all containers in the pod. It supports specifying Requests and Limits for “cpu”, “memory” and “hugepages-” resource names only. ResourceClaims are not supported.This field enables fine-grained control over resource allocation for the entire pod, allowing resource sharing among containers in a pod.This is an alpha field and requires enabling the PodLevelResources feature gate.
claims
Type: UNORDERED_LIST_STRUCT
Provider name: claims
Description: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.This field depends on the DynamicResourceAllocation feature gate.This field is immutable. It can only be set for containers.
name
Type: STRING
Provider name: name
Description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
request
Type: STRING
Provider name: request
Description: Request 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.
restart_policy
Type: STRING
Provider name: restartPolicy
Description: Restart 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
runtime_class_name
Type: STRING
Provider name: runtimeClassName
Description: RuntimeClassName 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
scheduler_name
Type: STRING
Provider name: schedulerName
Description: If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
scheduling_gates
Type: UNORDERED_LIST_STRUCT
Provider name: schedulingGates
Description: 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.
name
Type: STRING
Provider name: name
Description: Name of the scheduling gate. Each scheduling gate must have a unique name field.
security_context
Type: STRUCT
Provider name: securityContext
Description: SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
app_armor_profile
Type: STRUCT
Provider name: appArmorProfile
Description: appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
localhost_profile
Type: STRING
Provider name: localhostProfile
Description: localhostProfile 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”.
type
Type: STRING
Provider name: type
Description: type 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.
fs_group
Type: INT64
Provider name: fsGroup
Description: A 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.
fs_group_change_policy
Type: STRING
Provider name: fsGroupChangePolicy
Description: fsGroupChangePolicy 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.
run_as_group
Type: INT64
Provider name: runAsGroup
Description: The 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.
run_as_non_root
Type: BOOLEAN
Provider name: runAsNonRoot
Description: Indicates 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.
run_as_user
Type: INT64
Provider name: runAsUser
Description: The 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.
se_linux_change_policy
Type: STRING
Provider name: seLinuxChangePolicy
Description: seLinuxChangePolicy 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.
se_linux_options
Type: STRUCT
Provider name: seLinuxOptions
Description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. 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.
level
Type: STRING
Provider name: level
Description: Level is SELinux level label that applies to the container.
role
Type: STRING
Provider name: role
Description: Role is a SELinux role label that applies to the container.
type
Type: STRING
Provider name: type
Description: Type is a SELinux type label that applies to the container.
user
Type: STRING
Provider name: user
Description: User is a SELinux user label that applies to the container.
seccomp_profile
Type: STRUCT
Provider name: seccompProfile
Description: The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
localhost_profile
Type: STRING
Provider name: localhostProfile
Description: localhostProfile 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.
type
Type: STRING
Provider name: type
Description: type 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.
supplemental_groups
Type: UNORDERED_LIST_INT64
Provider name: supplementalGroups
Description: 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.
supplemental_groups_policy
Type: STRING
Provider name: supplementalGroupsPolicy
Description: Defines 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.
sysctls
Type: UNORDERED_LIST_STRUCT
Provider name: sysctls
Description: 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.
name
Type: STRING
Provider name: name
Description: Name of a property to set
value
Type: STRING
Provider name: value
Description: Value of a property to set
windows_options
Type: STRUCT
Provider name: windowsOptions
Description: The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. 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 linux.
gmsa_credential_spec
Type: STRING
Provider name: gmsaCredentialSpec
Description: GMSACredentialSpec 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.
gmsa_credential_spec_name
Type: STRING
Provider name: gmsaCredentialSpecName
Description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
host_process
Type: BOOLEAN
Provider name: hostProcess
Description: HostProcess 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.
run_as_user_name
Type: STRING
Provider name: runAsUserName
Description: The 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.
service_account
Type: STRING
Provider name: serviceAccount
Description: DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
service_account_name
Type: STRING
Provider name: serviceAccountName
Description: ServiceAccountName 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/
set_hostname_as_fqdn
Type: BOOLEAN
Provider name: setHostnameAsFQDN
Description: If 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.
share_process_namespace
Type: BOOLEAN
Provider name: shareProcessNamespace
Description: Share 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.
subdomain
Type: STRING
Provider name: subdomain
Description: If specified, the fully qualified Pod hostname will be “...svc.”. If not specified, the pod will not have a domainname at all.
termination_grace_period_seconds
Type: INT64
Provider name: terminationGracePeriodSeconds
Description: Optional 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.
tolerations
Type: UNORDERED_LIST_STRUCT
Provider name: tolerations
Description: If specified, the pod’s tolerations.
effect
Type: STRING
Provider name: effect
Description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key
Type: STRING
Provider name: key
Description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator
Type: STRING
Provider name: operator
Description: Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
toleration_seconds
Type: INT64
Provider name: tolerationSeconds
Description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
value
Type: STRING
Provider name: value
Description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
topology_spread_constraints
Type: UNORDERED_LIST_STRUCT
Provider name: topologySpreadConstraints
Description: 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.
label_selector
Type: STRUCT
Provider name: labelSelector
Description: LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
match_label_keys
Type: UNORDERED_LIST_STRING
Provider name: matchLabelKeys
Description: 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).
max_skew
Type: INT32
Provider name: maxSkew
Description: MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It’s a required field. Default value is 1 and 0 is not allowed.
min_domains
Type: INT32
Provider name: minDomains
Description: MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats “global minimum” as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won’t schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so “global minimum” is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.
node_affinity_policy
Type: STRING
Provider name: nodeAffinityPolicy
Description: NodeAffinityPolicy indicates how we will treat Pod’s nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.If this value is nil, the behavior is equivalent to the Honor policy.
node_taints_policy
Type: STRING
Provider name: nodeTaintsPolicy
Description: NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.If this value is nil, the behavior is equivalent to the Ignore policy.
topology_key
Type: STRING
Provider name: topologyKey
Description: TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a “bucket”, and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is “kubernetes.io/hostname”, each Node is a domain of that topology. And, if TopologyKey is “topology.kubernetes.io/zone”, each zone is a domain of that topology. It’s a required field.
when_unsatisfiable
Type: STRING
Provider name: whenUnsatisfiable
Description: WhenUnsatisfiable indicates how to deal with a pod if it doesn’t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew.A constraint is considered “Unsatisfiable” for an incoming pod if and only if every possible node assignment for that pod would violate “MaxSkew” on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won’t make it more imbalanced. It’s a required field.
volumes
Type: UNORDERED_LIST_STRUCT
Provider name: volumes
Description: List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
aws_elastic_block_store
Type: STRUCT
Provider name: awsElasticBlockStore
Description: awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
fs_type
Type: STRING
Provider name: fsType
Description: fsType 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
partition
Type: INT32
Provider name: partition
Description: partition 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).
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volume_id
Type: STRING
Provider name: volumeID
Description: volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
azure_disk
Type: STRUCT
Provider name: azureDisk
Description: azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.
caching_mode
Type: STRING
Provider name: cachingMode
Description: cachingMode is the Host Caching mode: None, Read Only, Read Write.
disk_name
Type: STRING
Provider name: diskName
Description: diskName is the Name of the data disk in the blob storage
disk_uri
Type: STRING
Provider name: diskURI
Description: diskURI is the URI of data disk in the blob storage
fs_type
Type: STRING
Provider name: fsType
Description: fsType 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.
kind
Type: STRING
Provider name: kind
Description: kind 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
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
azure_file
Type: STRUCT
Provider name: azureFile
Description: azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secret_name
Type: STRING
Provider name: secretName
Description: secretName is the name of secret that contains Azure Storage Account Name and Key
share_name
Type: STRING
Provider name: shareName
Description: shareName is the azure share Name
cephfs
Type: STRUCT
Provider name: cephfs
Description: cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
cinder
Type: STRUCT
Provider name: cinder
Description: cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
fs_type
Type: STRING
Provider name: fsType
Description: fsType 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
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly 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
secret_ref
Type: STRUCT
Provider name: secretRef
Description: secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
volume_id
Type: STRING
Provider name: volumeID
Description: volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
config_map
Type: STRUCT
Provider name: configMap
Description: configMap represents a configMap that should populate this volume
default_mode
Type: INT32
Provider name: defaultMode
Description: defaultMode 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.
items
Type: UNORDERED_LIST_STRUCT
Provider name: items
Description: 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 ‘..’.
key
Type: STRING
Provider name: key
Description: key is the key to project.
mode
Type: INT32
Provider name: mode
Description: mode 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.
path
Type: STRING
Provider name: path
Description: path 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 ‘..’.
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: optional specify whether the ConfigMap or its keys must be defined
csi
Type: STRUCT
Provider name: csi
Description: csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
driver
Type: STRING
Provider name: driver
Description: driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
fs_type
Type: STRING
Provider name: fsType
Description: fsType 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.
node_publish_secret_ref
Type: STRUCT
Provider name: nodePublishSecretRef
Description: nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
downward_api
Type: STRUCT
Provider name: downwardAPI
Description: downwardAPI represents downward API about the pod that should populate this volume
default_mode
Type: INT32
Provider name: defaultMode
Description: Optional: 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.
items
Type: UNORDERED_LIST_STRUCT
Provider name: items
Description: Items is a list of downward API volume file
field_ref
Type: STRUCT
Provider name: fieldRef
Description: Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
api_version
Type: STRING
Provider name: apiVersion
Description: Version of the schema the FieldPath is written in terms of, defaults to “v1”.
field_path
Type: STRING
Provider name: fieldPath
Description: Path of the field to select in the specified API version.
mode
Type: INT32
Provider name: mode
Description: 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.
path
Type: STRING
Provider name: path
Description: Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ‘..’ path. Must be utf-8 encoded. The first item of the relative path must not start with ‘..’
resource_field_ref
Type: STRUCT
Provider name: resourceFieldRef
Description: Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
container_name
Type: STRING
Provider name: containerName
Description: Container name: required for volumes, optional for env vars
divisor
Type: STRING
Provider name: divisor
Description: Specifies the output format of the exposed resources, defaults to “1”
resource
Type: STRING
Provider name: resource
Description: Required: resource to select
empty_dir
Type: STRUCT
Provider name: emptyDir
Description: emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
medium
Type: STRING
Provider name: medium
Description: medium 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
size_limit
Type: STRING
Provider name: sizeLimit
Description: sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
ephemeral
Type: STRUCT
Provider name: ephemeral
Description: ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed,c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.A pod can use both types of ephemeral volumes and persistent volumes at the same time.
volume_claim_template
Type: STRUCT
Provider name: volumeClaimTemplate
Description: Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.Required, must not be nil.
metadata
Type: STRUCT
Provider name: metadata
Description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
annotations
Type: MAP_STRING_STRING
Provider name: annotations
Description: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
creation_timestamp
Type: TIMESTAMP
Provider name: creationTimestamp
Description: CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletion_grace_period_seconds
Type: INT64
Provider name: deletionGracePeriodSeconds
Description: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletion_timestamp
Type: TIMESTAMP
Provider name: deletionTimestamp
Description: DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
finalizers
Type: UNORDERED_LIST_STRING
Provider name: finalizers
Description: 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.
generate_name
Type: STRING
Provider name: generateName
Description: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.If this field is specified and the generated name exists, the server will return a 409.Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generation
Type: INT64
Provider name: generation
Description: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
managed_fields
Type: UNORDERED_LIST_STRUCT
Provider name: managedFields
Description: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
api_version
Type: STRING
Provider name: apiVersion
Description: APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fields_type
Type: STRING
Provider name: fieldsType
Description: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
manager
Type: STRING
Provider name: manager
Description: Manager is an identifier of the workflow managing these fields.
operation
Type: STRING
Provider name: operation
Description: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
subresource
Type: STRING
Provider name: subresource
Description: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time
Type: TIMESTAMP
Provider name: time
Description: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
name
Type: STRING
Provider name: name
Description: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
namespace
Type: STRING
Provider name: namespace
Description: Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
owner_references
Type: UNORDERED_LIST_STRUCT
Provider name: ownerReferences
Description: 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.
resource_version
Type: STRING
Provider name: resourceVersion
Description: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
self_link
Type: STRING
Provider name: selfLink
Description: Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uid
Type: STRING
Provider name: uid
Description: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
spec
Type: STRUCT
Provider name: spec
Description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
access_modes
Type: UNORDERED_LIST_STRING
Provider name: accessModes
Description: accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
data_source
Type: STRUCT
Provider name: dataSource
Description: dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
api_group
Type: STRING
Provider name: apiGroup
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind
Type: STRING
Provider name: kind
Description: Kind is the type of resource being referenced
name
Type: STRING
Provider name: name
Description: Name is the name of resource being referenced
data_source_ref
Type: STRUCT
Provider name: dataSourceRef
Description: dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn’t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.* While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.* While dataSource only allows local objects, dataSourceRef allows objects in any namespaces.(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
api_group
Type: STRING
Provider name: apiGroup
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind
Type: STRING
Provider name: kind
Description: Kind is the type of resource being referenced
name
Type: STRING
Provider name: name
Description: Name is the name of resource being referenced
namespace
Type: STRING
Provider name: namespace
Description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace’s owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
resources
Type: STRUCT
Provider name: resources
Description: resources represents the minimum resources the volume should have. Users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector
Type: STRUCT
Provider name: selector
Description: selector is a label query over volumes to consider for binding.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
storage_class_name
Type: STRING
Provider name: storageClassName
Description: storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volume_attributes_class_name
Type: STRING
Provider name: volumeAttributesClassName
Description: volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/
volume_mode
Type: STRING
Provider name: volumeMode
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volume_name
Type: STRING
Provider name: volumeName
Description: volumeName is the binding reference to the PersistentVolume backing this claim.
fc
Type: STRUCT
Provider name: fc
Description: fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
fs_type
Type: STRING
Provider name: fsType
Description: fsType 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.
lun
Type: INT32
Provider name: lun
Description: lun is Optional: FC target lun number
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
target_ww_ns
Type: UNORDERED_LIST_STRING
Provider name: targetWWNs
Description: targetWWNs is Optional: FC target worldwide names (WWNs)
wwids
Type: UNORDERED_LIST_STRING
Provider name: wwids
Description: wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
flex_volume
Type: STRUCT
Provider name: flexVolume
Description: flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
driver
Type: STRING
Provider name: driver
Description: driver is the name of the driver to use for this volume.
fs_type
Type: STRING
Provider name: fsType
Description: fsType 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.
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secret_ref
Type: STRUCT
Provider name: secretRef
Description: secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
flocker
Type: STRUCT
Provider name: flocker
Description: flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
dataset_name
Type: STRING
Provider name: datasetName
Description: datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
dataset_uuid
Type: STRING
Provider name: datasetUUID
Description: datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
gce_persistent_disk
Type: STRUCT
Provider name: gcePersistentDisk
Description: gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
git_repo
Type: STRUCT
Provider name: gitRepo
Description: gitRepo represents a git repository at a particular revision. 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.
directory
Type: STRING
Provider name: directory
Description: directory 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.
repository
Type: STRING
Provider name: repository
Description: repository is the URL
revision
Type: STRING
Provider name: revision
Description: revision is the commit hash for the specified revision.
glusterfs
Type: STRUCT
Provider name: glusterfs
Description: glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
host_path
Type: STRUCT
Provider name: hostPath
Description: hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
image
Type: STRUCT
Provider name: image
Description: image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet’s host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:- 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.The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
pull_policy
Type: STRING
Provider name: pullPolicy
Description: Policy 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.
reference
Type: STRING
Provider name: reference
Description: Required: 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.
iscsi
Type: STRUCT
Provider name: iscsi
Description: iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi
chap_auth_discovery
Type: BOOLEAN
Provider name: chapAuthDiscovery
Description: chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
chap_auth_session
Type: BOOLEAN
Provider name: chapAuthSession
Description: chapAuthSession defines whether support iSCSI Session CHAP authentication
fs_type
Type: STRING
Provider name: fsType
Description: fsType 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
initiator_name
Type: STRING
Provider name: initiatorName
Description: initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.
iqn
Type: STRING
Provider name: iqn
Description: iqn is the target iSCSI Qualified Name.
iscsi_interface
Type: STRING
Provider name: iscsiInterface
Description: iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp).
lun
Type: INT32
Provider name: lun
Description: lun represents iSCSI Target Lun number.
portals
Type: UNORDERED_LIST_STRING
Provider name: portals
Description: 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).
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secret_ref
Type: STRUCT
Provider name: secretRef
Description: secretRef is the CHAP Secret for iSCSI target and initiator authentication
target_portal
Type: STRING
Provider name: targetPortal
Description: targetPortal 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).
name
Type: STRING
Provider name: name
Description: name 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
nfs
Type: STRUCT
Provider name: nfs
Description: nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
persistent_volume_claim
Type: STRUCT
Provider name: persistentVolumeClaim
Description: persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
photon_persistent_disk
Type: STRUCT
Provider name: photonPersistentDisk
Description: photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
fs_type
Type: STRING
Provider name: fsType
Description: fsType 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.
pd_id
Type: STRING
Provider name: pdID
Description: pdID is the ID that identifies Photon Controller persistent disk
portworx_volume
Type: STRUCT
Provider name: portworxVolume
Description: portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.
fs_type
Type: STRING
Provider name: fsType
Description: fSType 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.
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volume_id
Type: STRING
Provider name: volumeID
Description: volumeID uniquely identifies a Portworx volume
projected
Type: STRUCT
Provider name: projected
Description: projected items for all in one resources secrets, configmaps, and downward API
default_mode
Type: INT32
Provider name: defaultMode
Description: defaultMode 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.
sources
Type: UNORDERED_LIST_STRUCT
Provider name: sources
Description: sources is the list of volume projections. Each entry in this list handles one source.
cluster_trust_bundle
Type: STRUCT
Provider name: clusterTrustBundle
Description: ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.Alpha, gated by the ClusterTrustBundleProjection feature gate.ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
label_selector
Type: STRUCT
Provider name: labelSelector
Description: Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as “match nothing”. If set but empty, interpreted as “match everything”.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
name
Type: STRING
Provider name: name
Description: Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
optional
Type: BOOLEAN
Provider name: optional
Description: If 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.
path
Type: STRING
Provider name: path
Description: Relative path from the volume root to write the bundle.
signer_name
Type: STRING
Provider name: signerName
Description: Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.
config_map
Type: STRUCT
Provider name: configMap
Description: configMap information about the configMap data to project
items
Type: UNORDERED_LIST_STRUCT
Provider name: items
Description: 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 ‘..’.
key
Type: STRING
Provider name: key
Description: key is the key to project.
mode
Type: INT32
Provider name: mode
Description: mode 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.
path
Type: STRING
Provider name: path
Description: path 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 ‘..’.
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: optional specify whether the ConfigMap or its keys must be defined
downward_api
Type: STRUCT
Provider name: downwardAPI
Description: downwardAPI information about the downwardAPI data to project
items
Type: UNORDERED_LIST_STRUCT
Provider name: items
Description: Items is a list of DownwardAPIVolume file
field_ref
Type: STRUCT
Provider name: fieldRef
Description: Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
api_version
Type: STRING
Provider name: apiVersion
Description: Version of the schema the FieldPath is written in terms of, defaults to “v1”.
field_path
Type: STRING
Provider name: fieldPath
Description: Path of the field to select in the specified API version.
mode
Type: INT32
Provider name: mode
Description: 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.
path
Type: STRING
Provider name: path
Description: Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ‘..’ path. Must be utf-8 encoded. The first item of the relative path must not start with ‘..’
resource_field_ref
Type: STRUCT
Provider name: resourceFieldRef
Description: Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
container_name
Type: STRING
Provider name: containerName
Description: Container name: required for volumes, optional for env vars
divisor
Type: STRING
Provider name: divisor
Description: Specifies the output format of the exposed resources, defaults to “1”
resource
Type: STRING
Provider name: resource
Description: Required: resource to select
pod_certificate
Type: STRUCT
Provider name: podCertificate
Description: Projects an auto-rotating credential bundle (private key and certificate chain) that the pod can use either as a TLS client or server.Kubelet generates a private key and uses it to send a PodCertificateRequest to the named signer. Once the signer approves the request and issues a certificate chain, Kubelet writes the key and certificate chain to the pod filesystem. The pod does not start until certificates have been issued for each podCertificate projected volume source in its spec.Kubelet will begin trying to rotate the certificate at the time indicated by the signer using the PodCertificateRequest.Status.BeginRefreshAt timestamp.Kubelet can write a single file, indicated by the credentialBundlePath field, or separate files, indicated by the keyPath and certificateChainPath fields.The credential bundle is a single file in PEM format. The first PEM entry is the private key (in PKCS#8 format), and the remaining PEM entries are the certificate chain issued by the signer (typically, signers will return their certificate chain in leaf-to-root order).Prefer using the credential bundle format, since your application code can read it atomically. If you use keyPath and certificateChainPath, your application must make two separate file reads. If these coincide with a certificate rotation, it is possible that the private key and leaf certificate you read may not correspond to each other. Your application will need to check for this condition, and re-read until they are consistent.The named signer controls chooses the format of the certificate it issues; consult the signer implementation’s documentation to learn how to use the certificates it issues.
certificate_chain_path
Type: STRING
Provider name: certificateChainPath
Description: Write the certificate chain at this path in the projected volume.Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.
credential_bundle_path
Type: STRING
Provider name: credentialBundlePath
Description: Write the credential bundle at this path in the projected volume.The credential bundle is a single file that contains multiple PEM blocks. The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private key.The remaining blocks are CERTIFICATE blocks, containing the issued certificate chain from the signer (leaf and any intermediates).Using credentialBundlePath lets your Pod’s application code make a single atomic read that retrieves a consistent key and certificate chain. If you project them to separate files, your application code will need to additionally check that the leaf certificate was issued to the key.
key_path
Type: STRING
Provider name: keyPath
Description: Write the key at this path in the projected volume.Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.
key_type
Type: STRING
Provider name: keyType
Description: The type of keypair Kubelet will generate for the pod.Valid values are “RSA3072”, “RSA4096”, “ECDSAP256”, “ECDSAP384”, “ECDSAP521”, and “ED25519”.
max_expiration_seconds
Type: INT32
Provider name: maxExpirationSeconds
Description: maxExpirationSeconds is the maximum lifetime permitted for the certificate.Kubelet copies this value verbatim into the PodCertificateRequests it generates for this projection.If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver will reject values shorter than 3600 (1 hour). The maximum allowable value is 7862400 (91 days).The signer implementation is then free to issue a certificate with any lifetime shorter than MaxExpirationSeconds, but no shorter than 3600 seconds (1 hour). This constraint is enforced by kube-apiserver. kubernetes.io signers will never issue certificates with a lifetime longer than 24 hours.
signer_name
Type: STRING
Provider name: signerName
Description: Kubelet’s generated CSRs will be addressed to this signer.
secret
Type: STRUCT
Provider name: secret
Description: secret information about the secret data to project
items
Type: UNORDERED_LIST_STRUCT
Provider name: items
Description: 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 ‘..’.
key
Type: STRING
Provider name: key
Description: key is the key to project.
mode
Type: INT32
Provider name: mode
Description: mode 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.
path
Type: STRING
Provider name: path
Description: path 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 ‘..’.
name
Type: STRING
Provider name: name
Description: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
Type: BOOLEAN
Provider name: optional
Description: optional field specify whether the Secret or its key must be defined
service_account_token
Type: STRUCT
Provider name: serviceAccountToken
Description: serviceAccountToken is information about the serviceAccountToken data to project
audience
Type: STRING
Provider name: audience
Description: audience 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.
expiration_seconds
Type: INT64
Provider name: expirationSeconds
Description: expirationSeconds 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.
path
Type: STRING
Provider name: path
Description: path is the path relative to the mount point of the file to project the token into.
quobyte
Type: STRUCT
Provider name: quobyte
Description: quobyte represents a Quobyte mount on the host that shares a pod’s lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
group
Type: STRING
Provider name: group
Description: group to map volume access to Default is no group
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
registry
Type: STRING
Provider name: registry
Description: registry 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
tenant
Type: STRING
Provider name: tenant
Description: tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
user
Type: STRING
Provider name: user
Description: user to map volume access to Defaults to serivceaccount user
volume
Type: STRING
Provider name: volume
Description: volume is a string that references an already created Quobyte volume by name.
rbd
Type: STRUCT
Provider name: rbd
Description: rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
scale_io
Type: STRUCT
Provider name: scaleIO
Description: scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
fs_type
Type: STRING
Provider name: fsType
Description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Default is “xfs”.
gateway
Type: STRING
Provider name: gateway
Description: gateway is the host address of the ScaleIO API Gateway.
protection_domain
Type: STRING
Provider name: protectionDomain
Description: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secret_ref
Type: STRUCT
Provider name: secretRef
Description: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
ssl_enabled
Type: BOOLEAN
Provider name: sslEnabled
Description: sslEnabled Flag enable/disable SSL communication with Gateway, default false
storage_mode
Type: STRING
Provider name: storageMode
Description: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storage_pool
Type: STRING
Provider name: storagePool
Description: storagePool is the ScaleIO Storage Pool associated with the protection domain.
system
Type: STRING
Provider name: system
Description: system is the name of the storage system as configured in ScaleIO.
volume_name
Type: STRING
Provider name: volumeName
Description: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
secret
Type: STRUCT
Provider name: secret
Description: secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
default_mode
Type: INT32
Provider name: defaultMode
Description: defaultMode 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.
items
Type: UNORDERED_LIST_STRUCT
Provider name: items
Description: 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 ‘..’.
key
Type: STRING
Provider name: key
Description: key is the key to project.
mode
Type: INT32
Provider name: mode
Description: mode 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.
path
Type: STRING
Provider name: path
Description: path 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 ‘..’.
optional
Type: BOOLEAN
Provider name: optional
Description: optional field specify whether the Secret or its keys must be defined
secret_name
Type: STRING
Provider name: secretName
Description: secretName is the name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
storageos
Type: STRUCT
Provider name: storageos
Description: storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
fs_type
Type: STRING
Provider name: fsType
Description: fsType 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.
read_only
Type: BOOLEAN
Provider name: readOnly
Description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secret_ref
Type: STRUCT
Provider name: secretRef
Description: secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
volume_name
Type: STRING
Provider name: volumeName
Description: volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volume_namespace
Type: STRING
Provider name: volumeNamespace
Description: volumeNamespace 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.
vsphere_volume
Type: STRUCT
Provider name: vsphereVolume
Description: vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.
fs_type
Type: STRING
Provider name: fsType
Description: fsType 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.
storage_policy_id
Type: STRING
Provider name: storagePolicyID
Description: storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storage_policy_name
Type: STRING
Provider name: storagePolicyName
Description: storagePolicyName is the storage Policy Based Management (SPBM) profile name.
volume_path
Type: STRING
Provider name: volumePath
Description: volumePath is the path that identifies vSphere volume vmdk
update_strategy
Type: STRUCT
Provider name: updateStrategy
Description: updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
rolling_update
Type: STRUCT
Provider name: rollingUpdate
Description: RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
max_unavailable
Type: STRING
Provider name: maxUnavailable
Description: The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0. Defaults to 1. This field is beta-level and is enabled by default. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable. This setting might not be effective for the OrderedReady podManagementPolicy. That policy ensures pods are created and become ready one at a time.
partition
Type: INT32
Provider name: partition
Description: Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.
type
Type: STRING
Provider name: type
Description: Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
volume_claim_templates
Type: UNORDERED_LIST_STRUCT
Provider name: volumeClaimTemplates
Description: volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
api_version
Type: STRING
Provider name: apiVersion
Description: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
gcp_status
Type: STRUCT
Provider name: status
Description: status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
access_modes
Type: UNORDERED_LIST_STRING
Provider name: accessModes
Description: accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
conditions
Type: UNORDERED_LIST_STRUCT
Provider name: conditions
Description: conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to ‘Resizing’.
current_volume_attributes_class_name
Type: STRING
Provider name: currentVolumeAttributesClassName
Description: currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim
modify_volume_status
Type: STRUCT
Provider name: modifyVolumeStatus
Description: ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.
gcp_status
Type: STRING
Provider name: status
Description: status is the status of the ControllerModifyVolume operation. It can be in any of following states: - Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing. - InProgress InProgress indicates that the volume is being modified. - Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified.Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
target_volume_attributes_class_name
Type: STRING
Provider name: targetVolumeAttributesClassName
Description: targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
phase
Type: STRING
Provider name: phase
Description: phase represents the current phase of PersistentVolumeClaim.
kind
Type: STRING
Provider name: kind
Description: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
Type: STRUCT
Provider name: metadata
Description: Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
annotations
Type: MAP_STRING_STRING
Provider name: annotations
Description: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
creation_timestamp
Type: TIMESTAMP
Provider name: creationTimestamp
Description: CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletion_grace_period_seconds
Type: INT64
Provider name: deletionGracePeriodSeconds
Description: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletion_timestamp
Type: TIMESTAMP
Provider name: deletionTimestamp
Description: DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
finalizers
Type: UNORDERED_LIST_STRING
Provider name: finalizers
Description: 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.
generate_name
Type: STRING
Provider name: generateName
Description: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.If this field is specified and the generated name exists, the server will return a 409.Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generation
Type: INT64
Provider name: generation
Description: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
managed_fields
Type: UNORDERED_LIST_STRUCT
Provider name: managedFields
Description: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
api_version
Type: STRING
Provider name: apiVersion
Description: APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fields_type
Type: STRING
Provider name: fieldsType
Description: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
manager
Type: STRING
Provider name: manager
Description: Manager is an identifier of the workflow managing these fields.
operation
Type: STRING
Provider name: operation
Description: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
subresource
Type: STRING
Provider name: subresource
Description: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time
Type: TIMESTAMP
Provider name: time
Description: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
name
Type: STRING
Provider name: name
Description: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
namespace
Type: STRING
Provider name: namespace
Description: Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
owner_references
Type: UNORDERED_LIST_STRUCT
Provider name: ownerReferences
Description: 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.
resource_version
Type: STRING
Provider name: resourceVersion
Description: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
self_link
Type: STRING
Provider name: selfLink
Description: Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uid
Type: STRING
Provider name: uid
Description: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
spec
Type: STRUCT
Provider name: spec
Description: spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
access_modes
Type: UNORDERED_LIST_STRING
Provider name: accessModes
Description: accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
data_source
Type: STRUCT
Provider name: dataSource
Description: dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
api_group
Type: STRING
Provider name: apiGroup
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind
Type: STRING
Provider name: kind
Description: Kind is the type of resource being referenced
name
Type: STRING
Provider name: name
Description: Name is the name of resource being referenced
data_source_ref
Type: STRUCT
Provider name: dataSourceRef
Description: dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn’t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.* While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.* While dataSource only allows local objects, dataSourceRef allows objects in any namespaces.(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
api_group
Type: STRING
Provider name: apiGroup
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind
Type: STRING
Provider name: kind
Description: Kind is the type of resource being referenced
name
Type: STRING
Provider name: name
Description: Name is the name of resource being referenced
namespace
Type: STRING
Provider name: namespace
Description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace’s owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
resources
Type: STRUCT
Provider name: resources
Description: resources represents the minimum resources the volume should have. Users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector
Type: STRUCT
Provider name: selector
Description: selector is a label query over volumes to consider for binding.
match_expressions
Type: UNORDERED_LIST_STRUCT
Provider name: matchExpressions
Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
Type: STRING
Provider name: key
Description: key is the label key that the selector applies to.
operator
Type: STRING
Provider name: operator
Description: operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
Type: UNORDERED_LIST_STRING
Provider name: values
Description: 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.
storage_class_name
Type: STRING
Provider name: storageClassName
Description: storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volume_attributes_class_name
Type: STRING
Provider name: volumeAttributesClassName
Description: volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/
volume_mode
Type: STRING
Provider name: volumeMode
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volume_name
Type: STRING
Provider name: volumeName
Description: volumeName is the binding reference to the PersistentVolume backing this claim.
Type: UNORDERED_LIST_STRING
zone_id
Type: STRING
