resources.replicationControllers

ReplicationController represents the configuration of a replication controller.

Type: attribute set of (submodule)

Default: { }

Declared by:

resources.replicationControllers.<name>.apiVersion

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.kind

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata

If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.metadata.annotations

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

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.metadata.creationTimestamp

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.deletionGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.metadata.deletionTimestamp

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.finalizers

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.metadata.generateName

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.metadata.labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.metadata.managedFields

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.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.metadata.managedFields.*.apiVersion

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.managedFields.*.fieldsType

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.managedFields.*.fieldsV1

FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.metadata.managedFields.*.manager

Manager is an identifier of the workflow managing these fields.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.managedFields.*.operation

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.managedFields.*.subresource

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.managedFields.*.time

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.namespace

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.ownerReferences

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.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.metadata.ownerReferences.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.metadata.ownerReferences.<name>.apiVersion

API version of the referent.

Type: string

Declared by:

resources.replicationControllers.<name>.metadata.ownerReferences.<name>.blockOwnerDeletion

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

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.metadata.ownerReferences.<name>.controller

If true, this reference points to the managing controller.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.metadata.ownerReferences.<name>.kind

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

Type: string

Declared by:

resources.replicationControllers.<name>.metadata.ownerReferences.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.metadata.ownerReferences.<name>.uid

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

Type: string

Declared by:

resources.replicationControllers.<name>.metadata.resourceVersion

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

Type: null or (string)

Declared by:

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.metadata.uid

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec

Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.minReadySeconds

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)

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.replicas

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.selector

Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template

Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. The only allowed template.spec.restartPolicy value is “Always”. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.annotations

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

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.creationTimestamp

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.deletionGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.deletionTimestamp

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.finalizers

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.generateName

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.managedFields

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.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.managedFields.*.apiVersion

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.managedFields.*.fieldsType

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.managedFields.*.fieldsV1

FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.managedFields.*.manager

Manager is an identifier of the workflow managing these fields.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.managedFields.*.operation

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.managedFields.*.subresource

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.managedFields.*.time

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.namespace

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.ownerReferences

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.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.ownerReferences.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.ownerReferences.<name>.apiVersion

API version of the referent.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.ownerReferences.<name>.blockOwnerDeletion

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

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.ownerReferences.<name>.controller

If true, this reference points to the managing controller.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.ownerReferences.<name>.kind

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.ownerReferences.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.ownerReferences.<name>.uid

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.resourceVersion

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

Type: null or (string)

Declared by:

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.metadata.uid

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec

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

Type: null or (submodule)

Declared by:

EnableServiceLinks indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. Optional: Defaults to true.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.activeDeadlineSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity

If specified, the pod’s scheduling constraints

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity

Describes node affinity scheduling rules for the pod.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

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.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.preference

A node selector term, associated with the corresponding weight.

Type: submodule

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.preference.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.preference.matchExpressions.*.key

The label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.preference.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.preference.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.preference.matchFields

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.preference.matchFields.*.key

The label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.preference.matchFields.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.preference.matchFields.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.weight

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

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

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

Type: list of (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.*.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.*.matchExpressions.*.key

The label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.*.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.*.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.*.matchFields

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.*.matchFields.*.key

The label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.*.matchFields.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.*.matchFields.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

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.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm

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

Type: submodule

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.matchLabelKeys

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.mismatchLabelKeys

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaces

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.topologyKey

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.weight

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

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

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.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.matchLabelKeys

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.mismatchLabelKeys

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaces

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.topologyKey

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm

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

Type: submodule

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.labelSelector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.matchLabelKeys

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.mismatchLabelKeys

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaceSelector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.namespaces

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.podAffinityTerm.topologyKey

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.*.weight

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

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

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.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.labelSelector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.matchLabelKeys

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.mismatchLabelKeys

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaceSelector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.namespaces

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.*.topologyKey

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.automountServiceAccountToken

AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers

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.

Type: attribute set of (submodule) or list of (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.args

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.command

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env

List of environment variables to set in the container. Cannot be updated.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.name

Name of the environment variable. Must be a C_IDENTIFIER.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.value

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.configMapKeyRef

Selects a key of a ConfigMap.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.configMapKeyRef.key

The key to select.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.configMapKeyRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.configMapKeyRef.optional

Specify whether the ConfigMap or its key must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.fieldRef

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.fieldRef.apiVersion

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.fieldRef.fieldPath

Path of the field to select in the specified API version.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.resourceFieldRef

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.resourceFieldRef.containerName

Container name: required for volumes, optional for env vars

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.resourceFieldRef.resource

Required: resource to select

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.secretKeyRef

Selects a key of a secret in the pod’s namespace

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.secretKeyRef.key

The key of the secret to select from. Must be a valid secret key.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.secretKeyRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.env.<name>.valueFrom.secretKeyRef.optional

Specify whether the Secret or its key must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.envFrom

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.envFrom.*.configMapRef

The ConfigMap to select from

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.envFrom.*.configMapRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.envFrom.*.configMapRef.optional

Specify whether the ConfigMap must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.envFrom.*.prefix

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.envFrom.*.secretRef

The Secret to select from

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.envFrom.*.secretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.envFrom.*.secretRef.optional

Specify whether the Secret must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.image

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.imagePullPolicy

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.sleep

Sleep represents the duration that the container should sleep before being terminated.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.sleep.seconds

Seconds is the number of seconds to sleep.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.postStart.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.sleep

Sleep represents the duration that the container should sleep before being terminated.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.sleep.seconds

Seconds is the number of seconds to sleep.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.lifecycle.preStop.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.failureThreshold

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.grpc

GRPC specifies an action involving a GRPC port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.grpc.port

Port number of the gRPC service. Number must be in the range 1 to 65535.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.grpc.service

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.initialDelaySeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.successThreshold

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.terminationGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.livenessProbe.timeoutSeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.ports

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.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.ports.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.ports.<name>.containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.ports.<name>.hostIP

What host IP to bind the external port to.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.ports.<name>.hostPort

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.ports.<name>.name

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.ports.<name>.protocol

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.failureThreshold

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.grpc

GRPC specifies an action involving a GRPC port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.grpc.port

Port number of the gRPC service. Number must be in the range 1 to 65535.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.grpc.service

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.initialDelaySeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.successThreshold

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.terminationGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.readinessProbe.timeoutSeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.resizePolicy

Resources resize policy for the container.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.resizePolicy.*.resourceName

Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.resizePolicy.*.restartPolicy

Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.resources

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.resources.claims

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

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

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

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.resources.claims.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.resources.claims.<name>.name

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.resources.limits

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

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.resources.requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.restartPolicy

RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is “Always”. For non-init containers or when this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Setting the RestartPolicy as “Always” for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy “Always” will be shut down. This lifecycle differs from normal init containers and is often referred to as a “sidecar” container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext

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/

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.allowPrivilegeEscalation

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.appArmorProfile

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.appArmorProfile.localhostProfile

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: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.appArmorProfile.type

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.capabilities

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.capabilities.add

Added capabilities

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.capabilities.drop

Removed capabilities

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.privileged

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.procMount

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount 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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.readOnlyRootFilesystem

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.runAsGroup

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.runAsNonRoot

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.runAsUser

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.seLinuxOptions

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.seLinuxOptions.level

Level is SELinux level label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.seLinuxOptions.role

Role is a SELinux role label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.seLinuxOptions.type

Type is a SELinux type label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.seLinuxOptions.user

User is a SELinux user label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.seccompProfile

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.seccompProfile.localhostProfile

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: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.seccompProfile.type

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.windowsOptions

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.windowsOptions.gmsaCredentialSpec

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.windowsOptions.gmsaCredentialSpecName

GMSACredentialSpecName is the name of the GMSA credential spec to use.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.windowsOptions.hostProcess

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.securityContext.windowsOptions.runAsUserName

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.failureThreshold

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.grpc

GRPC specifies an action involving a GRPC port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.grpc.port

Port number of the gRPC service. Number must be in the range 1 to 65535.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.grpc.service

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.initialDelaySeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.successThreshold

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.terminationGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.startupProbe.timeoutSeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.stdin

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.stdinOnce

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

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.terminationMessagePath

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.terminationMessagePolicy

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.tty

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeDevices

volumeDevices is the list of block devices to be used by the container.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeDevices.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeDevices.<name>.devicePath

devicePath is the path inside of the container that the device will be mapped to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeDevices.<name>.name

name must match the name of a persistentVolumeClaim in the pod

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeMounts.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeMounts.<name>.mountPath

Path within the container at which the volume should be mounted. Must not contain ‘:’.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeMounts.<name>.mountPropagation

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeMounts.<name>.name

This must match the Name of a Volume.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeMounts.<name>.readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeMounts.<name>.recursiveReadOnly

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeMounts.<name>.subPath

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.volumeMounts.<name>.subPathExpr

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.containers.<name>.workingDir

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.dnsConfig

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.dnsConfig.nameservers

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.dnsConfig.options

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.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.dnsConfig.options.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.dnsConfig.options.<name>.name

Required.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.dnsConfig.options.<name>.value

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.dnsConfig.searches

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.dnsPolicy

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers

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.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.args

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.command

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env

List of environment variables to set in the container. Cannot be updated.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.name

Name of the environment variable. Must be a C_IDENTIFIER.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.value

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.configMapKeyRef

Selects a key of a ConfigMap.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.configMapKeyRef.key

The key to select.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.configMapKeyRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.configMapKeyRef.optional

Specify whether the ConfigMap or its key must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.fieldRef

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.fieldRef.apiVersion

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.fieldRef.fieldPath

Path of the field to select in the specified API version.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.resourceFieldRef

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.resourceFieldRef.containerName

Container name: required for volumes, optional for env vars

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.resourceFieldRef.resource

Required: resource to select

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.secretKeyRef

Selects a key of a secret in the pod’s namespace

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.secretKeyRef.key

The key of the secret to select from. Must be a valid secret key.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.secretKeyRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.env.<name>.valueFrom.secretKeyRef.optional

Specify whether the Secret or its key must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.envFrom

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.envFrom.*.configMapRef

The ConfigMap to select from

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.envFrom.*.configMapRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.envFrom.*.configMapRef.optional

Specify whether the ConfigMap must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.envFrom.*.prefix

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.envFrom.*.secretRef

The Secret to select from

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.envFrom.*.secretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.envFrom.*.secretRef.optional

Specify whether the Secret must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.image

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.imagePullPolicy

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle

Lifecycle is not allowed for ephemeral containers.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.sleep

Sleep represents the duration that the container should sleep before being terminated.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.sleep.seconds

Seconds is the number of seconds to sleep.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.postStart.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.sleep

Sleep represents the duration that the container should sleep before being terminated.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.sleep.seconds

Seconds is the number of seconds to sleep.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.lifecycle.preStop.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe

Probes are not allowed for ephemeral containers.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.failureThreshold

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.grpc

GRPC specifies an action involving a GRPC port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.grpc.port

Port number of the gRPC service. Number must be in the range 1 to 65535.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.grpc.service

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.initialDelaySeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.successThreshold

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.terminationGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.livenessProbe.timeoutSeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.name

Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.ports

Ports are not allowed for ephemeral containers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.ports.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.ports.<name>.containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.ports.<name>.hostIP

What host IP to bind the external port to.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.ports.<name>.hostPort

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.ports.<name>.name

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.ports.<name>.protocol

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe

Probes are not allowed for ephemeral containers.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.failureThreshold

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.grpc

GRPC specifies an action involving a GRPC port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.grpc.port

Port number of the gRPC service. Number must be in the range 1 to 65535.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.grpc.service

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.initialDelaySeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.successThreshold

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.terminationGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.readinessProbe.timeoutSeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.resizePolicy

Resources resize policy for the container.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.resizePolicy.*.resourceName

Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.resizePolicy.*.restartPolicy

Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.resources

Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.resources.claims

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

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

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

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.resources.claims.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.resources.claims.<name>.name

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.resources.limits

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

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.resources.requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.restartPolicy

Restart policy for the container to manage the restart behavior of each container within a pod. This may only be set for init containers. You cannot set this field on ephemeral containers.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.allowPrivilegeEscalation

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.appArmorProfile

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.appArmorProfile.localhostProfile

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: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.appArmorProfile.type

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.capabilities

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.capabilities.add

Added capabilities

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.capabilities.drop

Removed capabilities

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.privileged

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.procMount

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount 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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.readOnlyRootFilesystem

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.runAsGroup

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.runAsNonRoot

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.runAsUser

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.seLinuxOptions

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.seLinuxOptions.level

Level is SELinux level label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.seLinuxOptions.role

Role is a SELinux role label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.seLinuxOptions.type

Type is a SELinux type label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.seLinuxOptions.user

User is a SELinux user label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.seccompProfile

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.seccompProfile.localhostProfile

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: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.seccompProfile.type

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.windowsOptions

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.windowsOptions.gmsaCredentialSpec

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.windowsOptions.gmsaCredentialSpecName

GMSACredentialSpecName is the name of the GMSA credential spec to use.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.windowsOptions.hostProcess

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.securityContext.windowsOptions.runAsUserName

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe

Probes are not allowed for ephemeral containers.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.failureThreshold

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.grpc

GRPC specifies an action involving a GRPC port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.grpc.port

Port number of the gRPC service. Number must be in the range 1 to 65535.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.grpc.service

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.initialDelaySeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.successThreshold

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.terminationGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.startupProbe.timeoutSeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.stdin

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.stdinOnce

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

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.targetContainerName

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.terminationMessagePath

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.terminationMessagePolicy

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.tty

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeDevices

volumeDevices is the list of block devices to be used by the container.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeDevices.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeDevices.<name>.devicePath

devicePath is the path inside of the container that the device will be mapped to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeDevices.<name>.name

name must match the name of a persistentVolumeClaim in the pod

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeMounts

Pod volumes to mount into the container’s filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeMounts.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeMounts.<name>.mountPath

Path within the container at which the volume should be mounted. Must not contain ‘:’.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeMounts.<name>.mountPropagation

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeMounts.<name>.name

This must match the Name of a Volume.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeMounts.<name>.readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeMounts.<name>.recursiveReadOnly

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeMounts.<name>.subPath

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.volumeMounts.<name>.subPathExpr

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.ephemeralContainers.<name>.workingDir

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.hostAliases

HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.hostAliases.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.hostAliases.<name>.hostnames

Hostnames for the above IP address.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.hostAliases.<name>.ip

IP address of the host file entry.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.hostIPC

Use the host’s ipc namespace. Optional: Default to false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.hostNetwork

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.hostPID

Use the host’s pid namespace. Optional: Default to false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.hostUsers

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.hostname

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.imagePullSecrets

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

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.imagePullSecrets.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.imagePullSecrets.<name>.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers

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

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.args

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.command

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env

List of environment variables to set in the container. Cannot be updated.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.name

Name of the environment variable. Must be a C_IDENTIFIER.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.value

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.configMapKeyRef

Selects a key of a ConfigMap.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.configMapKeyRef.key

The key to select.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.configMapKeyRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.configMapKeyRef.optional

Specify whether the ConfigMap or its key must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.fieldRef

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.fieldRef.apiVersion

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.fieldRef.fieldPath

Path of the field to select in the specified API version.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.resourceFieldRef

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.resourceFieldRef.containerName

Container name: required for volumes, optional for env vars

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.resourceFieldRef.resource

Required: resource to select

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.secretKeyRef

Selects a key of a secret in the pod’s namespace

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.secretKeyRef.key

The key of the secret to select from. Must be a valid secret key.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.secretKeyRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.env.<name>.valueFrom.secretKeyRef.optional

Specify whether the Secret or its key must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.envFrom

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.envFrom.*.configMapRef

The ConfigMap to select from

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.envFrom.*.configMapRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.envFrom.*.configMapRef.optional

Specify whether the ConfigMap must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.envFrom.*.prefix

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.envFrom.*.secretRef

The Secret to select from

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.envFrom.*.secretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.envFrom.*.secretRef.optional

Specify whether the Secret must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.image

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.imagePullPolicy

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.sleep

Sleep represents the duration that the container should sleep before being terminated.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.sleep.seconds

Seconds is the number of seconds to sleep.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.postStart.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.sleep

Sleep represents the duration that the container should sleep before being terminated.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.sleep.seconds

Seconds is the number of seconds to sleep.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.lifecycle.preStop.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.failureThreshold

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.grpc

GRPC specifies an action involving a GRPC port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.grpc.port

Port number of the gRPC service. Number must be in the range 1 to 65535.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.grpc.service

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.initialDelaySeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.successThreshold

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.terminationGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.livenessProbe.timeoutSeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.ports

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.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.ports.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.ports.<name>.containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.ports.<name>.hostIP

What host IP to bind the external port to.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.ports.<name>.hostPort

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.ports.<name>.name

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.ports.<name>.protocol

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.failureThreshold

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.grpc

GRPC specifies an action involving a GRPC port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.grpc.port

Port number of the gRPC service. Number must be in the range 1 to 65535.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.grpc.service

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.initialDelaySeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.successThreshold

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.terminationGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.readinessProbe.timeoutSeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.resizePolicy

Resources resize policy for the container.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.resizePolicy.*.resourceName

Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.resizePolicy.*.restartPolicy

Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.resources

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.resources.claims

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

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

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

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.resources.claims.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.resources.claims.<name>.name

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.resources.limits

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

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.resources.requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.restartPolicy

RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is “Always”. For non-init containers or when this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Setting the RestartPolicy as “Always” for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy “Always” will be shut down. This lifecycle differs from normal init containers and is often referred to as a “sidecar” container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext

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/

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.allowPrivilegeEscalation

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.appArmorProfile

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.appArmorProfile.localhostProfile

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: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.appArmorProfile.type

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.capabilities

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.capabilities.add

Added capabilities

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.capabilities.drop

Removed capabilities

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.privileged

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.procMount

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount 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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.readOnlyRootFilesystem

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.runAsGroup

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.runAsNonRoot

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.runAsUser

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.seLinuxOptions

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.seLinuxOptions.level

Level is SELinux level label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.seLinuxOptions.role

Role is a SELinux role label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.seLinuxOptions.type

Type is a SELinux type label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.seLinuxOptions.user

User is a SELinux user label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.seccompProfile

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.seccompProfile.localhostProfile

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: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.seccompProfile.type

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.windowsOptions

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.windowsOptions.gmsaCredentialSpec

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.windowsOptions.gmsaCredentialSpecName

GMSACredentialSpecName is the name of the GMSA credential spec to use.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.windowsOptions.hostProcess

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.securityContext.windowsOptions.runAsUserName

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.exec

Exec specifies the action to take.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.exec.command

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.failureThreshold

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.grpc

GRPC specifies an action involving a GRPC port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.grpc.port

Port number of the gRPC service. Number must be in the range 1 to 65535.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.grpc.service

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.httpGet

HTTPGet specifies the http request to perform.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.httpGet.host

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.httpGet.httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.httpGet.httpHeaders.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.httpGet.httpHeaders.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.httpGet.httpHeaders.<name>.value

The header field value

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.httpGet.path

Path to access on the HTTP server.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.httpGet.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.httpGet.scheme

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.initialDelaySeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.successThreshold

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.tcpSocket.host

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.tcpSocket.port

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.

Type: signed integer or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.terminationGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.startupProbe.timeoutSeconds

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.stdin

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.stdinOnce

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

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.terminationMessagePath

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.terminationMessagePolicy

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.tty

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeDevices

volumeDevices is the list of block devices to be used by the container.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeDevices.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeDevices.<name>.devicePath

devicePath is the path inside of the container that the device will be mapped to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeDevices.<name>.name

name must match the name of a persistentVolumeClaim in the pod

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeMounts.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeMounts.<name>.mountPath

Path within the container at which the volume should be mounted. Must not contain ‘:’.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeMounts.<name>.mountPropagation

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeMounts.<name>.name

This must match the Name of a Volume.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeMounts.<name>.readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeMounts.<name>.recursiveReadOnly

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeMounts.<name>.subPath

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.volumeMounts.<name>.subPathExpr

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.initContainers.<name>.workingDir

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.nodeName

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.os

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

If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - 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.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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.os.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.overhead

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.preemptionPolicy

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.priority

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.priorityClassName

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.readinessGates

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.readinessGates.*.conditionType

ConditionType refers to a condition in the pod’s condition list with matching type.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.resourceClaims

ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name.

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

This field is immutable.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.resourceClaims.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.resourceClaims.<name>.name

Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.resourceClaims.<name>.source

Source describes where to find the ResourceClaim.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.resourceClaims.<name>.source.resourceClaimName

ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.resourceClaims.<name>.source.resourceClaimTemplateName

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.restartPolicy

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.runtimeClassName

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.schedulerName

If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.schedulingGates

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.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.schedulingGates.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.schedulingGates.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.appArmorProfile

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.appArmorProfile.localhostProfile

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: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.appArmorProfile.type

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.fsGroup

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.fsGroupChangePolicy

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.runAsGroup

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.runAsNonRoot

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.runAsUser

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.seLinuxOptions

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.seLinuxOptions.level

Level is SELinux level label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.seLinuxOptions.role

Role is a SELinux role label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.seLinuxOptions.type

Type is a SELinux type label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.seLinuxOptions.user

User is a SELinux user label that applies to the container.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.seccompProfile

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.seccompProfile.localhostProfile

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: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.seccompProfile.type

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.

Type: null or (list of signed integer)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.sysctls

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.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.sysctls.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.sysctls.<name>.name

Name of a property to set

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.sysctls.<name>.value

Value of a property to set

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.windowsOptions

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.windowsOptions.gmsaCredentialSpec

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.windowsOptions.gmsaCredentialSpecName

GMSACredentialSpecName is the name of the GMSA credential spec to use.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.windowsOptions.hostProcess

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.securityContext.windowsOptions.runAsUserName

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.serviceAccount

DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.serviceAccountName

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/

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.setHostnameAsFQDN

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.shareProcessNamespace

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.subdomain

If specified, the fully qualified Pod hostname will be “<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>”. If not specified, the pod will not have a domainname at all.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.terminationGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.tolerations

If specified, the pod’s tolerations.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.tolerations.*.effect

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.tolerations.*.key

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.tolerations.*.operator

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.tolerations.*.tolerationSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.tolerations.*.value

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints

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.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.labelSelector

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.labelSelector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.labelSelector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.labelSelector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.labelSelector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.labelSelector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.matchLabelKeys

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.maxSkew

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.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.minDomains

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.nodeAffinityPolicy

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

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.nodeTaintsPolicy

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

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.topologyKey

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.topologySpreadConstraints.*.whenUnsatisfiable

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.awsElasticBlockStore

awsElasticBlockStore represents an AWS 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#awselasticblockstore

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.awsElasticBlockStore.fsType

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.awsElasticBlockStore.partition

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

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.awsElasticBlockStore.readOnly

readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.awsElasticBlockStore.volumeID

volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureDisk

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureDisk.cachingMode

cachingMode is the Host Caching mode: None, Read Only, Read Write.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureDisk.diskName

diskName is the Name of the data disk in the blob storage

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureDisk.diskURI

diskURI is the URI of data disk in the blob storage

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureDisk.fsType

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureDisk.kind

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureDisk.readOnly

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureFile

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureFile.readOnly

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureFile.secretName

secretName is the name of secret that contains Azure Storage Account Name and Key

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.azureFile.shareName

shareName is the azure share Name

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cephfs

cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cephfs.monitors

monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Type: list of (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cephfs.path

path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cephfs.readOnly

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cephfs.secretFile

secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cephfs.secretRef

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cephfs.secretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cephfs.user

user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cinder

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cinder.fsType

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cinder.readOnly

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

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cinder.secretRef

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cinder.secretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.cinder.volumeID

volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.configMap

configMap represents a configMap that should populate this volume

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.configMap.defaultMode

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.configMap.items

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 ‘…’.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.configMap.items.*.key

key is the key to project.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.configMap.items.*.mode

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.configMap.items.*.path

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 ‘…’.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.configMap.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.configMap.optional

optional specify whether the ConfigMap or its keys must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.csi

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.csi.driver

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.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.csi.fsType

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.csi.nodePublishSecretRef

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.csi.nodePublishSecretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.csi.readOnly

readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.csi.volumeAttributes

volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI

downwardAPI represents downward API about the pod that should populate this volume

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.defaultMode

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.items

Items is a list of downward API volume file

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.items.*.fieldRef

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.items.*.fieldRef.apiVersion

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.items.*.fieldRef.fieldPath

Path of the field to select in the specified API version.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.items.*.mode

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.items.*.path

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 ‘…’

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.items.*.resourceFieldRef

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.items.*.resourceFieldRef.containerName

Container name: required for volumes, optional for env vars

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.items.*.resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.downwardAPI.items.*.resourceFieldRef.resource

Required: resource to select

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.emptyDir

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.emptyDir.medium

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.emptyDir.sizeLimit

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.annotations

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

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.creationTimestamp

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.deletionGracePeriodSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.deletionTimestamp

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.finalizers

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.generateName

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.managedFields

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.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.managedFields.*.apiVersion

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.managedFields.*.fieldsType

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.managedFields.*.fieldsV1

FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.managedFields.*.manager

Manager is an identifier of the workflow managing these fields.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.managedFields.*.operation

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.managedFields.*.subresource

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.managedFields.*.time

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.namespace

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.ownerReferences

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.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.ownerReferences.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.ownerReferences.<name>.apiVersion

API version of the referent.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.ownerReferences.<name>.blockOwnerDeletion

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

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.ownerReferences.<name>.controller

If true, this reference points to the managing controller.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.ownerReferences.<name>.kind

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.ownerReferences.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.ownerReferences.<name>.uid

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.resourceVersion

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

Type: null or (string)

Declared by:

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.metadata.uid

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec

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.

Type: submodule

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.accessModes

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.dataSource

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.dataSource.apiGroup

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.dataSource.kind

Kind is the type of resource being referenced

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.dataSource.name

Name is the name of resource being referenced

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.dataSourceRef

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.dataSourceRef.apiGroup

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.dataSourceRef.kind

Kind is the type of resource being referenced

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.dataSourceRef.name

Name is the name of resource being referenced

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.dataSourceRef.namespace

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.resources

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.resources.limits

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

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.resources.requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.selector

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.selector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.storageClassName

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.volumeAttributesClassName

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.volumeMode

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.ephemeral.volumeClaimTemplate.spec.volumeName

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.fc

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.fc.fsType

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.fc.lun

lun is Optional: FC target lun number

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.fc.readOnly

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.fc.targetWWNs

targetWWNs is Optional: FC target worldwide names (WWNs)

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.fc.wwids

wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.flexVolume

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.flexVolume.driver

driver is the name of the driver to use for this volume.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.flexVolume.fsType

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.flexVolume.options

options is Optional: this field holds extra command options if any.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.flexVolume.readOnly

readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.flexVolume.secretRef

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.flexVolume.secretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.flocker

flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.flocker.datasetName

datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.flocker.datasetUUID

datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.gcePersistentDisk

gcePersistentDisk represents a GCE 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#gcepersistentdisk

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.gcePersistentDisk.fsType

fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.gcePersistentDisk.partition

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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.gcePersistentDisk.pdName

pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.gcePersistentDisk.readOnly

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.gitRepo

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.gitRepo.directory

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.gitRepo.repository

repository is the URL

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.gitRepo.revision

revision is the commit hash for the specified revision.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.glusterfs

glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.glusterfs.endpoints

endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.glusterfs.path

path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.glusterfs.readOnly

readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.hostPath

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.hostPath.path

path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.hostPath.type

type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.chapAuthDiscovery

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.chapAuthSession

chapAuthSession defines whether support iSCSI Session CHAP authentication

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.fsType

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.initiatorName

initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.iqn

iqn is the target iSCSI Qualified Name.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.iscsiInterface

iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp).

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.lun

lun represents iSCSI Target Lun number.

Type: signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.portals

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

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.readOnly

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.secretRef

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.secretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.iscsi.targetPortal

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.name

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.nfs

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.nfs.path

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.nfs.readOnly

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.nfs.server

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.persistentVolumeClaim

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.persistentVolumeClaim.claimName

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.persistentVolumeClaim.readOnly

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

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.photonPersistentDisk

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.photonPersistentDisk.fsType

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.photonPersistentDisk.pdID

pdID is the ID that identifies Photon Controller persistent disk

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.portworxVolume

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.portworxVolume.fsType

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.portworxVolume.readOnly

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.portworxVolume.volumeID

volumeID uniquely identifies a Portworx volume

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected

projected items for all in one resources secrets, configmaps, and downward API

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.defaultMode

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources

sources is the list of volume projections

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle

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.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle.labelSelector

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle.labelSelector.matchExpressions

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

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle.labelSelector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle.labelSelector.matchExpressions.*.operator

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle.labelSelector.matchExpressions.*.values

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.

Type: null or (list of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle.labelSelector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle.name

Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle.optional

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.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle.path

Relative path from the volume root to write the bundle.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.clusterTrustBundle.signerName

Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.configMap

configMap information about the configMap data to project

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.configMap.items

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 ‘…’.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.configMap.items.*.key

key is the key to project.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.configMap.items.*.mode

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.configMap.items.*.path

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 ‘…’.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.configMap.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.configMap.optional

optional specify whether the ConfigMap or its keys must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI

downwardAPI information about the downwardAPI data to project

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI.items

Items is a list of DownwardAPIVolume file

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI.items.*.fieldRef

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI.items.*.fieldRef.apiVersion

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI.items.*.fieldRef.fieldPath

Path of the field to select in the specified API version.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI.items.*.mode

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI.items.*.path

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 ‘…’

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI.items.*.resourceFieldRef

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

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI.items.*.resourceFieldRef.containerName

Container name: required for volumes, optional for env vars

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI.items.*.resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.downwardAPI.items.*.resourceFieldRef.resource

Required: resource to select

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.secret

secret information about the secret data to project

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.secret.items

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 ‘…’.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.secret.items.*.key

key is the key to project.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.secret.items.*.mode

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.secret.items.*.path

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 ‘…’.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.secret.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.secret.optional

optional field specify whether the Secret or its key must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.serviceAccountToken

serviceAccountToken is information about the serviceAccountToken data to project

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.serviceAccountToken.audience

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.serviceAccountToken.expirationSeconds

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.projected.sources.*.serviceAccountToken.path

path is the path relative to the mount point of the file to project the token into.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.quobyte

quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.quobyte.group

group to map volume access to Default is no group

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.quobyte.readOnly

readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.quobyte.registry

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

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.quobyte.tenant

tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.quobyte.user

user to map volume access to Defaults to serivceaccount user

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.quobyte.volume

volume is a string that references an already created Quobyte volume by name.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.rbd

rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.rbd.fsType

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.rbd.image

image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.rbd.keyring

keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.rbd.monitors

monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Type: list of (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.rbd.pool

pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.rbd.readOnly

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.rbd.secretRef

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.rbd.secretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.rbd.user

user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.fsType

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.gateway

gateway is the host address of the ScaleIO API Gateway.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.protectionDomain

protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.readOnly

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.secretRef

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Type: submodule

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.secretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.sslEnabled

sslEnabled Flag enable/disable SSL communication with Gateway, default false

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.storageMode

storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.storagePool

storagePool is the ScaleIO Storage Pool associated with the protection domain.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.system

system is the name of the storage system as configured in ScaleIO.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.scaleIO.volumeName

volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.secret

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.secret.defaultMode

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.secret.items

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 ‘…’.

Type: null or (list of (submodule))

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.secret.items.*.key

key is the key to project.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.secret.items.*.mode

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.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.secret.items.*.path

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 ‘…’.

Type: string

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.secret.optional

optional field specify whether the Secret or its keys must be defined

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.secret.secretName

secretName is the name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.storageos

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.storageos.fsType

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.storageos.readOnly

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Type: null or boolean

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.storageos.secretRef

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.storageos.secretRef.name

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

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.storageos.volumeName

volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.storageos.volumeNamespace

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.vsphereVolume

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.vsphereVolume.fsType

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.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.vsphereVolume.storagePolicyID

storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.vsphereVolume.storagePolicyName

storagePolicyName is the storage Policy Based Management (SPBM) profile name.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.spec.template.spec.volumes.<name>.vsphereVolume.volumePath

volumePath is the path that identifies vSphere volume vmdk

Type: string

Declared by:

resources.replicationControllers.<name>.status

Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Type: null or (submodule)

Declared by:

resources.replicationControllers.<name>.status.availableReplicas

The number of available replicas (ready for at least minReadySeconds) for this replication controller.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.status.conditions

Represents the latest available observations of a replication controller’s current state.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.replicationControllers.<name>.status.conditions.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.replicationControllers.<name>.status.conditions.<name>.lastTransitionTime

The last time the condition transitioned from one status to another.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.status.conditions.<name>.message

A human readable message indicating details about the transition.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.status.conditions.<name>.reason

The reason for the condition’s last transition.

Type: null or (string)

Declared by:

resources.replicationControllers.<name>.status.conditions.<name>.status

Status of the condition, one of True, False, Unknown.

Type: string

Declared by:

resources.replicationControllers.<name>.status.conditions.<name>.type

Type of replication controller condition.

Type: string

Declared by:

resources.replicationControllers.<name>.status.fullyLabeledReplicas

The number of pods that have labels matching the labels of the pod template of the replication controller.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.status.observedGeneration

ObservedGeneration reflects the generation of the most recently observed replication controller.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.status.readyReplicas

The number of ready replicas for this replication controller.

Type: null or signed integer

Declared by:

resources.replicationControllers.<name>.status.replicas

Replicas is the most recently observed number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

Type: signed integer

Declared by: