Deployment List.

GET

/api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/deployments

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/site/example/apis/apps/v1/namespaces/example/deployments \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

API to GET list of deployments for a given namespace in a site.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

site

required

string

Site Site name.

namespace

required

string

Namespace Namespace to scope the listing of deployments in a site.

Responses

200

A successful response.

Media typeapplication/json

DeploymentList is a list of Deployments.

object

items

Items is the list of Deployments.

Array<object>

Deployment enables declarative updates for Pods and ReplicaSets.

object

metadata

object

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: http://kubernetes.io/docs/user-guide/annotations +optional

Additional metadata and notes

object

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional

Cluster or grouping configuration

string

<= 1024 characters

creationTimestamp

object

nanos

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

integer format: int32

seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

string format: int64

<= 1024 characters

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

Security-related configuration

string format: int64

<= 1024 characters

deletionTimestamp

object

nanos

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

integer format: int32

seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

string format: int64

<= 1024 characters

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. +optional +patchStrategy=merge

Configuration parameter for finalizers

Array<string>

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 NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: HTTPS://git.K8s.I/O/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional.

string

<= 1024 characters

generation

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

Configuration parameter for generation

string format: int64

<= 1024 characters

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: http://kubernetes.io/docs/user-guide/labels +optional

Key-value labels for organization and selection

object

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.

+optional.

Array<object>

ManagedFieldsEntry is a workflow-ID, a FieldSet and the group version of the resource that the fieldset applies to.

object

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.

string

<= 1024 characters

fieldsType

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

Field specification or configuration

string

<= 1024 characters

fieldsV1

object

Raw

Raw is the underlying serialization of this object.

string format: byte

<= 1024 characters

manager

Manager is an identifier of the workflow managing these fields.

string

<= 1024 characters

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

string

<= 1024 characters

time

object

nanos

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

integer format: int32

seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

string format: int64

<= 1024 characters

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: http://kubernetes.io/docs/user-guide/identifiers#names +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

namespace

Namespace defines the space within 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: HTTP://Kubernetes.I/O/docs/user-guide/namespaces +optional.

string

>= 6 characters <= 1024 characters

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. +optional +patchMergeKey=uid +patchStrategy=merge

Owner or responsible party

Array<object>

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

object

apiVersion

API version of the referent.

string

<= 1024 characters

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. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional

Blocking or denial configuration

boolean format: boolean

controller

If true, this reference points to the managing controller. +optional

Configuration parameter for controller

boolean format: boolean

kind

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

Resource type or kind

string

>= 12 characters <= 1024 characters

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

uid

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Unique identifier for this resource

string format: uuid

>= 36 characters <= 1024 characters

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.I/O/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional.

string

0 <= 1024 characters

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. +optional.

string

0 <= 1024 characters

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: HTTP://Kubernetes.I/O/docs/user-guide/identifiers#uids +optional.

string format: uuid

>= 36 characters <= 1024 characters

spec

object

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) +optional

Security-related configuration

integer format: int32

paused

Indicates that the deployment is paused. +optional

Configuration parameter for paused

boolean format: boolean

progressDeadlineSeconds

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

integer format: int32

replicas

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. +optional

Configuration parameter for replicas

integer format: int32

revisionHistoryLimit

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. +optional

Historical or audit data

integer format: int32

selector

object

matchExpressions

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

Configuration parameter for matchExpressions

Array<object>

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

object

key

key is the label key that the selector applies to. +patchMergeKey=key +patchStrategy=merge

Cryptographic key material

string

>= 7 characters <= 1024 characters

operator

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

string

<= 1024 characters

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

Configuration parameter for values

Array<string>

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

Key-value label for organization

object

strategy

object

rollingUpdate

object

maxSurge

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

maxUnavailable

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

type

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. +optional

Type or category classification

string

<= 1024 characters

template

object

metadata

object

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: http://kubernetes.io/docs/user-guide/annotations +optional

Additional metadata and notes

object

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional

Cluster or grouping configuration

string

<= 1024 characters

creationTimestamp

object

nanos

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

integer format: int32

seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

string format: int64

<= 1024 characters

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

Security-related configuration

string format: int64

<= 1024 characters

deletionTimestamp

object

nanos

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

integer format: int32

seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

string format: int64

<= 1024 characters

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. +optional +patchStrategy=merge

Configuration parameter for finalizers

Array<string>

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 NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: HTTPS://git.K8s.I/O/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional.

string

<= 1024 characters

generation

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

Configuration parameter for generation

string format: int64

<= 1024 characters

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: http://kubernetes.io/docs/user-guide/labels +optional

Key-value labels for organization and selection

object

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.

+optional.

Array<object>

ManagedFieldsEntry is a workflow-ID, a FieldSet and the group version of the resource that the fieldset applies to.

object

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.

string

<= 1024 characters

fieldsType

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

Field specification or configuration

string

<= 1024 characters

fieldsV1

object

Raw

Raw is the underlying serialization of this object.

string format: byte

<= 1024 characters

manager

Manager is an identifier of the workflow managing these fields.

string

<= 1024 characters

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

string

<= 1024 characters

time

object

nanos

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

integer format: int32

seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

string format: int64

<= 1024 characters

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: http://kubernetes.io/docs/user-guide/identifiers#names +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

namespace

Namespace defines the space within 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: HTTP://Kubernetes.I/O/docs/user-guide/namespaces +optional.

string

>= 6 characters <= 1024 characters

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. +optional +patchMergeKey=uid +patchStrategy=merge

Owner or responsible party

Array<object>

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

object

apiVersion

API version of the referent.

string

<= 1024 characters

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. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional

Blocking or denial configuration

boolean format: boolean

controller

If true, this reference points to the managing controller. +optional

Configuration parameter for controller

boolean format: boolean

kind

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

Resource type or kind

string

>= 12 characters <= 1024 characters

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

uid

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Unique identifier for this resource

string format: uuid

>= 36 characters <= 1024 characters

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.I/O/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional.

string

0 <= 1024 characters

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. +optional.

string

0 <= 1024 characters

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: HTTP://Kubernetes.I/O/docs/user-guide/identifiers#uids +optional.

string format: uuid

>= 36 characters <= 1024 characters

spec

object

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

Security-related configuration

string format: int64

<= 1024 characters

affinity

object

nodeAffinity

object

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

Uniform Resource Identifier

Array<object>

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. It’s a no-op). A null preferred scheduling term matches no objects (i.e. Is also a no-op).

object

preference

object

matchExpressions

A list of node selector requirements by node's labels. +optional

Configuration parameter for matchExpressions

Array<object>

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

object

key

The label key that the selector applies to.

string

>= 7 characters <= 1024 characters

operator

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

string

<= 1024 characters

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

Configuration parameter for values

Array<string>

matchFields

A list of node selector requirements by node's fields. +optional

Configuration parameter for matchFields

Array<object>

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

object

key

The label key that the selector applies to.

string

>= 7 characters <= 1024 characters

operator

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

string

<= 1024 characters

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

Configuration parameter for values

Array<string>

weight

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

integer format: int32

requiredDuringSchedulingIgnoredDuringExecution

object

nodeSelectorTerms

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

Array<object>

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

object

matchExpressions

A list of node selector requirements by node's labels. +optional

Configuration parameter for matchExpressions

Array<object>

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

object

key

The label key that the selector applies to.

string

>= 7 characters <= 1024 characters

operator

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

string

<= 1024 characters

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

Configuration parameter for values

Array<string>

matchFields

A list of node selector requirements by node's fields. +optional

Configuration parameter for matchFields

Array<object>

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

object

key

The label key that the selector applies to.

string

>= 7 characters <= 1024 characters

operator

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

string

<= 1024 characters

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

Configuration parameter for values

Array<string>

podAffinity

object

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

Uniform Resource Identifier

Array<object>

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

object

podAffinityTerm

object

labelSelector

object

matchExpressions

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

Configuration parameter for matchExpressions

Array<object>

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

object

key

key is the label key that the selector applies to. +patchMergeKey=key +patchStrategy=merge

Cryptographic key material

string

>= 7 characters <= 1024 characters

operator

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

string

<= 1024 characters

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

Configuration parameter for values

Array<string>

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

Key-value label for organization

object

namespaces

namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace" +optional

Human-readable name for the resource

Array<string>

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.

string

<= 1024 characters

weight

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

integer format: int32

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

Uniform Resource Identifier

Array<object>

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

object

labelSelector

object

matchExpressions

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

Configuration parameter for matchExpressions

Array<object>

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

object

key

key is the label key that the selector applies to. +patchMergeKey=key +patchStrategy=merge

Cryptographic key material

string

>= 7 characters <= 1024 characters

operator

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

string

<= 1024 characters

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

Configuration parameter for values

Array<string>

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

Key-value label for organization

object

namespaces

namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace" +optional

Human-readable name for the resource

Array<string>

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.

string

<= 1024 characters

podAntiAffinity

object

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

Uniform Resource Identifier

Array<object>

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

object

podAffinityTerm

object

labelSelector

object

matchExpressions

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

Configuration parameter for matchExpressions

Array<object>

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

object

key

key is the label key that the selector applies to. +patchMergeKey=key +patchStrategy=merge

Cryptographic key material

string

>= 7 characters <= 1024 characters

operator

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

string

<= 1024 characters

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

Configuration parameter for values

Array<string>

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

Key-value label for organization

object

namespaces

namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace" +optional

Human-readable name for the resource

Array<string>

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.

string

<= 1024 characters

weight

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

integer format: int32

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

Uniform Resource Identifier

Array<object>

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

object

labelSelector

object

matchExpressions

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

Configuration parameter for matchExpressions

Array<object>

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

object

key

key is the label key that the selector applies to. +patchMergeKey=key +patchStrategy=merge

Cryptographic key material

string

>= 7 characters <= 1024 characters

operator

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

string

<= 1024 characters

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

Configuration parameter for values

Array<string>

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

Key-value label for organization

object

namespaces

namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace" +optional

Human-readable name for the resource

Array<string>

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.

string

<= 1024 characters

automountServiceAccountToken

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

Configuration parameter for automountServiceAccountToken

boolean format: boolean

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. +patchMergeKey=name +patchStrategy=merge

Configuration parameter for containers

Array<object>

A single application container that you want to run within a pod.

object

args

Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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 +optional

Configuration parameter for args

Array<string>

command

Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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 +optional

Configuration parameter for command

Array<string>

env

List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge

Configuration parameter for env

Array<object>

EnvVar represents an environment variable present in a Container.

object

name

Name of the environment variable. Must be a C_IDENTIFIER.

string

>= 6 characters <= 1024 characters

value

Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional

Configuration parameter for value

string

>= 3 characters <= 1024 characters

valueFrom

object

configMapKeyRef

object

key

The key to select.

string

>= 7 characters <= 1024 characters

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the ConfigMap or its key must be defined +optional

Indicates if this field is optional

boolean format: boolean

fieldRef

object

apiVersion

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

Version number or identifier

string

<= 1024 characters

fieldPath

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

string

<= 1024 characters

resourceFieldRef

object

containerName

Container name: required for volumes, optional for env vars +optional

Human-readable name for this resource

string

<= 1024 characters

divisor

object

string

Configuration parameter for string

string

<= 1024 characters

resource

Required: resource to select

Configuration parameter for resource

string

<= 1024 characters

secretKeyRef

object

key

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

string

>= 7 characters <= 1024 characters

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the Secret or its key must be defined +optional

Indicates if this field is optional

boolean format: boolean

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

Configuration parameter for envFrom

Array<object>

EnvFromSource represents the source of a set of ConfigMaps

object

configMapRef

object

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the ConfigMap must be defined +optional

Indicates if this field is optional

boolean format: boolean

prefix

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

Configuration parameter for prefix

string

<= 1024 characters

secretRef

object

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the Secret must be defined +optional

Indicates if this field is optional

boolean format: boolean

image

Docker 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. +optional

Configuration parameter for image

string

<= 1024 characters

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 +optional

Configuration parameter for imagePullPolicy

string

<= 1024 characters

lifecycle

object

postStart

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

preStop

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

livenessProbe

object

failureThreshold

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

Configuration parameter for failureThreshold

integer format: int32

handler

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

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 +optional

Security-related configuration

integer format: int32

periodSeconds

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

Security-related configuration

integer format: int32

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

Configuration parameter for successThreshold

integer format: int32

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 +optional

Security-related configuration

integer format: int32

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.

string

>= 6 characters <= 1024 characters

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated. +optional +patchMergeKey=containerPort +patchStrategy=merge +listType=map +listMapKey=containerPort +listMapKey=protocol

Network port number

Array<object>

ContainerPort represents a network port in a single container.

object

containerPort

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

integer format: int32

hostIP

What host IP to bind the external port to. +optional

Host configuration or identifier

string

<= 1024 characters

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

Host configuration or identifier

integer format: int32

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

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

protocol

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". +optional

Configuration parameter for protocol

string

<= 1024 characters

readinessProbe

object

failureThreshold

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

Configuration parameter for failureThreshold

integer format: int32

handler

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

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 +optional

Security-related configuration

integer format: int32

periodSeconds

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

Security-related configuration

integer format: int32

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

Configuration parameter for successThreshold

integer format: int32

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 +optional

Security-related configuration

integer format: int32

resources

object

limits

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

Configuration parameter for limits

object

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional

Configuration parameter for requests

object

securityContext

object

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 +optional

Configuration parameter for allowPrivilegeEscalation

boolean format: boolean

capabilities

object

add

Added capabilities +optional

Configuration parameter for add

Array<string>

drop

Removed capabilities +optional

Configuration parameter for drop

Array<string>

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. +optional

Configuration parameter for privileged

boolean format: boolean

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

Configuration parameter for procMount

string

<= 1024 characters

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false. +optional

Configuration parameter for readOnlyRootFilesystem

boolean format: boolean

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

Configuration parameter for runAsGroup

string format: int64

<= 1024 characters

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

Configuration parameter for runAsNonRoot

boolean format: boolean

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

Configuration parameter for runAsUser

string format: int64

<= 1024 characters

seLinuxOptions

object

level

Level is SELinux level label that applies to the container. +optional

Configuration parameter for level

string

<= 1024 characters

role

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

Configuration parameter for role

string

<= 1024 characters

type

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

Type or category classification

string

<= 1024 characters

user

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

Configuration parameter for user

string

<= 1024 characters

windowsOptions

object

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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional

Desired state specification

string

<= 1024 characters

gmsaCredentialSpecName

GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional

Human-readable name for this resource

string

<= 1024 characters

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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag. +optional

Human-readable name for this resource

string

<= 1024 characters

startupProbe

object

failureThreshold

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

Configuration parameter for failureThreshold

integer format: int32

handler

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

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 +optional

Security-related configuration

integer format: int32

periodSeconds

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

Security-related configuration

integer format: int32

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

Configuration parameter for successThreshold

integer format: int32

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 +optional

Security-related configuration

integer format: int32

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

Configuration parameter for stdin

boolean format: boolean

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 +optional

Configuration parameter for stdinOnce

boolean format: boolean

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

File system or URL path

string

<= 1024 characters

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

Configuration parameter for terminationMessagePolicy

string

<= 1024 characters

tty

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

Configuration parameter for tty

boolean format: boolean

volumeDevices

volumeDevices is the list of block devices to be used by the container. This is a beta feature. +patchMergeKey=devicePath +patchStrategy=merge +optional

Configuration parameter for volumeDevices

Array<object>

VolumeDevice describes a mapping of a raw block device within a container.

object

devicePath

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

string

<= 1024 characters

name

name must match the name of a persistentVolumeClaim in the pod

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

volumeMounts

Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge

Configuration parameter for volumeMounts

Array<object>

VolumeMount describes a mounting of a Volume within a container.

object

mountPath

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

string

<= 1024 characters

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

Configuration parameter for mountPropagation

string

<= 1024 characters

name

This must match the Name of a Volume.

string

>= 6 characters <= 1024 characters

readOnly

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

Configuration parameter for readOnly

boolean format: boolean

subPath

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional

File system or URL path

string

<= 1024 characters

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

File system or URL path

string

<= 1024 characters

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

Configuration parameter for workingDir

string

<= 1024 characters

dnsConfig

object

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

Human-readable name for the resource

Array<string>

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

Configuration parameter for options

Array<object>

PodDNSConfigOption defines DNS resolver OPTIONS of a pod.

object

name

Required.

string

>= 6 characters <= 1024 characters

value

+optional

Configuration parameter for value

string

>= 3 characters <= 1024 characters

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

Configuration parameter for searches

Array<string>

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'. +optional

Configuration parameter for dnsPolicy

string

<= 1024 characters

enableServiceLinks

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

Configuration parameter for enableServiceLinks

boolean format: boolean

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. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. +optional +patchMergeKey=name +patchStrategy=merge

Configuration parameter for ephemeralContainers

Array<object>

An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod’s ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.

object

ephemeralContainerCommon

object

args

Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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 +optional

Configuration parameter for args

Array<string>

command

Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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 +optional

Configuration parameter for command

Array<string>

env

List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge

Configuration parameter for env

Array<object>

EnvVar represents an environment variable present in a Container.

object

name

Name of the environment variable. Must be a C_IDENTIFIER.

string

>= 6 characters <= 1024 characters

value

Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional

Configuration parameter for value

string

>= 3 characters <= 1024 characters

valueFrom

object

configMapKeyRef

object

key

The key to select.

string

>= 7 characters <= 1024 characters

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the ConfigMap or its key must be defined +optional

Indicates if this field is optional

boolean format: boolean

fieldRef

object

apiVersion

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

Version number or identifier

string

<= 1024 characters

fieldPath

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

string

<= 1024 characters

resourceFieldRef

object

containerName

Container name: required for volumes, optional for env vars +optional

Human-readable name for this resource

string

<= 1024 characters

divisor

object

string

Configuration parameter for string

string

<= 1024 characters

resource

Required: resource to select

Configuration parameter for resource

string

<= 1024 characters

secretKeyRef

object

key

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

string

>= 7 characters <= 1024 characters

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the Secret or its key must be defined +optional

Indicates if this field is optional

boolean format: boolean

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

Configuration parameter for envFrom

Array<object>

EnvFromSource represents the source of a set of ConfigMaps

object

configMapRef

object

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the ConfigMap must be defined +optional

Indicates if this field is optional

boolean format: boolean

prefix

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

Configuration parameter for prefix

string

<= 1024 characters

secretRef

object

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the Secret must be defined +optional

Indicates if this field is optional

boolean format: boolean

image

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

Configuration parameter for image

string

<= 1024 characters

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 +optional

Configuration parameter for imagePullPolicy

string

<= 1024 characters

lifecycle

object

postStart

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

preStop

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

livenessProbe

object

failureThreshold

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

Configuration parameter for failureThreshold

integer format: int32

handler

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

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 +optional

Security-related configuration

integer format: int32

periodSeconds

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

Security-related configuration

integer format: int32

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

Configuration parameter for successThreshold

integer format: int32

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 +optional

Security-related configuration

integer format: int32

name

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

string

>= 6 characters <= 1024 characters

ports

Ports are not allowed for ephemeral containers.

Array<object>

ContainerPort represents a network port in a single container.

object

containerPort

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

integer format: int32

hostIP

What host IP to bind the external port to. +optional

Host configuration or identifier

string

<= 1024 characters

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

Host configuration or identifier

integer format: int32

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

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

protocol

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". +optional

Configuration parameter for protocol

string

<= 1024 characters

readinessProbe

object

failureThreshold

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

Configuration parameter for failureThreshold

integer format: int32

handler

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

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 +optional

Security-related configuration

integer format: int32

periodSeconds

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

Security-related configuration

integer format: int32

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

Configuration parameter for successThreshold

integer format: int32

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 +optional

Security-related configuration

integer format: int32

resources

object

limits

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

Configuration parameter for limits

object

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional

Configuration parameter for requests

object

securityContext

object

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 +optional

Configuration parameter for allowPrivilegeEscalation

boolean format: boolean

capabilities

object

add

Added capabilities +optional

Configuration parameter for add

Array<string>

drop

Removed capabilities +optional

Configuration parameter for drop

Array<string>

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. +optional

Configuration parameter for privileged

boolean format: boolean

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

Configuration parameter for procMount

string

<= 1024 characters

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false. +optional

Configuration parameter for readOnlyRootFilesystem

boolean format: boolean

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

Configuration parameter for runAsGroup

string format: int64

<= 1024 characters

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

Configuration parameter for runAsNonRoot

boolean format: boolean

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

Configuration parameter for runAsUser

string format: int64

<= 1024 characters

seLinuxOptions

object

level

Level is SELinux level label that applies to the container. +optional

Configuration parameter for level

string

<= 1024 characters

role

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

Configuration parameter for role

string

<= 1024 characters

type

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

Type or category classification

string

<= 1024 characters

user

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

Configuration parameter for user

string

<= 1024 characters

windowsOptions

object

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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional

Desired state specification

string

<= 1024 characters

gmsaCredentialSpecName

GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional

Human-readable name for this resource

string

<= 1024 characters

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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag. +optional

Human-readable name for this resource

string

<= 1024 characters

startupProbe

object

failureThreshold

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

Configuration parameter for failureThreshold

integer format: int32

handler

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

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 +optional

Security-related configuration

integer format: int32

periodSeconds

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

Security-related configuration

integer format: int32

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

Configuration parameter for successThreshold

integer format: int32

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 +optional

Security-related configuration

integer format: int32

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

Configuration parameter for stdin

boolean format: boolean

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 +optional

Configuration parameter for stdinOnce

boolean format: boolean

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

File system or URL path

string

<= 1024 characters

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

Configuration parameter for terminationMessagePolicy

string

<= 1024 characters

tty

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

Configuration parameter for tty

boolean format: boolean

volumeDevices

volumeDevices is the list of block devices to be used by the container. This is a beta feature. +patchMergeKey=devicePath +patchStrategy=merge +optional

Configuration parameter for volumeDevices

Array<object>

VolumeDevice describes a mapping of a raw block device within a container.

object

devicePath

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

string

<= 1024 characters

name

name must match the name of a persistentVolumeClaim in the pod

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

volumeMounts

Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge

Configuration parameter for volumeMounts

Array<object>

VolumeMount describes a mounting of a Volume within a container.

object

mountPath

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

string

<= 1024 characters

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

Configuration parameter for mountPropagation

string

<= 1024 characters

name

This must match the Name of a Volume.

string

>= 6 characters <= 1024 characters

readOnly

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

Configuration parameter for readOnly

boolean format: boolean

subPath

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional

File system or URL path

string

<= 1024 characters

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

File system or URL path

string

<= 1024 characters

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

Configuration parameter for workingDir

string

<= 1024 characters

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 is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. +optional

Human-readable name for this resource

string

<= 1024 characters

hostAliases

HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. +optional +patchMergeKey=ip +patchStrategy=merge

Host configuration or identifier

Array<object>

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.

object

hostnames

Hostnames for the above IP address.

Array<string>

ip

IP address of the host file entry.

string

<= 1024 characters

hostIPC

Use the host's ipc namespace. Optional: Default to false. +k8s:conversion-gen=false +optional

Host configuration or identifier

boolean format: boolean

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. +k8s:conversion-gen=false +optional

Host configuration or identifier

boolean format: boolean

hostPID

Use the host's pid namespace. Optional: Default to false. +k8s:conversion-gen=false +optional

Host configuration or identifier

boolean format: boolean

hostname

Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. +optional

Human-readable name for the resource

string

<= 1024 characters

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. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod +optional +patchMergeKey=name +patchStrategy=merge

Security-related configuration

Array<object>

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

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/ +patchMergeKey=name +patchStrategy=merge

Configuration parameter for initContainers

Array<object>

A single application container that you want to run within a pod.

object

args

Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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 +optional

Configuration parameter for args

Array<string>

command

Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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 +optional

Configuration parameter for command

Array<string>

env

List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge

Configuration parameter for env

Array<object>

EnvVar represents an environment variable present in a Container.

object

name

Name of the environment variable. Must be a C_IDENTIFIER.

string

>= 6 characters <= 1024 characters

value

Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional

Configuration parameter for value

string

>= 3 characters <= 1024 characters

valueFrom

object

configMapKeyRef

object

key

The key to select.

string

>= 7 characters <= 1024 characters

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the ConfigMap or its key must be defined +optional

Indicates if this field is optional

boolean format: boolean

fieldRef

object

apiVersion

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

Version number or identifier

string

<= 1024 characters

fieldPath

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

string

<= 1024 characters

resourceFieldRef

object

containerName

Container name: required for volumes, optional for env vars +optional

Human-readable name for this resource

string

<= 1024 characters

divisor

object

string

Configuration parameter for string

string

<= 1024 characters

resource

Required: resource to select

Configuration parameter for resource

string

<= 1024 characters

secretKeyRef

object

key

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

string

>= 7 characters <= 1024 characters

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the Secret or its key must be defined +optional

Indicates if this field is optional

boolean format: boolean

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

Configuration parameter for envFrom

Array<object>

EnvFromSource represents the source of a set of ConfigMaps

object

configMapRef

object

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the ConfigMap must be defined +optional

Indicates if this field is optional

boolean format: boolean

prefix

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

Configuration parameter for prefix

string

<= 1024 characters

secretRef

object

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the Secret must be defined +optional

Indicates if this field is optional

boolean format: boolean

image

Docker 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. +optional

Configuration parameter for image

string

<= 1024 characters

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 +optional

Configuration parameter for imagePullPolicy

string

<= 1024 characters

lifecycle

object

postStart

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

preStop

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

livenessProbe

object

failureThreshold

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

Configuration parameter for failureThreshold

integer format: int32

handler

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

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 +optional

Security-related configuration

integer format: int32

periodSeconds

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

Security-related configuration

integer format: int32

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

Configuration parameter for successThreshold

integer format: int32

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 +optional

Security-related configuration

integer format: int32

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.

string

>= 6 characters <= 1024 characters

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated. +optional +patchMergeKey=containerPort +patchStrategy=merge +listType=map +listMapKey=containerPort +listMapKey=protocol

Network port number

Array<object>

ContainerPort represents a network port in a single container.

object

containerPort

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

integer format: int32

hostIP

What host IP to bind the external port to. +optional

Host configuration or identifier

string

<= 1024 characters

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

Host configuration or identifier

integer format: int32

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

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

protocol

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". +optional

Configuration parameter for protocol

string

<= 1024 characters

readinessProbe

object

failureThreshold

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

Configuration parameter for failureThreshold

integer format: int32

handler

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

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 +optional

Security-related configuration

integer format: int32

periodSeconds

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

Security-related configuration

integer format: int32

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

Configuration parameter for successThreshold

integer format: int32

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 +optional

Security-related configuration

integer format: int32

resources

object

limits

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

Configuration parameter for limits

object

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional

Configuration parameter for requests

object

securityContext

object

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 +optional

Configuration parameter for allowPrivilegeEscalation

boolean format: boolean

capabilities

object

add

Added capabilities +optional

Configuration parameter for add

Array<string>

drop

Removed capabilities +optional

Configuration parameter for drop

Array<string>

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. +optional

Configuration parameter for privileged

boolean format: boolean

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

Configuration parameter for procMount

string

<= 1024 characters

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false. +optional

Configuration parameter for readOnlyRootFilesystem

boolean format: boolean

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

Configuration parameter for runAsGroup

string format: int64

<= 1024 characters

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

Configuration parameter for runAsNonRoot

boolean format: boolean

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

Configuration parameter for runAsUser

string format: int64

<= 1024 characters

seLinuxOptions

object

level

Level is SELinux level label that applies to the container. +optional

Configuration parameter for level

string

<= 1024 characters

role

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

Configuration parameter for role

string

<= 1024 characters

type

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

Type or category classification

string

<= 1024 characters

user

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

Configuration parameter for user

string

<= 1024 characters

windowsOptions

object

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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional

Desired state specification

string

<= 1024 characters

gmsaCredentialSpecName

GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional

Human-readable name for this resource

string

<= 1024 characters

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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag. +optional

Human-readable name for this resource

string

<= 1024 characters

startupProbe

object

failureThreshold

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

Configuration parameter for failureThreshold

integer format: int32

handler

object

exec

object

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

Configuration parameter for command

Array<string>

httpGet

object

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional

Hostname or IP address of the target server

string

<= 1024 characters

httpHeaders

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

Configuration parameter for httpHeaders

Array<object>

HTTPHeader describes a custom header to be used in HTTP probes

object

name

The header field name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

The header field value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

path

Path to access on the HTTP server. +optional

URL path for the endpoint

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

scheme

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

Configuration parameter for scheme

string

<= 1024 characters

tcpSocket

object

host

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

Hostname or IP address of the target server

string

<= 1024 characters

port

object

intVal

Configuration parameter for intVal

integer format: int32

strVal

Configuration parameter for strVal

string

<= 1024 characters

type

Type or category classification

string format: int64

<= 1024 characters

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 +optional

Security-related configuration

integer format: int32

periodSeconds

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

Security-related configuration

integer format: int32

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

Configuration parameter for successThreshold

integer format: int32

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 +optional

Security-related configuration

integer format: int32

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

Configuration parameter for stdin

boolean format: boolean

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 +optional

Configuration parameter for stdinOnce

boolean format: boolean

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

File system or URL path

string

<= 1024 characters

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

Configuration parameter for terminationMessagePolicy

string

<= 1024 characters

tty

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

Configuration parameter for tty

boolean format: boolean

volumeDevices

volumeDevices is the list of block devices to be used by the container. This is a beta feature. +patchMergeKey=devicePath +patchStrategy=merge +optional

Configuration parameter for volumeDevices

Array<object>

VolumeDevice describes a mapping of a raw block device within a container.

object

devicePath

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

string

<= 1024 characters

name

name must match the name of a persistentVolumeClaim in the pod

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

volumeMounts

Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge

Configuration parameter for volumeMounts

Array<object>

VolumeMount describes a mounting of a Volume within a container.

object

mountPath

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

string

<= 1024 characters

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

Configuration parameter for mountPropagation

string

<= 1024 characters

name

This must match the Name of a Volume.

string

>= 6 characters <= 1024 characters

readOnly

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

Configuration parameter for readOnly

boolean format: boolean

subPath

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional

File system or URL path

string

<= 1024 characters

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

File system or URL path

string

<= 1024 characters

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

Configuration parameter for workingDir

string

<= 1024 characters

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

Human-readable name for this resource

string

<= 1024 characters

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/ +optional

Configuration parameter for nodeSelector

object

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/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature. +optional

Configuration parameter for overhead

object

preemptionPolicy

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. +optional

Configuration parameter for preemptionPolicy

string

<= 1024 characters

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

Priority level for ordering

integer format: int32

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

Human-readable name for this resource

string

<= 1024 characters

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/0007-pod-ready%2B%2B.md +optional

Configuration parameter for readinessGates

Array<object>

PodReadinessGate contains the reference to a pod condition

object

conditionType

ConditionType refers to a condition in the pod’s condition list with matching type.

string

<= 1024 characters

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy +optional

Configuration parameter for restartPolicy

string

<= 1024 characters

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/runtime-class.md This is a beta feature as of Kubernetes v1.14. +optional

Human-readable name for this resource

string

<= 1024 characters

schedulerName

If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. +optional

Human-readable name for this resource

string

<= 1024 characters

securityContext

object

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

string format: int64

<= 1024 characters

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

Configuration parameter for runAsGroup

string format: int64

<= 1024 characters

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

Configuration parameter for runAsNonRoot

boolean format: boolean

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

Configuration parameter for runAsUser

string format: int64

<= 1024 characters

seLinuxOptions

object

level

Level is SELinux level label that applies to the container. +optional

Configuration parameter for level

string

<= 1024 characters

role

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

Configuration parameter for role

string

<= 1024 characters

type

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

Type or category classification

string

<= 1024 characters

user

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

Configuration parameter for user

string

<= 1024 characters

supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. +optional

Configuration parameter for supplementalGroups

Array<string>

sysctls

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. +optional

Configuration parameter for sysctls

Array<object>

Sysctl defines a kernel parameter to be set

object

name

Name of a property to set

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

value

Value of a property to set

Configuration parameter for value

string

>= 3 characters <= 1024 characters

windowsOptions

object

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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional

Desired state specification

string

<= 1024 characters

gmsaCredentialSpecName

GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional

Human-readable name for this resource

string

<= 1024 characters

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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag. +optional

Human-readable name for this resource

string

<= 1024 characters

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. +k8s:conversion-gen=false +optional

Number of items or occurrences

string

<= 1024 characters

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/ +optional

Human-readable name for this resource

string

<= 1024 characters

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. +k8s:conversion-gen=false +optional

Namespace for resource isolation

boolean format: boolean

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

Configuration parameter for subdomain

string

<= 1024 characters

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 delete immediately. 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. +optional

Security-related configuration

string format: int64

<= 1024 characters

tolerations

If specified, the pod's tolerations. +optional

Configuration parameter for tolerations

Array<object>

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

object

effect

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

Configuration parameter for effect

string

<= 1024 characters

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

Cryptographic key material

string

>= 7 characters <= 1024 characters

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

Configuration parameter for operator

string

<= 1024 characters

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

Security-related configuration

string format: int64

<= 1024 characters

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

Configuration parameter for value

string

>= 3 characters <= 1024 characters

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. This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. +optional +patchMergeKey=topologyKey +patchStrategy=merge +listType=map +listMapKey=topologyKey +listMapKey=whenUnsatisfiable

Configuration parameter for topologySpreadConstraints

Array<object>

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

object

labelSelector

object

matchExpressions

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

Configuration parameter for matchExpressions

Array<object>

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

object

key

key is the label key that the selector applies to. +patchMergeKey=key +patchStrategy=merge

Cryptographic key material

string

>= 7 characters <= 1024 characters

operator

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

string

<= 1024 characters

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

Configuration parameter for values

Array<string>

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

Key-value label for organization

object

maxSkew

MaxSkew describes the degree to which pods may be unevenly distributed. It’s the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: +-------+-------+-------+ | zone1 | zone2 | zone3 | +-------+-------+-------+ | P | P | | +-------+-------+-------+

• if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1).
• if MaxSkew is 2, incoming pod can be scheduled onto any zone. It’s a required field. Default value is 1 and 0 is not allowed.

integer format: int32

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. It’s a required field.

string

<= 1024 characters

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 still schedule it It’s considered as “Unsatisfiable” if and only if placing incoming pod on any topology violates “MaxSkew”. 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.

string

<= 1024 characters

volumes

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes +optional +patchMergeKey=name +patchStrategy=merge,retainKeys

Configuration parameter for volumes

Array<object>

Volume represents a named volume in a pod that may be accessed by any container in the pod.

object

name

Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

volumeSource

object

awsElasticBlockStore

object

fsType

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 TODO: how do we prevent errors in the filesystem from compromising the machine +optional

Type or category classification

string

<= 1024 characters

partition

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

Configuration parameter for partition

integer format: int32

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore +optional

Configuration parameter for readOnly

boolean format: boolean

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Unique identifier for this resource

string

<= 1024 characters

azureDisk

object

cachingMode

Host Caching mode: None, Read Only, Read Write. +optional

Configuration parameter for cachingMode

string

<= 1024 characters

diskName

The Name of the data disk in the blob storage

Human-readable name for this resource

string

<= 1024 characters

diskURI

The URI the data disk in the blob storage

Uniform Resource Identifier

string

<= 1024 characters

fsType

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

Type or category classification

string

<= 1024 characters

kind

Expected values 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

Resource type or kind

string

>= 12 characters <= 1024 characters

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

Configuration parameter for readOnly

boolean format: boolean

azureFile

object

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

Configuration parameter for readOnly

boolean format: boolean

secretName

the name of secret that contains Azure Storage Account Name and Key

Human-readable name for this resource

string

<= 1024 characters

shareName

Share Name

Human-readable name for this resource

string

<= 1024 characters

cephfs

object

monitors

Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Configuration parameter for monitors

Array<string>

path

Optional: Used as the mounted root, rather than the full Ceph tree, default is / +optional

URL path for the endpoint

string

<= 1024 characters

readOnly

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 +optional

Configuration parameter for readOnly

boolean format: boolean

secretFile

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 +optional

Security-related configuration

string

<= 1024 characters

secretRef

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

user

Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional

Configuration parameter for user

string

<= 1024 characters

cinder

object

fsType

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 +optional

Type or category classification

string

<= 1024 characters

readOnly

Optional: 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 +optional

Configuration parameter for readOnly

boolean format: boolean

secretRef

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

volumeID

volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Unique identifier for this resource

string

<= 1024 characters

configMap

object

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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. +optional

Configuration parameter for defaultMode

integer format: int32

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 '..'. +optional

Items in a collection or array

Array<object>

Maps a string key to a path within a volume.

object

key

The key to project.

string

>= 7 characters <= 1024 characters

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. 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. +optional

Configuration parameter for mode

integer format: int32

path

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

string

<= 1024 characters

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the ConfigMap or its keys must be defined +optional

Indicates if this field is optional

boolean format: boolean

csi

object

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.

string

<= 1024 characters

fsType

Filesystem type 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. +optional

Type or category classification

string

<= 1024 characters

nodePublishSecretRef

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

readOnly

Specifies a read-only configuration for the volume. Defaults to false (read/write). +optional

Configuration parameter for readOnly

boolean format: boolean

volumeAttributes

VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. +optional

Configuration parameter for volumeAttributes

object

downwardAPI

object

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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. +optional

Configuration parameter for defaultMode

integer format: int32

items

Items is a list of downward API volume file +optional

Items in a collection or array

Array<object>

DownwardAPIVolumeFile represents information to create the file containing the pod field

object

fieldRef

object

apiVersion

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

Version number or identifier

string

<= 1024 characters

fieldPath

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

string

<= 1024 characters

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. 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. +optional

Configuration parameter for mode

integer format: int32

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

URL path for the endpoint

string

<= 1024 characters

resourceFieldRef

object

containerName

Container name: required for volumes, optional for env vars +optional

Human-readable name for this resource

string

<= 1024 characters

divisor

object

string

Configuration parameter for string

string

<= 1024 characters

resource

Required: resource to select

Configuration parameter for resource

string

<= 1024 characters

emptyDir

object

medium

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 +optional

Configuration parameter for medium

string

<= 1024 characters

sizeLimit

object

string

Configuration parameter for string

string

<= 1024 characters

fc

object

fsType

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. TODO: how do we prevent errors in the filesystem from compromising the machine +optional

Type or category classification

string

<= 1024 characters

lun

Optional: FC target lun number +optional

Configuration parameter for lun

integer format: int32

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

Configuration parameter for readOnly

boolean format: boolean

targetWWNs

Optional: FC target worldwide names (WWNs) +optional

Configuration parameter for targetWWNs

Array<string>

wwids

Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. +optional

Configuration parameter for wwids

Array<string>

flexVolume

object

driver

Driver is the name of the driver to use for this volume.

string

<= 1024 characters

fsType

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

Type or category classification

string

<= 1024 characters

options

Optional: Extra command options if any. +optional

Configuration parameter for options

object

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

Configuration parameter for readOnly

boolean format: boolean

secretRef

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

flocker

object

datasetName

Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated +optional

Data or content configuration

string

<= 1024 characters

datasetUUID

UUID of the dataset. This is unique identifier of a Flocker dataset +optional

Data or content configuration

string

<= 1024 characters

gcePersistentDisk

object

fsType

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 TODO: how do we prevent errors in the filesystem from compromising the machine +optional

Type or category classification

string

<= 1024 characters

partition

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 +optional

Configuration parameter for partition

integer format: int32

pdName

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

Human-readable name for this resource

string

<= 1024 characters

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +optional

Configuration parameter for readOnly

boolean format: boolean

gitRepo

object

directory

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

Configuration parameter for directory

string

<= 1024 characters

repository

Repository URL

Configuration parameter for repository

string

<= 1024 characters

revision

Commit hash for the specified revision. +optional

Configuration parameter for revision

string

<= 1024 characters

glusterfs

object

endpoints

EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

Endpoint or connection point

string

<= 1024 characters

path

Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

URL path for the endpoint

string

<= 1024 characters

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 +optional

Configuration parameter for readOnly

boolean format: boolean

hostPath

object

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

URL path for the endpoint

string

<= 1024 characters

type

Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath +optional

Type or category classification

string

<= 1024 characters

iscsi

object

chapAuthDiscovery

whether support iSCSI Discovery CHAP authentication +optional

Configuration parameter for chapAuthDiscovery

boolean format: boolean

chapAuthSession

whether support iSCSI Session CHAP authentication +optional

Configuration parameter for chapAuthSession

boolean format: boolean

fsType

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 TODO: how do we prevent errors in the filesystem from compromising the machine +optional

Type or category classification

string

<= 1024 characters

initiatorName

Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. +optional

Human-readable name for this resource

string

<= 1024 characters

iqn

Target iSCSI Qualified Name.

string

<= 1024 characters

iscsiInterface

iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). +optional

Configuration parameter for iscsiInterface

string

<= 1024 characters

lun

ISCSI Target Lun number.

integer format: int32

portals

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

Network port number

Array<string>

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. +optional

Configuration parameter for readOnly

boolean format: boolean

secretRef

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

targetPortal

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

string

<= 1024 characters

nfs

object

path

Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

URL path for the endpoint

string

<= 1024 characters

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 +optional

Configuration parameter for readOnly

boolean format: boolean

server

Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Configuration parameter for server

string

<= 1024 characters

persistentVolumeClaim

object

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

Human-readable name for this resource

string

<= 1024 characters

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false. +optional

Configuration parameter for readOnly

boolean format: boolean

photonPersistentDisk

object

fsType

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.

string

<= 1024 characters

pdID

ID that identifies Photon Controller persistent disk

Unique identifier for this resource

string

<= 1024 characters

portworxVolume

object

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.

string

<= 1024 characters

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

Configuration parameter for readOnly

boolean format: boolean

volumeID

VolumeID uniquely identifies a Portworx volume

Unique identifier for this resource

string

<= 1024 characters

projected

object

defaultMode

Mode bits to use on created files by default. Must be a value between 0 and 0777. 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. +optional

Configuration parameter for defaultMode

integer format: int32

sources

list of volume projections

Configuration parameter for sources

Array<object>

Projection that may be projected along with other supported volume types

object

configMap

object

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 '..'. +optional

Items in a collection or array

Array<object>

Maps a string key to a path within a volume.

object

key

The key to project.

string

>= 7 characters <= 1024 characters

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. 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. +optional

Configuration parameter for mode

integer format: int32

path

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

string

<= 1024 characters

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the ConfigMap or its keys must be defined +optional

Indicates if this field is optional

boolean format: boolean

downwardAPI

object

items

Items is a list of DownwardAPIVolume file +optional

Items in a collection or array

Array<object>

DownwardAPIVolumeFile represents information to create the file containing the pod field

object

fieldRef

object

apiVersion

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

Version number or identifier

string

<= 1024 characters

fieldPath

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

string

<= 1024 characters

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. 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. +optional

Configuration parameter for mode

integer format: int32

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

URL path for the endpoint

string

<= 1024 characters

resourceFieldRef

object

containerName

Container name: required for volumes, optional for env vars +optional

Human-readable name for this resource

string

<= 1024 characters

divisor

object

string

Configuration parameter for string

string

<= 1024 characters

resource

Required: resource to select

Configuration parameter for resource

string

<= 1024 characters

secret

object

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 '..'. +optional

Items in a collection or array

Array<object>

Maps a string key to a path within a volume.

object

key

The key to project.

string

>= 7 characters <= 1024 characters

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. 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. +optional

Configuration parameter for mode

integer format: int32

path

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

string

<= 1024 characters

localObjectReference

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

optional

Specify whether the Secret or its key must be defined +optional

Indicates if this field is optional

boolean format: boolean

serviceAccountToken

object

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

Configuration parameter for audience

string

<= 1024 characters

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

Security-related configuration

string format: int64

<= 1024 characters

path

Path is the path relative to the mount point of the file to project the token into.

string

<= 1024 characters

quobyte

object

group

Group to map volume access to Default is no group +optional

Configuration parameter for group

string

<= 1024 characters

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. +optional

Configuration parameter for readOnly

boolean format: boolean

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

Configuration parameter for registry

string

<= 1024 characters

tenant

Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin +optional

Tenant identifier for multi-tenancy

string

>= 6 characters <= 1024 characters

user

User to map volume access to Defaults to serivceaccount user +optional

Configuration parameter for user

string

<= 1024 characters

volume

Volume is a string that references an already created Quobyte volume by name.

string

<= 1024 characters

rbd

object

fsType

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 TODO: how do we prevent errors in the filesystem from compromising the machine +optional

Type or category classification

string

<= 1024 characters

image

The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Configuration parameter for image

string

<= 1024 characters

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 +optional

Configuration parameter for keyring

string

<= 1024 characters

monitors

A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Configuration parameter for monitors

Array<string>

pool

The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional

Configuration parameter for pool

string

<= 1024 characters

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 +optional

Configuration parameter for readOnly

boolean format: boolean

secretRef

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

user

The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional

Configuration parameter for user

string

<= 1024 characters

scaleIO

object

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". +optional

Type or category classification

string

<= 1024 characters

gateway

The host address of the ScaleIO API Gateway.

string

<= 1024 characters

protectionDomain

The name of the ScaleIO Protection Domain for the configured storage. +optional

Configuration parameter for protectionDomain

string

<= 1024 characters

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

Configuration parameter for readOnly

boolean format: boolean

secretRef

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

sslEnabled

Flag to enable/disable SSL communication with Gateway, default false +optional

Enable or disable functionality flag

boolean format: boolean

storageMode

Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. +optional

Configuration parameter for storageMode

string

<= 1024 characters

storagePool

The ScaleIO Storage Pool associated with the protection domain. +optional

Configuration parameter for storagePool

string

<= 1024 characters

system

The name of the storage system as configured in ScaleIO.

string

<= 1024 characters

volumeName

The name of a volume already created in the ScaleIO system that is associated with this volume source.

string

<= 1024 characters

secret

object

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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. +optional

Configuration parameter for defaultMode

integer format: int32

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 '..'. +optional

Items in a collection or array

Array<object>

Maps a string key to a path within a volume.

object

key

The key to project.

string

>= 7 characters <= 1024 characters

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. 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. +optional

Configuration parameter for mode

integer format: int32

path

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

string

<= 1024 characters

optional

Specify whether the Secret or its keys must be defined +optional

Indicates if this field is optional

boolean format: boolean

secretName

Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +optional

Human-readable name for this resource

string

<= 1024 characters

storageos

object

fsType

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

Type or category classification

string

<= 1024 characters

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

Configuration parameter for readOnly

boolean format: boolean

secretRef

object

name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

volumeName

VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

string

<= 1024 characters

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

Namespace for resource isolation

string

<= 1024 characters

vsphereVolume

object

fsType

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

Type or category classification

string

<= 1024 characters

storagePolicyID

Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. +optional

Unique identifier for this resource

string

<= 1024 characters

storagePolicyName

Storage Policy Based Management (SPBM) profile name. +optional

Human-readable name for this resource

string

<= 1024 characters

volumePath

Path that identifies vSphere volume vmdk

File system or URL path

string

<= 1024 characters

status

object

availableReplicas

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. +optional

Configuration parameter for availableReplicas

integer format: int32

collisionCount

Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet. +optional

Number of items or occurrences

integer format: int32

conditions

Represents the latest available observations of a deployment's current state. +patchMergeKey=type +patchStrategy=merge

Configuration parameter for conditions

Array<object>

DeploymentCondition describes the state of a deployment at a certain point.

object

lastTransitionTime

object

nanos

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

integer format: int32

seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

string format: int64

<= 1024 characters

lastUpdateTime

object

nanos

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

integer format: int32

seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

string format: int64

<= 1024 characters

message

A human readable message indicating details about the transition.

string

<= 1024 characters

reason

The reason for the condition’s last transition.

string

>= 27 characters <= 1024 characters

status

Status of the condition, one of True, False, Unknown.

string

>= 17 characters <= 1024 characters

type

Type of deployment condition.

string

<= 1024 characters

observedGeneration

The generation observed by the deployment controller. +optional

Configuration parameter for observedGeneration

string format: int64

<= 1024 characters

readyReplicas

Total number of ready pods targeted by this deployment. +optional

Configuration parameter for readyReplicas

integer format: int32

replicas

Total number of non-terminated pods targeted by this deployment (their labels match the selector). +optional

Configuration parameter for replicas

integer format: int32

unavailableReplicas

Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created. +optional

Configuration parameter for unavailableReplicas

integer format: int32

updatedReplicas

Total number of non-terminated pods targeted by this deployment that have the desired template spec. +optional

Configuration parameter for updatedReplicas

integer format: int32

metadata

object

continue

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

string

0 <= 1024 characters

remainingItemCount

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

Number of items or occurrences

string format: int64

<= 1024 characters

resourceVersion

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

Version number or identifier

string

0 <= 1024 characters

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. +optional.

string

0 <= 1024 characters

Example^generated

{
  "items": [
    {
      "metadata": {
        "annotations": {},
        "clusterName": "example",
        "creationTimestamp": {
          "nanos": 1,
          "seconds": "example"
        },
        "deletionGracePeriodSeconds": "example",
        "deletionTimestamp": {
          "nanos": 1,
          "seconds": "example"
        },
        "finalizers": [
          "example"
        ],
        "generateName": "example",
        "generation": "example",
        "labels": {},
        "managedFields": [
          {
            "apiVersion": "example",
            "fieldsType": "example",
            "fieldsV1": {
              "Raw": "example"
            },
            "manager": "example",
            "operation": "example",
            "time": {
              "nanos": 1,
              "seconds": "example"
            }
          }
        ],
        "name": "example",
        "namespace": "example",
        "ownerReferences": [
          {
            "apiVersion": "example",
            "blockOwnerDeletion": true,
            "controller": true,
            "kind": "example",
            "name": "example",
            "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
          }
        ],
        "resourceVersion": "example",
        "selfLink": "example",
        "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      },
      "spec": {
        "minReadySeconds": 1,
        "paused": true,
        "progressDeadlineSeconds": 1,
        "replicas": 1,
        "revisionHistoryLimit": 1,
        "selector": {
          "matchExpressions": [
            {
              "key": "example",
              "operator": "example",
              "values": [
                "example"
              ]
            }
          ],
          "matchLabels": {}
        },
        "strategy": {
          "rollingUpdate": {
            "maxSurge": {
              "intVal": 1,
              "strVal": "example",
              "type": "example"
            },
            "maxUnavailable": {
              "intVal": 1,
              "strVal": "example",
              "type": "example"
            }
          },
          "type": "example"
        },
        "template": {
          "metadata": {
            "annotations": {},
            "clusterName": "example",
            "creationTimestamp": {
              "nanos": 1,
              "seconds": "example"
            },
            "deletionGracePeriodSeconds": "example",
            "deletionTimestamp": {
              "nanos": 1,
              "seconds": "example"
            },
            "finalizers": [
              "example"
            ],
            "generateName": "example",
            "generation": "example",
            "labels": {},
            "managedFields": [
              {
                "apiVersion": "example",
                "fieldsType": "example",
                "fieldsV1": {
                  "Raw": "example"
                },
                "manager": "example",
                "operation": "example",
                "time": {
                  "nanos": 1,
                  "seconds": "example"
                }
              }
            ],
            "name": "example",
            "namespace": "example",
            "ownerReferences": [
              {
                "apiVersion": "example",
                "blockOwnerDeletion": true,
                "controller": true,
                "kind": "example",
                "name": "example",
                "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
              }
            ],
            "resourceVersion": "example",
            "selfLink": "example",
            "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
          },
          "spec": {
            "activeDeadlineSeconds": "example",
            "affinity": {
              "nodeAffinity": {
                "preferredDuringSchedulingIgnoredDuringExecution": [
                  {
                    "preference": {
                      "matchExpressions": [
                        {
                          "key": "example",
                          "operator": "example",
                          "values": [
                            "example"
                          ]
                        }
                      ],
                      "matchFields": [
                        {
                          "key": "example",
                          "operator": "example",
                          "values": [
                            "example"
                          ]
                        }
                      ]
                    },
                    "weight": 1
                  }
                ],
                "requiredDuringSchedulingIgnoredDuringExecution": {
                  "nodeSelectorTerms": [
                    {
                      "matchExpressions": [
                        {
                          "key": "example",
                          "operator": "example",
                          "values": [
                            "example"
                          ]
                        }
                      ],
                      "matchFields": [
                        {
                          "key": "example",
                          "operator": "example",
                          "values": [
                            "example"
                          ]
                        }
                      ]
                    }
                  ]
                }
              },
              "podAffinity": {
                "preferredDuringSchedulingIgnoredDuringExecution": [
                  {
                    "podAffinityTerm": {
                      "labelSelector": {
                        "matchExpressions": [
                          {
                            "key": "example",
                            "operator": "example",
                            "values": [
                              "example"
                            ]
                          }
                        ],
                        "matchLabels": {}
                      },
                      "namespaces": [
                        "example"
                      ],
                      "topologyKey": "example"
                    },
                    "weight": 1
                  }
                ],
                "requiredDuringSchedulingIgnoredDuringExecution": [
                  {
                    "labelSelector": {
                      "matchExpressions": [
                        {
                          "key": "example",
                          "operator": "example",
                          "values": [
                            "example"
                          ]
                        }
                      ],
                      "matchLabels": {}
                    },
                    "namespaces": [
                      "example"
                    ],
                    "topologyKey": "example"
                  }
                ]
              },
              "podAntiAffinity": {
                "preferredDuringSchedulingIgnoredDuringExecution": [
                  {
                    "podAffinityTerm": {
                      "labelSelector": {
                        "matchExpressions": [
                          {
                            "key": "example",
                            "operator": "example",
                            "values": [
                              "example"
                            ]
                          }
                        ],
                        "matchLabels": {}
                      },
                      "namespaces": [
                        "example"
                      ],
                      "topologyKey": "example"
                    },
                    "weight": 1
                  }
                ],
                "requiredDuringSchedulingIgnoredDuringExecution": [
                  {
                    "labelSelector": {
                      "matchExpressions": [
                        {
                          "key": "example",
                          "operator": "example",
                          "values": [
                            "example"
                          ]
                        }
                      ],
                      "matchLabels": {}
                    },
                    "namespaces": [
                      "example"
                    ],
                    "topologyKey": "example"
                  }
                ]
              }
            },
            "automountServiceAccountToken": true,
            "containers": [
              {
                "args": [
                  "example"
                ],
                "command": [
                  "example"
                ],
                "env": [
                  {
                    "name": "example",
                    "value": "example",
                    "valueFrom": {
                      "configMapKeyRef": {
                        "key": "example",
                        "localObjectReference": {
                          "name": "example"
                        },
                        "optional": true
                      },
                      "fieldRef": {
                        "apiVersion": "example",
                        "fieldPath": "example"
                      },
                      "resourceFieldRef": {
                        "containerName": "example",
                        "divisor": {
                          "string": "example"
                        },
                        "resource": "example"
                      },
                      "secretKeyRef": {
                        "key": "example",
                        "localObjectReference": {
                          "name": "example"
                        },
                        "optional": true
                      }
                    }
                  }
                ],
                "envFrom": [
                  {
                    "configMapRef": {
                      "localObjectReference": {
                        "name": "example"
                      },
                      "optional": true
                    },
                    "prefix": "example",
                    "secretRef": {
                      "localObjectReference": {
                        "name": "example"
                      },
                      "optional": true
                    }
                  }
                ],
                "image": "example",
                "imagePullPolicy": "example",
                "lifecycle": {
                  "postStart": {
                    "exec": {
                      "command": [
                        "example"
                      ]
                    },
                    "httpGet": {
                      "host": "example",
                      "httpHeaders": [
                        {
                          "name": "example",
                          "value": "example"
                        }
                      ],
                      "path": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      },
                      "scheme": "example"
                    },
                    "tcpSocket": {
                      "host": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      }
                    }
                  },
                  "preStop": {
                    "exec": {
                      "command": [
                        "example"
                      ]
                    },
                    "httpGet": {
                      "host": "example",
                      "httpHeaders": [
                        {
                          "name": "example",
                          "value": "example"
                        }
                      ],
                      "path": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      },
                      "scheme": "example"
                    },
                    "tcpSocket": {
                      "host": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      }
                    }
                  }
                },
                "livenessProbe": {
                  "failureThreshold": 1,
                  "handler": {
                    "exec": {
                      "command": [
                        "example"
                      ]
                    },
                    "httpGet": {
                      "host": "example",
                      "httpHeaders": [
                        {
                          "name": "example",
                          "value": "example"
                        }
                      ],
                      "path": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      },
                      "scheme": "example"
                    },
                    "tcpSocket": {
                      "host": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      }
                    }
                  },
                  "initialDelaySeconds": 1,
                  "periodSeconds": 1,
                  "successThreshold": 1,
                  "timeoutSeconds": 1
                },
                "name": "example",
                "ports": [
                  {
                    "containerPort": 1,
                    "hostIP": "example",
                    "hostPort": 1,
                    "name": "example",
                    "protocol": "example"
                  }
                ],
                "readinessProbe": {
                  "failureThreshold": 1,
                  "handler": {
                    "exec": {
                      "command": [
                        "example"
                      ]
                    },
                    "httpGet": {
                      "host": "example",
                      "httpHeaders": [
                        {
                          "name": "example",
                          "value": "example"
                        }
                      ],
                      "path": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      },
                      "scheme": "example"
                    },
                    "tcpSocket": {
                      "host": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      }
                    }
                  },
                  "initialDelaySeconds": 1,
                  "periodSeconds": 1,
                  "successThreshold": 1,
                  "timeoutSeconds": 1
                },
                "resources": {
                  "limits": {},
                  "requests": {}
                },
                "securityContext": {
                  "allowPrivilegeEscalation": true,
                  "capabilities": {
                    "add": [
                      "example"
                    ],
                    "drop": [
                      "example"
                    ]
                  },
                  "privileged": true,
                  "procMount": "example",
                  "readOnlyRootFilesystem": true,
                  "runAsGroup": "example",
                  "runAsNonRoot": true,
                  "runAsUser": "example",
                  "seLinuxOptions": {
                    "level": "example",
                    "role": "example",
                    "type": "example",
                    "user": "example"
                  },
                  "windowsOptions": {
                    "gmsaCredentialSpec": "example",
                    "gmsaCredentialSpecName": "example",
                    "runAsUserName": "example"
                  }
                },
                "startupProbe": {
                  "failureThreshold": 1,
                  "handler": {
                    "exec": {
                      "command": [
                        "example"
                      ]
                    },
                    "httpGet": {
                      "host": "example",
                      "httpHeaders": [
                        {
                          "name": "example",
                          "value": "example"
                        }
                      ],
                      "path": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      },
                      "scheme": "example"
                    },
                    "tcpSocket": {
                      "host": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      }
                    }
                  },
                  "initialDelaySeconds": 1,
                  "periodSeconds": 1,
                  "successThreshold": 1,
                  "timeoutSeconds": 1
                },
                "stdin": true,
                "stdinOnce": true,
                "terminationMessagePath": "example",
                "terminationMessagePolicy": "example",
                "tty": true,
                "volumeDevices": [
                  {
                    "devicePath": "example",
                    "name": "example"
                  }
                ],
                "volumeMounts": [
                  {
                    "mountPath": "example",
                    "mountPropagation": "example",
                    "name": "example",
                    "readOnly": true,
                    "subPath": "example",
                    "subPathExpr": "example"
                  }
                ],
                "workingDir": "example"
              }
            ],
            "dnsConfig": {
              "nameservers": [
                "example"
              ],
              "options": [
                {
                  "name": "example",
                  "value": "example"
                }
              ],
              "searches": [
                "example"
              ]
            },
            "dnsPolicy": "example",
            "enableServiceLinks": true,
            "ephemeralContainers": [
              {
                "ephemeralContainerCommon": {
                  "args": [
                    "example"
                  ],
                  "command": [
                    "example"
                  ],
                  "env": [
                    {
                      "name": "example",
                      "value": "example",
                      "valueFrom": {
                        "configMapKeyRef": {
                          "key": "example",
                          "localObjectReference": {
                            "name": "example"
                          },
                          "optional": true
                        },
                        "fieldRef": {
                          "apiVersion": "example",
                          "fieldPath": "example"
                        },
                        "resourceFieldRef": {
                          "containerName": "example",
                          "divisor": {
                            "string": "example"
                          },
                          "resource": "example"
                        },
                        "secretKeyRef": {
                          "key": "example",
                          "localObjectReference": {
                            "name": "example"
                          },
                          "optional": true
                        }
                      }
                    }
                  ],
                  "envFrom": [
                    {
                      "configMapRef": {
                        "localObjectReference": {
                          "name": "example"
                        },
                        "optional": true
                      },
                      "prefix": "example",
                      "secretRef": {
                        "localObjectReference": {
                          "name": "example"
                        },
                        "optional": true
                      }
                    }
                  ],
                  "image": "example",
                  "imagePullPolicy": "example",
                  "lifecycle": {
                    "postStart": {
                      "exec": {
                        "command": [
                          "example"
                        ]
                      },
                      "httpGet": {
                        "host": "example",
                        "httpHeaders": [
                          {
                            "name": "example",
                            "value": "example"
                          }
                        ],
                        "path": "example",
                        "port": {
                          "intVal": 1,
                          "strVal": "example",
                          "type": "example"
                        },
                        "scheme": "example"
                      },
                      "tcpSocket": {
                        "host": "example",
                        "port": {
                          "intVal": 1,
                          "strVal": "example",
                          "type": "example"
                        }
                      }
                    },
                    "preStop": {
                      "exec": {
                        "command": [
                          "example"
                        ]
                      },
                      "httpGet": {
                        "host": "example",
                        "httpHeaders": [
                          {
                            "name": "example",
                            "value": "example"
                          }
                        ],
                        "path": "example",
                        "port": {
                          "intVal": 1,
                          "strVal": "example",
                          "type": "example"
                        },
                        "scheme": "example"
                      },
                      "tcpSocket": {
                        "host": "example",
                        "port": {
                          "intVal": 1,
                          "strVal": "example",
                          "type": "example"
                        }
                      }
                    }
                  },
                  "livenessProbe": {
                    "failureThreshold": 1,
                    "handler": {
                      "exec": {
                        "command": [
                          "example"
                        ]
                      },
                      "httpGet": {
                        "host": "example",
                        "httpHeaders": [
                          {
                            "name": "example",
                            "value": "example"
                          }
                        ],
                        "path": "example",
                        "port": {
                          "intVal": 1,
                          "strVal": "example",
                          "type": "example"
                        },
                        "scheme": "example"
                      },
                      "tcpSocket": {
                        "host": "example",
                        "port": {
                          "intVal": 1,
                          "strVal": "example",
                          "type": "example"
                        }
                      }
                    },
                    "initialDelaySeconds": 1,
                    "periodSeconds": 1,
                    "successThreshold": 1,
                    "timeoutSeconds": 1
                  },
                  "name": "example",
                  "ports": [
                    {
                      "containerPort": 1,
                      "hostIP": "example",
                      "hostPort": 1,
                      "name": "example",
                      "protocol": "example"
                    }
                  ],
                  "readinessProbe": {
                    "failureThreshold": 1,
                    "handler": {
                      "exec": {
                        "command": [
                          "example"
                        ]
                      },
                      "httpGet": {
                        "host": "example",
                        "httpHeaders": [
                          {
                            "name": "example",
                            "value": "example"
                          }
                        ],
                        "path": "example",
                        "port": {
                          "intVal": 1,
                          "strVal": "example",
                          "type": "example"
                        },
                        "scheme": "example"
                      },
                      "tcpSocket": {
                        "host": "example",
                        "port": {
                          "intVal": 1,
                          "strVal": "example",
                          "type": "example"
                        }
                      }
                    },
                    "initialDelaySeconds": 1,
                    "periodSeconds": 1,
                    "successThreshold": 1,
                    "timeoutSeconds": 1
                  },
                  "resources": {
                    "limits": {},
                    "requests": {}
                  },
                  "securityContext": {
                    "allowPrivilegeEscalation": true,
                    "capabilities": {
                      "add": [
                        "example"
                      ],
                      "drop": [
                        "example"
                      ]
                    },
                    "privileged": true,
                    "procMount": "example",
                    "readOnlyRootFilesystem": true,
                    "runAsGroup": "example",
                    "runAsNonRoot": true,
                    "runAsUser": "example",
                    "seLinuxOptions": {
                      "level": "example",
                      "role": "example",
                      "type": "example",
                      "user": "example"
                    },
                    "windowsOptions": {
                      "gmsaCredentialSpec": "example",
                      "gmsaCredentialSpecName": "example",
                      "runAsUserName": "example"
                    }
                  },
                  "startupProbe": {
                    "failureThreshold": 1,
                    "handler": {
                      "exec": {
                        "command": [
                          "example"
                        ]
                      },
                      "httpGet": {
                        "host": "example",
                        "httpHeaders": [
                          {
                            "name": "example",
                            "value": "example"
                          }
                        ],
                        "path": "example",
                        "port": {
                          "intVal": 1,
                          "strVal": "example",
                          "type": "example"
                        },
                        "scheme": "example"
                      },
                      "tcpSocket": {
                        "host": "example",
                        "port": {
                          "intVal": 1,
                          "strVal": "example",
                          "type": "example"
                        }
                      }
                    },
                    "initialDelaySeconds": 1,
                    "periodSeconds": 1,
                    "successThreshold": 1,
                    "timeoutSeconds": 1
                  },
                  "stdin": true,
                  "stdinOnce": true,
                  "terminationMessagePath": "example",
                  "terminationMessagePolicy": "example",
                  "tty": true,
                  "volumeDevices": [
                    {
                      "devicePath": "example",
                      "name": "example"
                    }
                  ],
                  "volumeMounts": [
                    {
                      "mountPath": "example",
                      "mountPropagation": "example",
                      "name": "example",
                      "readOnly": true,
                      "subPath": "example",
                      "subPathExpr": "example"
                    }
                  ],
                  "workingDir": "example"
                },
                "targetContainerName": "example"
              }
            ],
            "hostAliases": [
              {
                "hostnames": [
                  "example"
                ],
                "ip": "example"
              }
            ],
            "hostIPC": true,
            "hostNetwork": true,
            "hostPID": true,
            "hostname": "example",
            "imagePullSecrets": [
              {
                "name": "example"
              }
            ],
            "initContainers": [
              {
                "args": [
                  "example"
                ],
                "command": [
                  "example"
                ],
                "env": [
                  {
                    "name": "example",
                    "value": "example",
                    "valueFrom": {
                      "configMapKeyRef": {
                        "key": "example",
                        "localObjectReference": {
                          "name": "example"
                        },
                        "optional": true
                      },
                      "fieldRef": {
                        "apiVersion": "example",
                        "fieldPath": "example"
                      },
                      "resourceFieldRef": {
                        "containerName": "example",
                        "divisor": {
                          "string": "example"
                        },
                        "resource": "example"
                      },
                      "secretKeyRef": {
                        "key": "example",
                        "localObjectReference": {
                          "name": "example"
                        },
                        "optional": true
                      }
                    }
                  }
                ],
                "envFrom": [
                  {
                    "configMapRef": {
                      "localObjectReference": {
                        "name": "example"
                      },
                      "optional": true
                    },
                    "prefix": "example",
                    "secretRef": {
                      "localObjectReference": {
                        "name": "example"
                      },
                      "optional": true
                    }
                  }
                ],
                "image": "example",
                "imagePullPolicy": "example",
                "lifecycle": {
                  "postStart": {
                    "exec": {
                      "command": [
                        "example"
                      ]
                    },
                    "httpGet": {
                      "host": "example",
                      "httpHeaders": [
                        {
                          "name": "example",
                          "value": "example"
                        }
                      ],
                      "path": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      },
                      "scheme": "example"
                    },
                    "tcpSocket": {
                      "host": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      }
                    }
                  },
                  "preStop": {
                    "exec": {
                      "command": [
                        "example"
                      ]
                    },
                    "httpGet": {
                      "host": "example",
                      "httpHeaders": [
                        {
                          "name": "example",
                          "value": "example"
                        }
                      ],
                      "path": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      },
                      "scheme": "example"
                    },
                    "tcpSocket": {
                      "host": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      }
                    }
                  }
                },
                "livenessProbe": {
                  "failureThreshold": 1,
                  "handler": {
                    "exec": {
                      "command": [
                        "example"
                      ]
                    },
                    "httpGet": {
                      "host": "example",
                      "httpHeaders": [
                        {
                          "name": "example",
                          "value": "example"
                        }
                      ],
                      "path": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      },
                      "scheme": "example"
                    },
                    "tcpSocket": {
                      "host": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      }
                    }
                  },
                  "initialDelaySeconds": 1,
                  "periodSeconds": 1,
                  "successThreshold": 1,
                  "timeoutSeconds": 1
                },
                "name": "example",
                "ports": [
                  {
                    "containerPort": 1,
                    "hostIP": "example",
                    "hostPort": 1,
                    "name": "example",
                    "protocol": "example"
                  }
                ],
                "readinessProbe": {
                  "failureThreshold": 1,
                  "handler": {
                    "exec": {
                      "command": [
                        "example"
                      ]
                    },
                    "httpGet": {
                      "host": "example",
                      "httpHeaders": [
                        {
                          "name": "example",
                          "value": "example"
                        }
                      ],
                      "path": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      },
                      "scheme": "example"
                    },
                    "tcpSocket": {
                      "host": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      }
                    }
                  },
                  "initialDelaySeconds": 1,
                  "periodSeconds": 1,
                  "successThreshold": 1,
                  "timeoutSeconds": 1
                },
                "resources": {
                  "limits": {},
                  "requests": {}
                },
                "securityContext": {
                  "allowPrivilegeEscalation": true,
                  "capabilities": {
                    "add": [
                      "example"
                    ],
                    "drop": [
                      "example"
                    ]
                  },
                  "privileged": true,
                  "procMount": "example",
                  "readOnlyRootFilesystem": true,
                  "runAsGroup": "example",
                  "runAsNonRoot": true,
                  "runAsUser": "example",
                  "seLinuxOptions": {
                    "level": "example",
                    "role": "example",
                    "type": "example",
                    "user": "example"
                  },
                  "windowsOptions": {
                    "gmsaCredentialSpec": "example",
                    "gmsaCredentialSpecName": "example",
                    "runAsUserName": "example"
                  }
                },
                "startupProbe": {
                  "failureThreshold": 1,
                  "handler": {
                    "exec": {
                      "command": [
                        "example"
                      ]
                    },
                    "httpGet": {
                      "host": "example",
                      "httpHeaders": [
                        {
                          "name": "example",
                          "value": "example"
                        }
                      ],
                      "path": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      },
                      "scheme": "example"
                    },
                    "tcpSocket": {
                      "host": "example",
                      "port": {
                        "intVal": 1,
                        "strVal": "example",
                        "type": "example"
                      }
                    }
                  },
                  "initialDelaySeconds": 1,
                  "periodSeconds": 1,
                  "successThreshold": 1,
                  "timeoutSeconds": 1
                },
                "stdin": true,
                "stdinOnce": true,
                "terminationMessagePath": "example",
                "terminationMessagePolicy": "example",
                "tty": true,
                "volumeDevices": [
                  {
                    "devicePath": "example",
                    "name": "example"
                  }
                ],
                "volumeMounts": [
                  {
                    "mountPath": "example",
                    "mountPropagation": "example",
                    "name": "example",
                    "readOnly": true,
                    "subPath": "example",
                    "subPathExpr": "example"
                  }
                ],
                "workingDir": "example"
              }
            ],
            "nodeName": "example",
            "nodeSelector": {},
            "overhead": {},
            "preemptionPolicy": "example",
            "priority": 1,
            "priorityClassName": "example",
            "readinessGates": [
              {
                "conditionType": "example"
              }
            ],
            "restartPolicy": "example",
            "runtimeClassName": "example",
            "schedulerName": "example",
            "securityContext": {
              "fsGroup": "example",
              "runAsGroup": "example",
              "runAsNonRoot": true,
              "runAsUser": "example",
              "seLinuxOptions": {
                "level": "example",
                "role": "example",
                "type": "example",
                "user": "example"
              },
              "supplementalGroups": [
                "example"
              ],
              "sysctls": [
                {
                  "name": "example",
                  "value": "example"
                }
              ],
              "windowsOptions": {
                "gmsaCredentialSpec": "example",
                "gmsaCredentialSpecName": "example",
                "runAsUserName": "example"
              }
            },
            "serviceAccount": "example",
            "serviceAccountName": "example",
            "shareProcessNamespace": true,
            "subdomain": "example",
            "terminationGracePeriodSeconds": "example",
            "tolerations": [
              {
                "effect": "example",
                "key": "example",
                "operator": "example",
                "tolerationSeconds": "example",
                "value": "example"
              }
            ],
            "topologySpreadConstraints": [
              {
                "labelSelector": {
                  "matchExpressions": [
                    {
                      "key": "example",
                      "operator": "example",
                      "values": [
                        "example"
                      ]
                    }
                  ],
                  "matchLabels": {}
                },
                "maxSkew": 1,
                "topologyKey": "example",
                "whenUnsatisfiable": "example"
              }
            ],
            "volumes": [
              {
                "name": "example",
                "volumeSource": {
                  "awsElasticBlockStore": {
                    "fsType": "example",
                    "partition": 1,
                    "readOnly": true,
                    "volumeID": "example"
                  },
                  "azureDisk": {
                    "cachingMode": "example",
                    "diskName": "example",
                    "diskURI": "example",
                    "fsType": "example",
                    "kind": "example",
                    "readOnly": true
                  },
                  "azureFile": {
                    "readOnly": true,
                    "secretName": "example",
                    "shareName": "example"
                  },
                  "cephfs": {
                    "monitors": [
                      "example"
                    ],
                    "path": "example",
                    "readOnly": true,
                    "secretFile": "example",
                    "secretRef": {
                      "name": "example"
                    },
                    "user": "example"
                  },
                  "cinder": {
                    "fsType": "example",
                    "readOnly": true,
                    "secretRef": {
                      "name": "example"
                    },
                    "volumeID": "example"
                  },
                  "configMap": {
                    "defaultMode": 1,
                    "items": [
                      {
                        "key": "example",
                        "mode": 1,
                        "path": "example"
                      }
                    ],
                    "localObjectReference": {
                      "name": "example"
                    },
                    "optional": true
                  },
                  "csi": {
                    "driver": "example",
                    "fsType": "example",
                    "nodePublishSecretRef": {
                      "name": "example"
                    },
                    "readOnly": true,
                    "volumeAttributes": {}
                  },
                  "downwardAPI": {
                    "defaultMode": 1,
                    "items": [
                      {
                        "fieldRef": {
                          "apiVersion": "example",
                          "fieldPath": "example"
                        },
                        "mode": 1,
                        "path": "example",
                        "resourceFieldRef": {
                          "containerName": "example",
                          "divisor": {
                            "string": "example"
                          },
                          "resource": "example"
                        }
                      }
                    ]
                  },
                  "emptyDir": {
                    "medium": "example",
                    "sizeLimit": {
                      "string": "example"
                    }
                  },
                  "fc": {
                    "fsType": "example",
                    "lun": 1,
                    "readOnly": true,
                    "targetWWNs": [
                      "example"
                    ],
                    "wwids": [
                      "example"
                    ]
                  },
                  "flexVolume": {
                    "driver": "example",
                    "fsType": "example",
                    "options": {},
                    "readOnly": true,
                    "secretRef": {
                      "name": "example"
                    }
                  },
                  "flocker": {
                    "datasetName": "example",
                    "datasetUUID": "example"
                  },
                  "gcePersistentDisk": {
                    "fsType": "example",
                    "partition": 1,
                    "pdName": "example",
                    "readOnly": true
                  },
                  "gitRepo": {
                    "directory": "example",
                    "repository": "example",
                    "revision": "example"
                  },
                  "glusterfs": {
                    "endpoints": "example",
                    "path": "example",
                    "readOnly": true
                  },
                  "hostPath": {
                    "path": "example",
                    "type": "example"
                  },
                  "iscsi": {
                    "chapAuthDiscovery": true,
                    "chapAuthSession": true,
                    "fsType": "example",
                    "initiatorName": "example",
                    "iqn": "example",
                    "iscsiInterface": "example",
                    "lun": 1,
                    "portals": [
                      "example"
                    ],
                    "readOnly": true,
                    "secretRef": {
                      "name": "example"
                    },
                    "targetPortal": "example"
                  },
                  "nfs": {
                    "path": "example",
                    "readOnly": true,
                    "server": "example"
                  },
                  "persistentVolumeClaim": {
                    "claimName": "example",
                    "readOnly": true
                  },
                  "photonPersistentDisk": {
                    "fsType": "example",
                    "pdID": "example"
                  },
                  "portworxVolume": {
                    "fsType": "example",
                    "readOnly": true,
                    "volumeID": "example"
                  },
                  "projected": {
                    "defaultMode": 1,
                    "sources": [
                      {
                        "configMap": {
                          "items": [
                            {
                              "key": "example",
                              "mode": 1,
                              "path": "example"
                            }
                          ],
                          "localObjectReference": {
                            "name": "example"
                          },
                          "optional": true
                        },
                        "downwardAPI": {
                          "items": [
                            {
                              "fieldRef": {
                                "apiVersion": "example",
                                "fieldPath": "example"
                              },
                              "mode": 1,
                              "path": "example",
                              "resourceFieldRef": {
                                "containerName": "example",
                                "divisor": {
                                  "string": "example"
                                },
                                "resource": "example"
                              }
                            }
                          ]
                        },
                        "secret": {
                          "items": [
                            {
                              "key": "example",
                              "mode": 1,
                              "path": "example"
                            }
                          ],
                          "localObjectReference": {
                            "name": "example"
                          },
                          "optional": true
                        },
                        "serviceAccountToken": {
                          "audience": "example",
                          "expirationSeconds": "example",
                          "path": "example"
                        }
                      }
                    ]
                  },
                  "quobyte": {
                    "group": "example",
                    "readOnly": true,
                    "registry": "example",
                    "tenant": "example",
                    "user": "example",
                    "volume": "example"
                  },
                  "rbd": {
                    "fsType": "example",
                    "image": "example",
                    "keyring": "example",
                    "monitors": [
                      "example"
                    ],
                    "pool": "example",
                    "readOnly": true,
                    "secretRef": {
                      "name": "example"
                    },
                    "user": "example"
                  },
                  "scaleIO": {
                    "fsType": "example",
                    "gateway": "example",
                    "protectionDomain": "example",
                    "readOnly": true,
                    "secretRef": {
                      "name": "example"
                    },
                    "sslEnabled": true,
                    "storageMode": "example",
                    "storagePool": "example",
                    "system": "example",
                    "volumeName": "example"
                  },
                  "secret": {
                    "defaultMode": 1,
                    "items": [
                      {
                        "key": "example",
                        "mode": 1,
                        "path": "example"
                      }
                    ],
                    "optional": true,
                    "secretName": "example"
                  },
                  "storageos": {
                    "fsType": "example",
                    "readOnly": true,
                    "secretRef": {
                      "name": "example"
                    },
                    "volumeName": "example",
                    "volumeNamespace": "example"
                  },
                  "vsphereVolume": {
                    "fsType": "example",
                    "storagePolicyID": "example",
                    "storagePolicyName": "example",
                    "volumePath": "example"
                  }
                }
              }
            ]
          }
        }
      },
      "status": {
        "availableReplicas": 1,
        "collisionCount": 1,
        "conditions": [
          {
            "lastTransitionTime": {
              "nanos": 1,
              "seconds": "example"
            },
            "lastUpdateTime": {
              "nanos": 1,
              "seconds": "example"
            },
            "message": "example",
            "reason": "example",
            "status": "example",
            "type": "example"
          }
        ],
        "observedGeneration": "example",
        "readyReplicas": 1,
        "replicas": 1,
        "unavailableReplicas": 1,
        "updatedReplicas": 1
      }
    }
  ],
  "metadata": {
    "continue": "example",
    "remainingItemCount": "example",
    "resourceVersion": "example",
    "selfLink": "example"
  }
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example