ClusterServiceVersion [operators.coreos.com/v1alpha1]

Description
ClusterServiceVersion is a Custom Resource of type `ClusterServiceVersionSpec`.
Type
object
Required
metadataspec

Specification

PropertyTypeDescription
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

ClusterServiceVersionSpec declarations tell OLM how to install an operator that can manage apps for a given version.

statusobject

ClusterServiceVersionStatus represents information about the status of a CSV. Status may trail the actual state of a system.

.spec

Description
ClusterServiceVersionSpec declarations tell OLM how to install an operator that can manage apps for a given version.
Type
object
Required
displayNameinstall
PropertyTypeDescription
annotationsobject

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.

apiservicedefinitionsobject

APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion.

cleanupobject

Cleanup specifies the cleanup behaviour when the CSV gets deleted

customresourcedefinitionsobject

CustomResourceDefinitions declares all of the CRDs managed or required by an operator being ran by ClusterServiceVersion. If the CRD is present in the Owned list, it is implicitly required.

descriptionstring
displayNamestring
iconarray
installobject

NamedInstallStrategy represents the block of an ClusterServiceVersion resource where the install strategy is specified.

installModesarray

InstallModes specify supported installation types

keywordsarray
labelsobject

Map of string keys and values that can be used to organize and categorize (scope and select) objects.

linksarray
maintainersarray
maturitystring
minKubeVersionstring
nativeAPIsarray
providerobject
relatedImagesarray

List any related images, or other container images that your Operator might require to perform their functions. This list should also include operand images as well. All image references should be specified by digest (SHA) and not by tag. This field is only used during catalog creation and plays no part in cluster runtime.

replacesstring

The name of a CSV this one replaces. Should match the metadata.Name field of the old CSV.

selectorobject

Label selector for related resources.

skipsarray

The name(s) of one or more CSV(s) that should be skipped in the upgrade graph. Should match the metadata.Name field of the CSV that should be skipped. This field is only used during catalog creation and plays no part in cluster runtime.

versionstring

OperatorVersion is a wrapper around semver.Version which supports correct marshaling to YAML and JSON.

webhookdefinitionsarray

.spec.annotations

Description
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
Type
object

.spec.apiservicedefinitions

Description
APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion.
Type
object
PropertyTypeDescription
ownedarray
requiredarray

.spec.apiservicedefinitions.owned

Type
array

.spec.apiservicedefinitions.owned[]

Description
APIServiceDescription provides details to OLM about apis provided via aggregation
Type
object
Required
groupkindnameversion
PropertyTypeDescription
actionDescriptorsarray
containerPortinteger
deploymentNamestring
descriptionstring
displayNamestring
groupstring
kindstring
namestring
resourcesarray
specDescriptorsarray
statusDescriptorsarray
versionstring

.spec.apiservicedefinitions.owned[].actionDescriptors

Type
array

.spec.apiservicedefinitions.owned[].actionDescriptors[]

Description
ActionDescriptor describes a declarative action that can be performed on a custom resource instance
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.apiservicedefinitions.owned[].actionDescriptors[].x-descriptors

Type
array

.spec.apiservicedefinitions.owned[].actionDescriptors[].x-descriptors[]

Type
string

.spec.apiservicedefinitions.owned[].resources

Type
array

.spec.apiservicedefinitions.owned[].resources[]

Description
APIResourceReference is a Kubernetes resource type used by a custom resource
Type
object
Required
kindnameversion
PropertyTypeDescription
kindstring
namestring
versionstring

.spec.apiservicedefinitions.owned[].specDescriptors

Type
array

.spec.apiservicedefinitions.owned[].specDescriptors[]

Description
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.apiservicedefinitions.owned[].specDescriptors[].x-descriptors

Type
array

.spec.apiservicedefinitions.owned[].specDescriptors[].x-descriptors[]

Type
string

.spec.apiservicedefinitions.owned[].statusDescriptors

Type
array

.spec.apiservicedefinitions.owned[].statusDescriptors[]

Description
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.apiservicedefinitions.owned[].statusDescriptors[].x-descriptors

Type
array

.spec.apiservicedefinitions.owned[].statusDescriptors[].x-descriptors[]

Type
string

.spec.apiservicedefinitions.required

Type
array

.spec.apiservicedefinitions.required[]

Description
APIServiceDescription provides details to OLM about apis provided via aggregation
Type
object
Required
groupkindnameversion
PropertyTypeDescription
actionDescriptorsarray
containerPortinteger
deploymentNamestring
descriptionstring
displayNamestring
groupstring
kindstring
namestring
resourcesarray
specDescriptorsarray
statusDescriptorsarray
versionstring

.spec.apiservicedefinitions.required[].actionDescriptors

Type
array

.spec.apiservicedefinitions.required[].actionDescriptors[]

Description
ActionDescriptor describes a declarative action that can be performed on a custom resource instance
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.apiservicedefinitions.required[].actionDescriptors[].x-descriptors

Type
array

.spec.apiservicedefinitions.required[].actionDescriptors[].x-descriptors[]

Type
string

.spec.apiservicedefinitions.required[].resources

Type
array

.spec.apiservicedefinitions.required[].resources[]

Description
APIResourceReference is a Kubernetes resource type used by a custom resource
Type
object
Required
kindnameversion
PropertyTypeDescription
kindstring
namestring
versionstring

.spec.apiservicedefinitions.required[].specDescriptors

Type
array

.spec.apiservicedefinitions.required[].specDescriptors[]

Description
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.apiservicedefinitions.required[].specDescriptors[].x-descriptors

Type
array

.spec.apiservicedefinitions.required[].specDescriptors[].x-descriptors[]

Type
string

.spec.apiservicedefinitions.required[].statusDescriptors

Type
array

.spec.apiservicedefinitions.required[].statusDescriptors[]

Description
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.apiservicedefinitions.required[].statusDescriptors[].x-descriptors

Type
array

.spec.apiservicedefinitions.required[].statusDescriptors[].x-descriptors[]

Type
string

.spec.cleanup

Description
Cleanup specifies the cleanup behaviour when the CSV gets deleted
Type
object
Required
enabled
PropertyTypeDescription
enabledboolean

.spec.customresourcedefinitions

Description
CustomResourceDefinitions declares all of the CRDs managed or required by an operator being ran by ClusterServiceVersion. If the CRD is present in the Owned list, it is implicitly required.
Type
object
PropertyTypeDescription
ownedarray
requiredarray

.spec.customresourcedefinitions.owned

Type
array

.spec.customresourcedefinitions.owned[]

Description
CRDDescription provides details to OLM about the CRDs
Type
object
Required
kindnameversion
PropertyTypeDescription
actionDescriptorsarray
descriptionstring
displayNamestring
kindstring
namestring
resourcesarray
specDescriptorsarray
statusDescriptorsarray
versionstring

.spec.customresourcedefinitions.owned[].actionDescriptors

Type
array

.spec.customresourcedefinitions.owned[].actionDescriptors[]

Description
ActionDescriptor describes a declarative action that can be performed on a custom resource instance
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.customresourcedefinitions.owned[].actionDescriptors[].x-descriptors

Type
array

.spec.customresourcedefinitions.owned[].actionDescriptors[].x-descriptors[]

Type
string

.spec.customresourcedefinitions.owned[].resources

Type
array

.spec.customresourcedefinitions.owned[].resources[]

Description
APIResourceReference is a Kubernetes resource type used by a custom resource
Type
object
Required
kindnameversion
PropertyTypeDescription
kindstring
namestring
versionstring

.spec.customresourcedefinitions.owned[].specDescriptors

Type
array

.spec.customresourcedefinitions.owned[].specDescriptors[]

Description
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.customresourcedefinitions.owned[].specDescriptors[].x-descriptors

Type
array

.spec.customresourcedefinitions.owned[].specDescriptors[].x-descriptors[]

Type
string

.spec.customresourcedefinitions.owned[].statusDescriptors

Type
array

.spec.customresourcedefinitions.owned[].statusDescriptors[]

Description
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.customresourcedefinitions.owned[].statusDescriptors[].x-descriptors

Type
array

.spec.customresourcedefinitions.owned[].statusDescriptors[].x-descriptors[]

Type
string

.spec.customresourcedefinitions.required

Type
array

.spec.customresourcedefinitions.required[]

Description
CRDDescription provides details to OLM about the CRDs
Type
object
Required
kindnameversion
PropertyTypeDescription
actionDescriptorsarray
descriptionstring
displayNamestring
kindstring
namestring
resourcesarray
specDescriptorsarray
statusDescriptorsarray
versionstring

.spec.customresourcedefinitions.required[].actionDescriptors

Type
array

.spec.customresourcedefinitions.required[].actionDescriptors[]

Description
ActionDescriptor describes a declarative action that can be performed on a custom resource instance
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.customresourcedefinitions.required[].actionDescriptors[].x-descriptors

Type
array

.spec.customresourcedefinitions.required[].actionDescriptors[].x-descriptors[]

Type
string

.spec.customresourcedefinitions.required[].resources

Type
array

.spec.customresourcedefinitions.required[].resources[]

Description
APIResourceReference is a Kubernetes resource type used by a custom resource
Type
object
Required
kindnameversion
PropertyTypeDescription
kindstring
namestring
versionstring

.spec.customresourcedefinitions.required[].specDescriptors

Type
array

.spec.customresourcedefinitions.required[].specDescriptors[]

Description
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.customresourcedefinitions.required[].specDescriptors[].x-descriptors

Type
array

.spec.customresourcedefinitions.required[].specDescriptors[].x-descriptors[]

Type
string

.spec.customresourcedefinitions.required[].statusDescriptors

Type
array

.spec.customresourcedefinitions.required[].statusDescriptors[]

Description
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
Type
object
Required
path
PropertyTypeDescription
descriptionstring
displayNamestring
pathstring
valuestring

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptorsarray

.spec.customresourcedefinitions.required[].statusDescriptors[].x-descriptors

Type
array

.spec.customresourcedefinitions.required[].statusDescriptors[].x-descriptors[]

Type
string

.spec.icon

Type
array

.spec.icon[]

Type
object
Required
base64datamediatype
PropertyTypeDescription
base64datastring
mediatypestring

.spec.install

Description
NamedInstallStrategy represents the block of an ClusterServiceVersion resource where the install strategy is specified.
Type
object
Required
strategy
PropertyTypeDescription
specobject

StrategyDetailsDeployment represents the parsed details of a Deployment InstallStrategy.

strategystring

.spec.install.spec

Description
StrategyDetailsDeployment represents the parsed details of a Deployment InstallStrategy.
Type
object
Required
deployments
PropertyTypeDescription
clusterPermissionsarray
deploymentsarray
permissionsarray

.spec.install.spec.clusterPermissions

Type
array

.spec.install.spec.clusterPermissions[]

Description
StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy
Type
object
Required
rulesserviceAccountName
PropertyTypeDescription
rulesarray
serviceAccountNamestring

.spec.install.spec.clusterPermissions[].rules

Type
array

.spec.install.spec.clusterPermissions[].rules[]

Description
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
Type
object
Required
verbs
PropertyTypeDescription
apiGroupsarray

APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.

nonResourceURLsarray

NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.

resourceNamesarray

ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resourcesarray

Resources is a list of resources this rule applies to. '*' represents all resources.

verbsarray

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs.

.spec.install.spec.clusterPermissions[].rules[].apiGroups

Description
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
Type
array

.spec.install.spec.clusterPermissions[].rules[].apiGroups[]

Type
string

.spec.install.spec.clusterPermissions[].rules[].nonResourceURLs

Description
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
Type
array

.spec.install.spec.clusterPermissions[].rules[].nonResourceURLs[]

Type
string

.spec.install.spec.clusterPermissions[].rules[].resourceNames

Description
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
Type
array

.spec.install.spec.clusterPermissions[].rules[].resourceNames[]

Type
string

.spec.install.spec.clusterPermissions[].rules[].resources

Description
Resources is a list of resources this rule applies to. '*' represents all resources.
Type
array

.spec.install.spec.clusterPermissions[].rules[].resources[]

Type
string

.spec.install.spec.clusterPermissions[].rules[].verbs

Description
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs.
Type
array

.spec.install.spec.clusterPermissions[].rules[].verbs[]

Type
string

.spec.install.spec.deployments

Type
array

.spec.install.spec.deployments[]

Description
StrategyDeploymentSpec contains the name, spec and labels for the deployment ALM should create
Type
object
Required
namespec
PropertyTypeDescription
labelobject

Set is a map of label:value. It implements Labels.

namestring
specobject

DeploymentSpec is the specification of the desired behavior of the Deployment.

.spec.install.spec.deployments[].label

Description
Set is a map of label:value. It implements Labels.
Type
object

.spec.install.spec.deployments[].spec

Description
DeploymentSpec is the specification of the desired behavior of the Deployment.
Type
object
Required
selectortemplate
PropertyTypeDescription
minReadySecondsinteger

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)

pausedboolean

Indicates that the deployment is paused.

progressDeadlineSecondsinteger

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.

replicasinteger

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

revisionHistoryLimitinteger

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.

selectorobject

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.

strategyobject

The deployment strategy to use to replace existing pods with new ones.

templateobject

Template describes the pods that will be created.

.spec.install.spec.deployments[].spec.selector

Description
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.selector.matchExpressions

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

.spec.install.spec.deployments[].spec.selector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.selector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.selector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.selector.matchLabels

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

.spec.install.spec.deployments[].spec.strategy

Description
The deployment strategy to use to replace existing pods with new ones.
Type
object
PropertyTypeDescription
rollingUpdateobject

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. --- TODO: Update this to follow our convention for oneOf, whatever we decide it to be.

typestring

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

.spec.install.spec.deployments[].spec.strategy.rollingUpdate

Description
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. --- TODO: Update this to follow our convention for oneOf, whatever we decide it to be.
Type
object
PropertyTypeDescription
maxSurge

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

maxUnavailable

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

.spec.install.spec.deployments[].spec.template

Description
Template describes the pods that will be created.
Type
object
PropertyTypeDescription
metadataObjectMeta

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

specobject

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

.spec.install.spec.deployments[].spec.template.spec

Description
Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Type
object
Required
containers
PropertyTypeDescription
activeDeadlineSecondsinteger

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.

affinityobject

If specified, the pod's scheduling constraints

automountServiceAccountTokenboolean

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

containersarray

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.

dnsConfigobject

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

dnsPolicystring

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

enableServiceLinksboolean

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

ephemeralContainersarray

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.

hostAliasesarray

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.

hostIPCboolean

Use the host's ipc namespace. Optional: Default to false.

hostNetworkboolean

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.

hostPIDboolean

Use the host's pid namespace. Optional: Default to false.

hostnamestring

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

imagePullSecretsarray

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

initContainersarray

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/

nodeNamestring

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.

nodeSelectorobject

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/

overheadobject

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature.

preemptionPolicystring

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.

priorityinteger

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.

priorityClassNamestring

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.

readinessGatesarray

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

restartPolicystring

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

runtimeClassNamestring

RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class This is a beta feature as of Kubernetes v1.14.

schedulerNamestring

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

securityContextobject

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

serviceAccountstring

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

serviceAccountNamestring

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/

setHostnameAsFQDNboolean

If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

shareProcessNamespaceboolean

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.

subdomainstring

If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.

terminationGracePeriodSecondsinteger

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

tolerationsarray

If specified, the pod's tolerations.

topologySpreadConstraintsarray

TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.

volumesarray

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

.spec.install.spec.deployments[].spec.template.spec.affinity

Description
If specified, the pod's scheduling constraints
Type
object
PropertyTypeDescription
nodeAffinityobject

Describes node affinity scheduling rules for the pod.

podAffinityobject

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

podAntiAffinityobject

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

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity

Description
Describes node affinity scheduling rules for the pod.
Type
object
PropertyTypeDescription
preferredDuringSchedulingIgnoredDuringExecutionarray

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.

requiredDuringSchedulingIgnoredDuringExecutionobject

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

Description
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).
Type
object
Required
preferenceweight
PropertyTypeDescription
preferenceobject

A node selector term, associated with the corresponding weight.

weightinteger

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

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference

Description
A node selector term, associated with the corresponding weight.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchFieldsarray

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

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions

Description
A list of node selector requirements by node's labels.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]

Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

The label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[].values

Description
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields

Description
A list of node selector requirements by node's fields.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]

Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

The label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[].values

Description
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

Description
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
Type
object
Required
nodeSelectorTerms
PropertyTypeDescription
nodeSelectorTermsarray

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

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

Description
Required. A list of node selector terms. The terms are ORed.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]

Description
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.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchFieldsarray

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

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions

Description
A list of node selector requirements by node's labels.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]

Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

The label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[].values

Description
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields

Description
A list of node selector requirements by node's fields.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]

Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

The label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[].values

Description
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity

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

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.

requiredDuringSchedulingIgnoredDuringExecutionarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

Description
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Type
object
Required
podAffinityTermweight
PropertyTypeDescription
podAffinityTermobject

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

weightinteger

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

Description
Required. A pod affinity term, associated with the corresponding weight.
Type
object
Required
topologyKey
PropertyTypeDescription
labelSelectorobject

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

namespaceSelectorobject

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

namespacesarray

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"

topologyKeystring

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

Description
A label query over a set of resources, in this case pods.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchLabels

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces

Description
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

Description
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

Description
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
Type
object
Required
topologyKey
PropertyTypeDescription
labelSelectorobject

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

namespaceSelectorobject

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

namespacesarray

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"

topologyKeystring

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

Description
A label query over a set of resources, in this case pods.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchLabels

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces

Description
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity

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

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.

requiredDuringSchedulingIgnoredDuringExecutionarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

Description
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Type
object
Required
podAffinityTermweight
PropertyTypeDescription
podAffinityTermobject

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

weightinteger

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

Description
Required. A pod affinity term, associated with the corresponding weight.
Type
object
Required
topologyKey
PropertyTypeDescription
labelSelectorobject

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

namespaceSelectorobject

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

namespacesarray

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"

topologyKeystring

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

Description
A label query over a set of resources, in this case pods.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchLabels

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces

Description
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

Description
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

Description
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
Type
object
Required
topologyKey
PropertyTypeDescription
labelSelectorobject

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

namespaceSelectorobject

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

namespacesarray

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"

topologyKeystring

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

Description
A label query over a set of resources, in this case pods.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchLabels

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels

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

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces

Description
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
Type
array

.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.containers

Description
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[]

Description
A single application container that you want to run within a pod.
Type
object
Required
name
PropertyTypeDescription
argsarray

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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

commandarray

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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

envarray

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

envFromarray

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.

imagestring

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.

imagePullPolicystring

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

lifecycleobject

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

livenessProbeobject

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

namestring

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

portsarray

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.

readinessProbeobject

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

resourcesobject

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

securityContextobject

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbeobject

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

stdinboolean

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.

stdinOnceboolean

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

terminationMessagePathstring

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.

terminationMessagePolicystring

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.

ttyboolean

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

volumeDevicesarray

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

volumeMountsarray

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

workingDirstring

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.

.spec.install.spec.deployments[].spec.template.spec.containers[].args

Description
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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].args[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.containers[].command

Description
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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.containers[].env

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

.spec.install.spec.deployments[].spec.template.spec.containers[].env[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
name
PropertyTypeDescription
namestring

Name of the environment variable. Must be a C_IDENTIFIER.

valuestring

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

valueFromobject

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

.spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom

Description
Source for the environment variable's value. Cannot be used if value is not empty.
Type
object
PropertyTypeDescription
configMapKeyRefobject

Selects a key of a ConfigMap.

fieldRefobject

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

resourceFieldRefobject

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

secretKeyRefobject

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

.spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.configMapKeyRef

Description
Selects a key of a ConfigMap.
Type
object
Required
key
PropertyTypeDescription
keystring

The key to select.

namestring

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?

optionalboolean

Specify whether the ConfigMap or its key must be defined

.spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.fieldRef

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring

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

fieldPathstring

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

.spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.resourceFieldRef

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
resource
PropertyTypeDescription
containerNamestring

Container name: required for volumes, optional for env vars

divisor

Specifies the output format of the exposed resources, defaults to "1"

resourcestring

Required: resource to select

.spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.secretKeyRef

Description
Selects a key of a secret in the pod's namespace
Type
object
Required
key
PropertyTypeDescription
keystring

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

namestring

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?

optionalboolean

Specify whether the Secret or its key must be defined

.spec.install.spec.deployments[].spec.template.spec.containers[].envFrom

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

.spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps
Type
object
PropertyTypeDescription
configMapRefobject

The ConfigMap to select from

prefixstring

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

secretRefobject

The Secret to select from

.spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].configMapRef

Description
The ConfigMap to select from
Type
object
PropertyTypeDescription
namestring

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?

optionalboolean

Specify whether the ConfigMap must be defined

.spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].secretRef

Description
The Secret to select from
Type
object
PropertyTypeDescription
namestring

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?

optionalboolean

Specify whether the Secret must be defined

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle

Description
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Type
object
PropertyTypeDescription
postStartobject

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStopobject

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart

Description
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

httpGetobject

HTTPGet specifies the http request to perform.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop

Description
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

httpGetobject

HTTPGet specifies the http request to perform.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe

Description
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

failureThresholdinteger

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

httpGetobject

HTTPGet specifies the http request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

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

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

terminationGracePeriodSecondsinteger

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

timeoutSecondsinteger

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

.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.containers[].ports

Description
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.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].ports[]

Description
ContainerPort represents a network port in a single container.
Type
object
Required
containerPort
PropertyTypeDescription
containerPortinteger

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

hostIPstring

What host IP to bind the external port to.

hostPortinteger

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.

namestring

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.

protocolstring

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

.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe

Description
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

failureThresholdinteger

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

httpGetobject

HTTPGet specifies the http request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

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

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

terminationGracePeriodSecondsinteger

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

timeoutSecondsinteger

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

.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.containers[].resources

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

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

requestsobject

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-resources-containers/

.spec.install.spec.deployments[].spec.template.spec.containers[].resources.limits

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

.spec.install.spec.deployments[].spec.template.spec.containers[].resources.requests

Description
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-resources-containers/
Type
object

.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext

Description
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Type
object
PropertyTypeDescription
allowPrivilegeEscalationboolean

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

capabilitiesobject

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

privilegedboolean

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

procMountstring

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.

readOnlyRootFilesystemboolean

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

runAsGroupinteger

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.

runAsNonRootboolean

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.

runAsUserinteger

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.

seLinuxOptionsobject

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

seccompProfileobject

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.

windowsOptionsobject

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities

Description
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Type
object
PropertyTypeDescription
addarray

Added capabilities

droparray

Removed capabilities

.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities.add

Description
Added capabilities
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities.add[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities.drop

Description
Removed capabilities
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities.drop[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seLinuxOptions

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Type
object
PropertyTypeDescription
levelstring

Level is SELinux level label that applies to the container.

rolestring

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

typestring

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

userstring

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

.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seccompProfile

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Type
object
Required
type
PropertyTypeDescription
localhostProfilestring

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".

typestring

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.windowsOptions

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Type
object
PropertyTypeDescription
gmsaCredentialSpecstring

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.

gmsaCredentialSpecNamestring

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

hostProcessboolean

HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

runAsUserNamestring

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.

.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe

Description
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

failureThresholdinteger

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

httpGetobject

HTTPGet specifies the http request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

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

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

terminationGracePeriodSecondsinteger

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

timeoutSecondsinteger

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

.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices

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

.spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
devicePathname
PropertyTypeDescription
devicePathstring

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

namestring

name must match the name of a persistentVolumeClaim in the pod

.spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts

Description
Pod volumes to mount into the container's filesystem. Cannot be updated.
Type
array

.spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring

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

mountPropagationstring

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.

namestring

This must match the Name of a Volume.

readOnlyboolean

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

subPathstring

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

subPathExprstring

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.

.spec.install.spec.deployments[].spec.template.spec.dnsConfig

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

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

optionsarray

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.

searchesarray

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.

.spec.install.spec.deployments[].spec.template.spec.dnsConfig.nameservers

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

.spec.install.spec.deployments[].spec.template.spec.dnsConfig.nameservers[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.dnsConfig.options

Description
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.dnsConfig.options[]

Description
PodDNSConfigOption defines DNS resolver options of a pod.
Type
object
PropertyTypeDescription
namestring

Required.

valuestring

.spec.install.spec.deployments[].spec.template.spec.dnsConfig.searches

Description
A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
Type
array

.spec.install.spec.deployments[].spec.template.spec.dnsConfig.searches[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers

Description
List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[]

Description
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.
Type
object
Required
name
PropertyTypeDescription
argsarray

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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

commandarray

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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

envarray

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

envFromarray

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.

imagestring

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

imagePullPolicystring

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

lifecycleobject

Lifecycle is not allowed for ephemeral containers.

livenessProbeobject

Probes are not allowed for ephemeral containers.

namestring

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

portsarray

Ports are not allowed for ephemeral containers.

readinessProbeobject

Probes are not allowed for ephemeral containers.

resourcesobject

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

securityContextobject

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

startupProbeobject

Probes are not allowed for ephemeral containers.

stdinboolean

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.

stdinOnceboolean

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

targetContainerNamestring

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.

terminationMessagePathstring

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.

terminationMessagePolicystring

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.

ttyboolean

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

volumeDevicesarray

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

volumeMountsarray

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

workingDirstring

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.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].args

Description
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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].args[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].command

Description
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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
name
PropertyTypeDescription
namestring

Name of the environment variable. Must be a C_IDENTIFIER.

valuestring

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

valueFromobject

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom

Description
Source for the environment variable's value. Cannot be used if value is not empty.
Type
object
PropertyTypeDescription
configMapKeyRefobject

Selects a key of a ConfigMap.

fieldRefobject

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

resourceFieldRefobject

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

secretKeyRefobject

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.configMapKeyRef

Description
Selects a key of a ConfigMap.
Type
object
Required
key
PropertyTypeDescription
keystring

The key to select.

namestring

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?

optionalboolean

Specify whether the ConfigMap or its key must be defined

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.fieldRef

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring

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

fieldPathstring

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.resourceFieldRef

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
resource
PropertyTypeDescription
containerNamestring

Container name: required for volumes, optional for env vars

divisor

Specifies the output format of the exposed resources, defaults to "1"

resourcestring

Required: resource to select

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.secretKeyRef

Description
Selects a key of a secret in the pod's namespace
Type
object
Required
key
PropertyTypeDescription
keystring

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

namestring

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?

optionalboolean

Specify whether the Secret or its key must be defined

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps
Type
object
PropertyTypeDescription
configMapRefobject

The ConfigMap to select from

prefixstring

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

secretRefobject

The Secret to select from

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].configMapRef

Description
The ConfigMap to select from
Type
object
PropertyTypeDescription
namestring

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?

optionalboolean

Specify whether the ConfigMap must be defined

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].secretRef

Description
The Secret to select from
Type
object
PropertyTypeDescription
namestring

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?

optionalboolean

Specify whether the Secret must be defined

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle

Description
Lifecycle is not allowed for ephemeral containers.
Type
object
PropertyTypeDescription
postStartobject

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStopobject

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart

Description
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

httpGetobject

HTTPGet specifies the http request to perform.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop

Description
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

httpGetobject

HTTPGet specifies the http request to perform.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe

Description
Probes are not allowed for ephemeral containers.
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

failureThresholdinteger

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

httpGetobject

HTTPGet specifies the http request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

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

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

terminationGracePeriodSecondsinteger

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

timeoutSecondsinteger

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].ports

Description
Ports are not allowed for ephemeral containers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].ports[]

Description
ContainerPort represents a network port in a single container.
Type
object
Required
containerPort
PropertyTypeDescription
containerPortinteger

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

hostIPstring

What host IP to bind the external port to.

hostPortinteger

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.

namestring

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.

protocolstring

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe

Description
Probes are not allowed for ephemeral containers.
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

failureThresholdinteger

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

httpGetobject

HTTPGet specifies the http request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

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

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

terminationGracePeriodSecondsinteger

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

timeoutSecondsinteger

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources

Description
Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
Type
object
PropertyTypeDescription
limitsobject

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

requestsobject

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-resources-containers/

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources.limits

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources.requests

Description
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-resources-containers/
Type
object

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext

Description
Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
Type
object
PropertyTypeDescription
allowPrivilegeEscalationboolean

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

capabilitiesobject

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

privilegedboolean

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

procMountstring

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.

readOnlyRootFilesystemboolean

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

runAsGroupinteger

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.

runAsNonRootboolean

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.

runAsUserinteger

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.

seLinuxOptionsobject

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

seccompProfileobject

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.

windowsOptionsobject

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities

Description
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Type
object
PropertyTypeDescription
addarray

Added capabilities

droparray

Removed capabilities

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities.add

Description
Added capabilities
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities.add[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities.drop

Description
Removed capabilities
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities.drop[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seLinuxOptions

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Type
object
PropertyTypeDescription
levelstring

Level is SELinux level label that applies to the container.

rolestring

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

typestring

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

userstring

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seccompProfile

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Type
object
Required
type
PropertyTypeDescription
localhostProfilestring

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".

typestring

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.windowsOptions

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Type
object
PropertyTypeDescription
gmsaCredentialSpecstring

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.

gmsaCredentialSpecNamestring

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

hostProcessboolean

HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

runAsUserNamestring

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.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe

Description
Probes are not allowed for ephemeral containers.
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

failureThresholdinteger

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

httpGetobject

HTTPGet specifies the http request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

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

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

terminationGracePeriodSecondsinteger

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

timeoutSecondsinteger

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices

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

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
devicePathname
PropertyTypeDescription
devicePathstring

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

namestring

name must match the name of a persistentVolumeClaim in the pod

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts

Description
Pod volumes to mount into the container's filesystem. Cannot be updated.
Type
array

.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring

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

mountPropagationstring

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.

namestring

This must match the Name of a Volume.

readOnlyboolean

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

subPathstring

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

subPathExprstring

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.

.spec.install.spec.deployments[].spec.template.spec.hostAliases

Description
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.
Type
array

.spec.install.spec.deployments[].spec.template.spec.hostAliases[]

Description
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
Type
object
PropertyTypeDescription
hostnamesarray

Hostnames for the above IP address.

ipstring

IP address of the host file entry.

.spec.install.spec.deployments[].spec.template.spec.hostAliases[].hostnames

Description
Hostnames for the above IP address.
Type
array

.spec.install.spec.deployments[].spec.template.spec.hostAliases[].hostnames[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.imagePullSecrets

Description
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. 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
Type
array

.spec.install.spec.deployments[].spec.template.spec.imagePullSecrets[]

Description
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Type
object
PropertyTypeDescription
namestring

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?

.spec.install.spec.deployments[].spec.template.spec.initContainers

Description
List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[]

Description
A single application container that you want to run within a pod.
Type
object
Required
name
PropertyTypeDescription
argsarray

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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

commandarray

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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

envarray

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

envFromarray

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.

imagestring

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.

imagePullPolicystring

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

lifecycleobject

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

livenessProbeobject

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

namestring

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

portsarray

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.

readinessProbeobject

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

resourcesobject

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

securityContextobject

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbeobject

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

stdinboolean

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.

stdinOnceboolean

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

terminationMessagePathstring

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.

terminationMessagePolicystring

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.

ttyboolean

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

volumeDevicesarray

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

volumeMountsarray

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

workingDirstring

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.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].args

Description
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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].args[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.initContainers[].command

Description
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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.initContainers[].env

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].env[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
name
PropertyTypeDescription
namestring

Name of the environment variable. Must be a C_IDENTIFIER.

valuestring

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

valueFromobject

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom

Description
Source for the environment variable's value. Cannot be used if value is not empty.
Type
object
PropertyTypeDescription
configMapKeyRefobject

Selects a key of a ConfigMap.

fieldRefobject

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

resourceFieldRefobject

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

secretKeyRefobject

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.configMapKeyRef

Description
Selects a key of a ConfigMap.
Type
object
Required
key
PropertyTypeDescription
keystring

The key to select.

namestring

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?

optionalboolean

Specify whether the ConfigMap or its key must be defined

.spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.fieldRef

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring

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

fieldPathstring

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.resourceFieldRef

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
resource
PropertyTypeDescription
containerNamestring

Container name: required for volumes, optional for env vars

divisor

Specifies the output format of the exposed resources, defaults to "1"

resourcestring

Required: resource to select

.spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.secretKeyRef

Description
Selects a key of a secret in the pod's namespace
Type
object
Required
key
PropertyTypeDescription
keystring

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

namestring

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?

optionalboolean

Specify whether the Secret or its key must be defined

.spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps
Type
object
PropertyTypeDescription
configMapRefobject

The ConfigMap to select from

prefixstring

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

secretRefobject

The Secret to select from

.spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].configMapRef

Description
The ConfigMap to select from
Type
object
PropertyTypeDescription
namestring

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?

optionalboolean

Specify whether the ConfigMap must be defined

.spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].secretRef

Description
The Secret to select from
Type
object
PropertyTypeDescription
namestring

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?

optionalboolean

Specify whether the Secret must be defined

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle

Description
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Type
object
PropertyTypeDescription
postStartobject

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStopobject

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart

Description
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

httpGetobject

HTTPGet specifies the http request to perform.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop

Description
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

httpGetobject

HTTPGet specifies the http request to perform.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe

Description
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

failureThresholdinteger

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

httpGetobject

HTTPGet specifies the http request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

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

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

terminationGracePeriodSecondsinteger

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

timeoutSecondsinteger

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].ports

Description
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.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].ports[]

Description
ContainerPort represents a network port in a single container.
Type
object
Required
containerPort
PropertyTypeDescription
containerPortinteger

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

hostIPstring

What host IP to bind the external port to.

hostPortinteger

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.

namestring

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.

protocolstring

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe

Description
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

failureThresholdinteger

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

httpGetobject

HTTPGet specifies the http request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

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

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

terminationGracePeriodSecondsinteger

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

timeoutSecondsinteger

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].resources

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

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

requestsobject

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-resources-containers/

.spec.install.spec.deployments[].spec.template.spec.initContainers[].resources.limits

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].resources.requests

Description
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-resources-containers/
Type
object

.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext

Description
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Type
object
PropertyTypeDescription
allowPrivilegeEscalationboolean

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

capabilitiesobject

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

privilegedboolean

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

procMountstring

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.

readOnlyRootFilesystemboolean

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

runAsGroupinteger

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.

runAsNonRootboolean

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.

runAsUserinteger

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.

seLinuxOptionsobject

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

seccompProfileobject

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.

windowsOptionsobject

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities

Description
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Type
object
PropertyTypeDescription
addarray

Added capabilities

droparray

Removed capabilities

.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities.add

Description
Added capabilities
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities.add[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities.drop

Description
Removed capabilities
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities.drop[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seLinuxOptions

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Type
object
PropertyTypeDescription
levelstring

Level is SELinux level label that applies to the container.

rolestring

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

typestring

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

userstring

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seccompProfile

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Type
object
Required
type
PropertyTypeDescription
localhostProfilestring

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".

typestring

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.windowsOptions

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Type
object
PropertyTypeDescription
gmsaCredentialSpecstring

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.

gmsaCredentialSpecNamestring

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

hostProcessboolean

HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

runAsUserNamestring

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.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe

Description
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
PropertyTypeDescription
execobject

One and only one of the following should be specified. Exec specifies the action to take.

failureThresholdinteger

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

httpGetobject

HTTPGet specifies the http request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

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

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook

terminationGracePeriodSecondsinteger

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

timeoutSecondsinteger

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.exec

Description
One and only one of the following should be specified. Exec specifies the action to take.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.exec.command

Description
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.exec.command[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet

Description
HTTPGet specifies the http request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

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

httpHeadersarray

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

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name

valuestring

The header field value

.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.tcpSocket

Description
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Type
object
Required
port
PropertyTypeDescription
hoststring

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

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices

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

.spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
devicePathname
PropertyTypeDescription
devicePathstring

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

namestring

name must match the name of a persistentVolumeClaim in the pod

.spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts

Description
Pod volumes to mount into the container's filesystem. Cannot be updated.
Type
array

.spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring

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

mountPropagationstring

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.

namestring

This must match the Name of a Volume.

readOnlyboolean

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

subPathstring

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

subPathExprstring

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.

.spec.install.spec.deployments[].spec.template.spec.nodeSelector

Description
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
Type
object

.spec.install.spec.deployments[].spec.template.spec.overhead

Description
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature.
Type
object

.spec.install.spec.deployments[].spec.template.spec.readinessGates

Description
If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
Type
array

.spec.install.spec.deployments[].spec.template.spec.readinessGates[]

Description
PodReadinessGate contains the reference to a pod condition
Type
object
Required
conditionType
PropertyTypeDescription
conditionTypestring

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

.spec.install.spec.deployments[].spec.template.spec.securityContext

Description
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
Type
object
PropertyTypeDescription
fsGroupinteger

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

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.

runAsGroupinteger

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.

runAsNonRootboolean

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.

runAsUserinteger

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.

seLinuxOptionsobject

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

seccompProfileobject

The seccomp options to use by the containers in this pod.

supplementalGroupsarray

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.

sysctlsarray

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

windowsOptionsobject

The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.install.spec.deployments[].spec.template.spec.securityContext.seLinuxOptions

Description
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
Type
object
PropertyTypeDescription
levelstring

Level is SELinux level label that applies to the container.

rolestring

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

typestring

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

userstring

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

.spec.install.spec.deployments[].spec.template.spec.securityContext.seccompProfile

Description
The seccomp options to use by the containers in this pod.
Type
object
Required
type
PropertyTypeDescription
localhostProfilestring

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".

typestring

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.install.spec.deployments[].spec.template.spec.securityContext.supplementalGroups

Description
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.
Type
array

.spec.install.spec.deployments[].spec.template.spec.securityContext.supplementalGroups[]

Type
integer

.spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls

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

.spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls[]

Description
Sysctl defines a kernel parameter to be set
Type
object
Required
namevalue
PropertyTypeDescription
namestring

Name of a property to set

valuestring

Value of a property to set

.spec.install.spec.deployments[].spec.template.spec.securityContext.windowsOptions

Description
The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Type
object
PropertyTypeDescription
gmsaCredentialSpecstring

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.

gmsaCredentialSpecNamestring

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

hostProcessboolean

HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

runAsUserNamestring

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.

.spec.install.spec.deployments[].spec.template.spec.tolerations

Description
If specified, the pod's tolerations.
Type
array

.spec.install.spec.deployments[].spec.template.spec.tolerations[]

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

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

keystring

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.

operatorstring

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.

tolerationSecondsinteger

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.

valuestring

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints

Description
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
Type
array

.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[]

Description
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
Type
object
Required
maxSkewtopologyKeywhenUnsatisfiable
PropertyTypeDescription
labelSelectorobject

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

maxSkewinteger

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. 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. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

topologyKeystring

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.

whenUnsatisfiablestring

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector

Description
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions

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

.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchLabels

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

.spec.install.spec.deployments[].spec.template.spec.volumes

Description
List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[]

Description
Volume represents a named volume in a pod that may be accessed by any container in the pod.
Type
object
Required
name
PropertyTypeDescription
awsElasticBlockStoreobject

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

azureDiskobject

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

azureFileobject

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

cephfsobject

CephFS represents a Ceph FS mount on the host that shares a pod's lifetime

cinderobject

Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

configMapobject

ConfigMap represents a configMap that should populate this volume

csiobject

CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

downwardAPIobject

DownwardAPI represents downward API about the pod that should populate this volume

emptyDirobject

EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

ephemeralobject

Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.

fcobject

FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

flexVolumeobject

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

flockerobject

Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

gcePersistentDiskobject

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

gitRepoobject

GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

glusterfsobject

Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

hostPathobject

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

iscsiobject

ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

namestring

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

nfsobject

NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

persistentVolumeClaimobject

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

photonPersistentDiskobject

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

portworxVolumeobject

PortworxVolume represents a portworx volume attached and mounted on kubelets host machine

projectedobject

Items for all in one resources secrets, configmaps, and downward API

quobyteobject

Quobyte represents a Quobyte mount on the host that shares a pod's lifetime

rbdobject

RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

scaleIOobject

ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

secretobject

Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

storageosobject

StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

vsphereVolumeobject

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

.spec.install.spec.deployments[].spec.template.spec.volumes[].awsElasticBlockStore

Description
AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
Type
object
Required
volumeID
PropertyTypeDescription
fsTypestring

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

partitioninteger

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

readOnlyboolean

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

volumeIDstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].azureDisk

Description
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
Type
object
Required
diskNamediskURI
PropertyTypeDescription
cachingModestring

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

diskNamestring

The Name of the data disk in the blob storage

diskURIstring

The URI the data disk in the blob storage

fsTypestring

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.

kindstring

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

readOnlyboolean

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].azureFile

Description
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
Type
object
Required
secretNameshareName
PropertyTypeDescription
readOnlyboolean

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

secretNamestring

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

shareNamestring

Share Name

.spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs

Description
CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
Type
object
Required
monitors
PropertyTypeDescription
monitorsarray

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

pathstring

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

readOnlyboolean

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

secretFilestring

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

secretRefobject

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

userstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs.monitors

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs.monitors[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs.secretRef

Description
Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
Type
object
PropertyTypeDescription
namestring

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?

.spec.install.spec.deployments[].spec.template.spec.volumes[].cinder

Description
Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
Type
object
Required
volumeID
PropertyTypeDescription
fsTypestring

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

readOnlyboolean

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

secretRefobject

Optional: points to a secret object containing parameters used to connect to OpenStack.

volumeIDstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].cinder.secretRef

Description
Optional: points to a secret object containing parameters used to connect to OpenStack.
Type
object
PropertyTypeDescription
namestring

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?

.spec.install.spec.deployments[].spec.template.spec.volumes[].configMap

Description
ConfigMap represents a configMap that should populate this volume
Type
object
PropertyTypeDescription
defaultModeinteger

Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

itemsarray

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

namestring

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?

optionalboolean

Specify whether the ConfigMap or its keys must be defined

.spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items

Description
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items[]

Description
Maps a string key to a path within a volume.
Type
object
Required
keypath
PropertyTypeDescription
keystring

The key to project.

modeinteger

Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

pathstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].csi

Description
CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
Type
object
Required
driver
PropertyTypeDescription
driverstring

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.

fsTypestring

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.

nodePublishSecretRefobject

NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

readOnlyboolean

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

volumeAttributesobject

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].csi.nodePublishSecretRef

Description
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
Type
object
PropertyTypeDescription
namestring

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?

.spec.install.spec.deployments[].spec.template.spec.volumes[].csi.volumeAttributes

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI

Description
DownwardAPI represents downward API about the pod that should populate this volume
Type
object
PropertyTypeDescription
defaultModeinteger

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

itemsarray

Items is a list of downward API volume file

.spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items

Description
Items is a list of downward API volume file
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[]

Description
DownwardAPIVolumeFile represents information to create the file containing the pod field
Type
object
Required
path
PropertyTypeDescription
fieldRefobject

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

modeinteger

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

pathstring

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

resourceFieldRefobject

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

.spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[].fieldRef

Description
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring

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

fieldPathstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[].resourceFieldRef

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
Type
object
Required
resource
PropertyTypeDescription
containerNamestring

Container name: required for volumes, optional for env vars

divisor

Specifies the output format of the exposed resources, defaults to "1"

resourcestring

Required: resource to select

.spec.install.spec.deployments[].spec.template.spec.volumes[].emptyDir

Description
EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
Type
object
PropertyTypeDescription
mediumstring

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

sizeLimit

Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral

Description
Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.
Type
object
PropertyTypeDescription
volumeClaimTemplateobject

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate

Description
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.
Type
object
Required
spec
PropertyTypeDescription
metadataObjectMeta

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

specobject

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec

Description
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
Type
object
PropertyTypeDescription
accessModesarray

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

dataSourceobject

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

dataSourceRefobject

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

resourcesobject

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

selectorobject

A label query over volumes to consider for binding.

storageClassNamestring

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

volumeModestring

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

volumeNamestring

VolumeName is the binding reference to the PersistentVolume backing this claim.

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.accessModes

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.accessModes[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource

Description
This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
Type
object
Required
kindname
PropertyTypeDescription
apiGroupstring

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kindstring

Kind is the type of resource being referenced

namestring

Name is the name of resource being referenced

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef

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

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kindstring

Kind is the type of resource being referenced

namestring

Name is the name of resource being referenced

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources

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

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

requestsobject

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-resources-containers/

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources.limits

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources.requests

Description
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-resources-containers/
Type
object

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector

Description
A label query over volumes to consider for binding.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchLabels

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].fc

Description
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
Type
object
PropertyTypeDescription
fsTypestring

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

luninteger

Optional: FC target lun number

readOnlyboolean

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

targetWWNsarray

Optional: FC target worldwide names (WWNs)

wwidsarray

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].fc.targetWWNs

Description
Optional: FC target worldwide names (WWNs)
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[].fc.targetWWNs[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.volumes[].fc.wwids

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].fc.wwids[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume

Description
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
Type
object
Required
driver
PropertyTypeDescription
driverstring

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

fsTypestring

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.

optionsobject

Optional: Extra command options if any.

readOnlyboolean

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

secretRefobject

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

.spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume.options

Description
Optional: Extra command options if any.
Type
object

.spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume.secretRef

Description
Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
Type
object
PropertyTypeDescription
namestring

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?

.spec.install.spec.deployments[].spec.template.spec.volumes[].flocker

Description
Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
Type
object
PropertyTypeDescription
datasetNamestring

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

datasetUUIDstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].gcePersistentDisk

Description
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
Type
object
Required
pdName
PropertyTypeDescription
fsTypestring

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

partitioninteger

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

pdNamestring

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

readOnlyboolean

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].gitRepo

Description
GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
Type
object
Required
repository
PropertyTypeDescription
directorystring

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.

repositorystring

Repository URL

revisionstring

Commit hash for the specified revision.

.spec.install.spec.deployments[].spec.template.spec.volumes[].glusterfs

Description
Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
Type
object
Required
endpointspath
PropertyTypeDescription
endpointsstring

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

pathstring

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

readOnlyboolean

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].hostPath

Description
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.
Type
object
Required
path
PropertyTypeDescription
pathstring

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

typestring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi

Description
ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
Type
object
Required
iqnluntargetPortal
PropertyTypeDescription
chapAuthDiscoveryboolean

whether support iSCSI Discovery CHAP authentication

chapAuthSessionboolean

whether support iSCSI Session CHAP authentication

fsTypestring

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

initiatorNamestring

Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.

iqnstring

Target iSCSI Qualified Name.

iscsiInterfacestring

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

luninteger

iSCSI Target Lun number.

portalsarray

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

readOnlyboolean

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

secretRefobject

CHAP Secret for iSCSI target and initiator authentication

targetPortalstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi.portals

Description
iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi.portals[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi.secretRef

Description
CHAP Secret for iSCSI target and initiator authentication
Type
object
PropertyTypeDescription
namestring

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?

.spec.install.spec.deployments[].spec.template.spec.volumes[].nfs

Description
NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
Type
object
Required
pathserver
PropertyTypeDescription
pathstring

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

readOnlyboolean

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

serverstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].persistentVolumeClaim

Description
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
Type
object
Required
claimName
PropertyTypeDescription
claimNamestring

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

readOnlyboolean

Will force the ReadOnly setting in VolumeMounts. Default false.

.spec.install.spec.deployments[].spec.template.spec.volumes[].photonPersistentDisk

Description
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
Type
object
Required
pdID
PropertyTypeDescription
fsTypestring

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.

pdIDstring

ID that identifies Photon Controller persistent disk

.spec.install.spec.deployments[].spec.template.spec.volumes[].portworxVolume

Description
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
Type
object
Required
volumeID
PropertyTypeDescription
fsTypestring

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.

readOnlyboolean

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

volumeIDstring

VolumeID uniquely identifies a Portworx volume

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected

Description
Items for all in one resources secrets, configmaps, and downward API
Type
object
PropertyTypeDescription
defaultModeinteger

Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

sourcesarray

list of volume projections

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources

Description
list of volume projections
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[]

Description
Projection that may be projected along with other supported volume types
Type
object
PropertyTypeDescription
configMapobject

information about the configMap data to project

downwardAPIobject

information about the downwardAPI data to project

secretobject

information about the secret data to project

serviceAccountTokenobject

information about the serviceAccountToken data to project

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap

Description
information about the configMap data to project
Type
object
PropertyTypeDescription
itemsarray

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

namestring

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?

optionalboolean

Specify whether the ConfigMap or its keys must be defined

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items

Description
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items[]

Description
Maps a string key to a path within a volume.
Type
object
Required
keypath
PropertyTypeDescription
keystring

The key to project.

modeinteger

Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

pathstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI

Description
information about the downwardAPI data to project
Type
object
PropertyTypeDescription
itemsarray

Items is a list of DownwardAPIVolume file

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items

Description
Items is a list of DownwardAPIVolume file
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[]

Description
DownwardAPIVolumeFile represents information to create the file containing the pod field
Type
object
Required
path
PropertyTypeDescription
fieldRefobject

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

modeinteger

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

pathstring

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

resourceFieldRefobject

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef

Description
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring

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

fieldPathstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
Type
object
Required
resource
PropertyTypeDescription
containerNamestring

Container name: required for volumes, optional for env vars

divisor

Specifies the output format of the exposed resources, defaults to "1"

resourcestring

Required: resource to select

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret

Description
information about the secret data to project
Type
object
PropertyTypeDescription
itemsarray

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

namestring

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?

optionalboolean

Specify whether the Secret or its key must be defined

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items

Description
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items[]

Description
Maps a string key to a path within a volume.
Type
object
Required
keypath
PropertyTypeDescription
keystring

The key to project.

modeinteger

Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

pathstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].serviceAccountToken

Description
information about the serviceAccountToken data to project
Type
object
Required
path
PropertyTypeDescription
audiencestring

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.

expirationSecondsinteger

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.

pathstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].quobyte

Description
Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
Type
object
Required
registryvolume
PropertyTypeDescription
groupstring

Group to map volume access to Default is no group

readOnlyboolean

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

registrystring

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

tenantstring

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

userstring

User to map volume access to Defaults to serivceaccount user

volumestring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].rbd

Description
RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
Type
object
Required
imagemonitors
PropertyTypeDescription
fsTypestring

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

imagestring

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

keyringstring

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

monitorsarray

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

poolstring

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

readOnlyboolean

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

secretRefobject

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

userstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].rbd.monitors

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].rbd.monitors[]

Type
string

.spec.install.spec.deployments[].spec.template.spec.volumes[].rbd.secretRef

Description
SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
Type
object
PropertyTypeDescription
namestring

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?

.spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO

Description
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
Type
object
Required
gatewaysecretRefsystem
PropertyTypeDescription
fsTypestring

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

gatewaystring

The host address of the ScaleIO API Gateway.

protectionDomainstring

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

readOnlyboolean

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

secretRefobject

SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

sslEnabledboolean

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

storageModestring

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

storagePoolstring

The ScaleIO Storage Pool associated with the protection domain.

systemstring

The name of the storage system as configured in ScaleIO.

volumeNamestring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO.secretRef

Description
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
Type
object
PropertyTypeDescription
namestring

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?

.spec.install.spec.deployments[].spec.template.spec.volumes[].secret

Description
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
Type
object
PropertyTypeDescription
defaultModeinteger

Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

itemsarray

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

optionalboolean

Specify whether the Secret or its keys must be defined

secretNamestring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items

Description
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
Type
array

.spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items[]

Description
Maps a string key to a path within a volume.
Type
object
Required
keypath
PropertyTypeDescription
keystring

The key to project.

modeinteger

Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

pathstring

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

.spec.install.spec.deployments[].spec.template.spec.volumes[].storageos

Description
StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
Type
object
PropertyTypeDescription
fsTypestring

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.

readOnlyboolean

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

secretRefobject

SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

volumeNamestring

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

volumeNamespacestring

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.

.spec.install.spec.deployments[].spec.template.spec.volumes[].storageos.secretRef

Description
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
Type
object
PropertyTypeDescription
namestring

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?

.spec.install.spec.deployments[].spec.template.spec.volumes[].vsphereVolume

Description
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
Type
object
Required
volumePath
PropertyTypeDescription
fsTypestring

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.

storagePolicyIDstring

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

storagePolicyNamestring

Storage Policy Based Management (SPBM) profile name.

volumePathstring

Path that identifies vSphere volume vmdk

.spec.install.spec.permissions

Type
array

.spec.install.spec.permissions[]

Description
StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy
Type
object
Required
rulesserviceAccountName
PropertyTypeDescription
rulesarray
serviceAccountNamestring

.spec.install.spec.permissions[].rules

Type
array

.spec.install.spec.permissions[].rules[]

Description
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
Type
object
Required
verbs
PropertyTypeDescription
apiGroupsarray

APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.

nonResourceURLsarray

NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.

resourceNamesarray

ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resourcesarray

Resources is a list of resources this rule applies to. '*' represents all resources.

verbsarray

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs.

.spec.install.spec.permissions[].rules[].apiGroups

Description
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
Type
array

.spec.install.spec.permissions[].rules[].apiGroups[]

Type
string

.spec.install.spec.permissions[].rules[].nonResourceURLs

Description
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
Type
array

.spec.install.spec.permissions[].rules[].nonResourceURLs[]

Type
string

.spec.install.spec.permissions[].rules[].resourceNames

Description
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
Type
array

.spec.install.spec.permissions[].rules[].resourceNames[]

Type
string

.spec.install.spec.permissions[].rules[].resources

Description
Resources is a list of resources this rule applies to. '*' represents all resources.
Type
array

.spec.install.spec.permissions[].rules[].resources[]

Type
string

.spec.install.spec.permissions[].rules[].verbs

Description
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs.
Type
array

.spec.install.spec.permissions[].rules[].verbs[]

Type
string

.spec.installModes

Description
InstallModes specify supported installation types
Type
array

.spec.installModes[]

Description
InstallMode associates an InstallModeType with a flag representing if the CSV supports it
Type
object
Required
supportedtype
PropertyTypeDescription
supportedboolean
typestring

InstallModeType is a supported type of install mode for CSV installation

.spec.keywords

Type
array

.spec.keywords[]

Type
string

.spec.labels

Description
Map of string keys and values that can be used to organize and categorize (scope and select) objects.
Type
object
Type
array
Type
object
PropertyTypeDescription
namestring
urlstring

.spec.maintainers

Type
array

.spec.maintainers[]

Type
object
PropertyTypeDescription
emailstring
namestring

.spec.nativeAPIs

Type
array

.spec.nativeAPIs[]

Description
GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling
Type
object
Required
groupkindversion
PropertyTypeDescription
groupstring
kindstring
versionstring

.spec.provider

Type
object
PropertyTypeDescription
namestring
urlstring

.spec.relatedImages

Description
List any related images, or other container images that your Operator might require to perform their functions. This list should also include operand images as well. All image references should be specified by digest (SHA) and not by tag. This field is only used during catalog creation and plays no part in cluster runtime.
Type
array

.spec.relatedImages[]

Type
object
Required
imagename
PropertyTypeDescription
imagestring
namestring

.spec.selector

Description
Label selector for related resources.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.selector.matchExpressions

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

.spec.selector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.selector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.selector.matchExpressions[].values[]

Type
string

.spec.selector.matchLabels

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

.spec.skips

Description
The name(s) of one or more CSV(s) that should be skipped in the upgrade graph. Should match the `metadata.Name` field of the CSV that should be skipped. This field is only used during catalog creation and plays no part in cluster runtime.
Type
array

.spec.skips[]

Type
string

.spec.webhookdefinitions

Type
array

.spec.webhookdefinitions[]

Description
WebhookDescription provides details to OLM about required webhooks
Type
object
Required
admissionReviewVersionsgenerateNamesideEffectstype
PropertyTypeDescription
admissionReviewVersionsarray
containerPortinteger
conversionCRDsarray
deploymentNamestring
failurePolicystring

FailurePolicyType specifies a failure policy that defines how unrecognized errors from the admission endpoint are handled.

generateNamestring
matchPolicystring

MatchPolicyType specifies the type of match policy.

objectSelectorobject

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

reinvocationPolicystring

ReinvocationPolicyType specifies what type of policy the admission hook uses.

rulesarray
sideEffectsstring

SideEffectClass specifies the types of side effects a webhook may have.

targetPort
timeoutSecondsinteger
typestring

WebhookAdmissionType is the type of admission webhooks supported by OLM

webhookPathstring

.spec.webhookdefinitions[].admissionReviewVersions

Type
array

.spec.webhookdefinitions[].admissionReviewVersions[]

Type
string

.spec.webhookdefinitions[].conversionCRDs

Type
array

.spec.webhookdefinitions[].conversionCRDs[]

Type
string

.spec.webhookdefinitions[].objectSelector

Description
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Type
object
PropertyTypeDescription
matchExpressionsarray

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

matchLabelsobject

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.

.spec.webhookdefinitions[].objectSelector.matchExpressions

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

.spec.webhookdefinitions[].objectSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
keyoperator
PropertyTypeDescription
keystring

key is the label key that the selector applies to.

operatorstring

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

valuesarray

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.

.spec.webhookdefinitions[].objectSelector.matchExpressions[].values

Description
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
Type
array

.spec.webhookdefinitions[].objectSelector.matchExpressions[].values[]

Type
string

.spec.webhookdefinitions[].objectSelector.matchLabels

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

.spec.webhookdefinitions[].rules

Type
array

.spec.webhookdefinitions[].rules[]

Description
RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.
Type
object
PropertyTypeDescription
apiGroupsarray

APIGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required.

apiVersionsarray

APIVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required.

operationsarray

Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.

resourcesarray

Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/' means all subresources of pods. '/scale' means all scale subresources. '/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required.

scopestring

scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".

.spec.webhookdefinitions[].rules[].apiGroups

Description
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
Type
array

.spec.webhookdefinitions[].rules[].apiGroups[]

Type
string

.spec.webhookdefinitions[].rules[].apiVersions

Description
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
Type
array

.spec.webhookdefinitions[].rules[].apiVersions[]

Type
string

.spec.webhookdefinitions[].rules[].operations

Description
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
Type
array

.spec.webhookdefinitions[].rules[].operations[]

Description
OperationType specifies an operation for a request.
Type
string

.spec.webhookdefinitions[].rules[].resources

Description
Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required.
Type
array

.spec.webhookdefinitions[].rules[].resources[]

Type
string

.status

Description
ClusterServiceVersionStatus represents information about the status of a CSV. Status may trail the actual state of a system.
Type
object
PropertyTypeDescription
certsLastUpdatedstring

Last time the owned APIService certs were updated

certsRotateAtstring

Time the owned APIService certs will rotate next

cleanupobject

CleanupStatus represents information about the status of cleanup while a CSV is pending deletion

conditionsarray

List of conditions, a history of state transitions

lastTransitionTimestring

Last time the status transitioned from one status to another.

lastUpdateTimestring

Last time we updated the status

messagestring

A human readable message indicating details about why the ClusterServiceVersion is in this condition.

phasestring

Current condition of the ClusterServiceVersion

reasonstring

A brief CamelCase message indicating details about why the ClusterServiceVersion is in this state. e.g. 'RequirementsNotMet'

requirementStatusarray

The status of each requirement for this CSV

.status.cleanup

Description
CleanupStatus represents information about the status of cleanup while a CSV is pending deletion
Type
object
PropertyTypeDescription
pendingDeletionarray

PendingDeletion is the list of custom resource objects that are pending deletion and blocked on finalizers. This indicates the progress of cleanup that is blocking CSV deletion or operator uninstall.

.status.cleanup.pendingDeletion

Description
PendingDeletion is the list of custom resource objects that are pending deletion and blocked on finalizers. This indicates the progress of cleanup that is blocking CSV deletion or operator uninstall.
Type
array

.status.cleanup.pendingDeletion[]

Description
ResourceList represents a list of resources which are of the same Group/Kind
Type
object
Required
groupinstanceskind
PropertyTypeDescription
groupstring
instancesarray
kindstring

.status.cleanup.pendingDeletion[].instances

Type
array

.status.cleanup.pendingDeletion[].instances[]

Type
object
Required
name
PropertyTypeDescription
namestring
namespacestring

Namespace can be empty for cluster-scoped resources

.status.conditions

Description
List of conditions, a history of state transitions
Type
array

.status.conditions[]

Description
Conditions appear in the status as a record of state transitions on the ClusterServiceVersion
Type
object
PropertyTypeDescription
lastTransitionTimestring

Last time the status transitioned from one status to another.

lastUpdateTimestring

Last time we updated the status

messagestring

A human readable message indicating details about why the ClusterServiceVersion is in this condition.

phasestring

Condition of the ClusterServiceVersion

reasonstring

A brief CamelCase message indicating details about why the ClusterServiceVersion is in this state. e.g. 'RequirementsNotMet'

.status.requirementStatus

Description
The status of each requirement for this CSV
Type
array

.status.requirementStatus[]

Type
object
Required
groupkindmessagenamestatusversion
PropertyTypeDescription
dependentsarray
groupstring
kindstring
messagestring
namestring
statusstring

StatusReason is a camelcased reason for the status of a RequirementStatus or DependentStatus

uuidstring
versionstring

.status.requirementStatus[].dependents

Type
array

.status.requirementStatus[].dependents[]

Description
DependentStatus is the status for a dependent requirement (to prevent infinite nesting)
Type
object
Required
groupkindstatusversion
PropertyTypeDescription
groupstring
kindstring
messagestring
statusstring

StatusReason is a camelcased reason for the status of a RequirementStatus or DependentStatus

uuidstring
versionstring

API Endpoints

The following API endpoints are available:

  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions
    • DELETE: delete collection of ClusterServiceVersion
    • GET: list objects of kind ClusterServiceVersion
    • POST: create a new ClusterServiceVersion
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}
    • DELETE: delete the specified ClusterServiceVersion
    • GET: read the specified ClusterServiceVersion
    • PATCH: partially update the specified ClusterServiceVersion
    • PUT: replace the specified ClusterServiceVersion
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}/status
    • GET: read status of the specified ClusterServiceVersion
    • PATCH: partially update status of the specified ClusterServiceVersion
    • PUT: replace status of the specified ClusterServiceVersion

/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions

HTTP method
DELETE
Description
delete collection of ClusterServiceVersion
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind ClusterServiceVersion
HTTP responses
HTTP codeResponse body
200 - OKClusterServiceVersionList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new ClusterServiceVersion
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyClusterServiceVersion schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKClusterServiceVersion schema
201 - CreatedClusterServiceVersion schema
202 - AcceptedClusterServiceVersion schema
401 - UnauthorizedEmpty

/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}

HTTP method
DELETE
Description
delete the specified ClusterServiceVersion
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified ClusterServiceVersion
HTTP responses
HTTP codeResponse body
200 - OKClusterServiceVersion schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified ClusterServiceVersion
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKClusterServiceVersion schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified ClusterServiceVersion
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyClusterServiceVersion schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKClusterServiceVersion schema
201 - CreatedClusterServiceVersion schema
401 - UnauthorizedEmpty

/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}/status

HTTP method
GET
Description
read status of the specified ClusterServiceVersion
HTTP responses
HTTP codeResponse body
200 - OKClusterServiceVersion schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified ClusterServiceVersion
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKClusterServiceVersion schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified ClusterServiceVersion
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyClusterServiceVersion schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKClusterServiceVersion schema
201 - CreatedClusterServiceVersion schema
401 - UnauthorizedEmpty