ClusterServiceVersion is a Custom Resource of type ClusterServiceVersionSpec.
×
ClusterServiceVersion [operators.coreos.com/v1alpha1]
- Specification
- API endpoints
- /apis/operators.coreos.com/v1alpha1/clusterserviceversions
- /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions
- /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}
- /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}/status
- Description
-
- Type
-
object - Required
-
-
metadata -
spec
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
ClusterServiceVersionSpec declarations tell OLM how to install an operator that can manage apps for a given version. |
|
|
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
-
-
displayName -
install
-
| Property | Type | 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. |
|
|
APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion. |
|
|
Cleanup specifies the cleanup behaviour when the CSV gets deleted |
|
|
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. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
NamedInstallStrategy represents the block of an ClusterServiceVersion resource where the install strategy is specified. |
|
|
InstallModes specify supported installation types |
|
|
InstallMode associates an InstallModeType with a flag representing if the CSV supports it |
|
|
|
|
|
Map of string keys and values that can be used to organize and categorize (scope and select) objects. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 |
|
|
|
|
|
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. |
|
|
|
|
|
The name of a CSV this one replaces. Should match the |
|
|
Label selector for related resources. |
|
|
The name(s) of one or more CSV(s) that should be skipped in the upgrade graph. Should match the |
|
|
OperatorVersion is a wrapper around semver.Version which supports correct marshaling to YAML and JSON. |
|
|
|
|
|
WebhookDescription provides details to OLM about required webhooks |
.spec.apiservicedefinitions
- Description
-
APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
APIServiceDescription provides details to OLM about apis provided via aggregation |
|
|
|
|
|
APIServiceDescription provides details to OLM about apis provided via aggregation |
.spec.apiservicedefinitions.owned
- Description
-
- Type
-
array
.spec.apiservicedefinitions.owned[]
- Description
-
APIServiceDescription provides details to OLM about apis provided via aggregation
- Type
-
object - Required
-
-
group -
kind -
name -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
ActionDescriptor describes a declarative action that can be performed on a custom resource instance |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
APIResourceReference is a Kubernetes resource type used by a custom resource |
|
|
|
|
|
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it |
|
|
|
|
|
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it |
|
|
.spec.apiservicedefinitions.owned[].actionDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.apiservicedefinitions.owned[].resources
- Description
-
- Type
-
array
.spec.apiservicedefinitions.owned[].resources[]
- Description
-
APIResourceReference is a Kubernetes resource type used by a custom resource
- Type
-
object - Required
-
-
kind -
name -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
.spec.apiservicedefinitions.owned[].specDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.apiservicedefinitions.owned[].statusDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.apiservicedefinitions.required
- Description
-
- Type
-
array
.spec.apiservicedefinitions.required[]
- Description
-
APIServiceDescription provides details to OLM about apis provided via aggregation
- Type
-
object - Required
-
-
group -
kind -
name -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
ActionDescriptor describes a declarative action that can be performed on a custom resource instance |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
APIResourceReference is a Kubernetes resource type used by a custom resource |
|
|
|
|
|
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it |
|
|
|
|
|
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it |
|
|
.spec.apiservicedefinitions.required[].actionDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.apiservicedefinitions.required[].resources
- Description
-
- Type
-
array
.spec.apiservicedefinitions.required[].resources[]
- Description
-
APIResourceReference is a Kubernetes resource type used by a custom resource
- Type
-
object - Required
-
-
kind -
name -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
.spec.apiservicedefinitions.required[].specDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.apiservicedefinitions.required[].statusDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.cleanup
- Description
-
Cleanup specifies the cleanup behaviour when the CSV gets deleted
- Type
-
object - Required
-
-
enabled
-
| Property | Type | Description |
|---|---|---|
|
|
.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
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
CRDDescription provides details to OLM about the CRDs |
|
|
|
|
|
CRDDescription provides details to OLM about the CRDs |
.spec.customresourcedefinitions.owned
- Description
-
- Type
-
array
.spec.customresourcedefinitions.owned[]
- Description
-
CRDDescription provides details to OLM about the CRDs
- Type
-
object - Required
-
-
kind -
name -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
ActionDescriptor describes a declarative action that can be performed on a custom resource instance |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
APIResourceReference is a Kubernetes resource type used by a custom resource |
|
|
|
|
|
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it |
|
|
|
|
|
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it |
|
|
.spec.customresourcedefinitions.owned[].actionDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.customresourcedefinitions.owned[].resources
- Description
-
- Type
-
array
.spec.customresourcedefinitions.owned[].resources[]
- Description
-
APIResourceReference is a Kubernetes resource type used by a custom resource
- Type
-
object - Required
-
-
kind -
name -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
.spec.customresourcedefinitions.owned[].specDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.customresourcedefinitions.owned[].statusDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.customresourcedefinitions.required
- Description
-
- Type
-
array
.spec.customresourcedefinitions.required[]
- Description
-
CRDDescription provides details to OLM about the CRDs
- Type
-
object - Required
-
-
kind -
name -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
ActionDescriptor describes a declarative action that can be performed on a custom resource instance |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
APIResourceReference is a Kubernetes resource type used by a custom resource |
|
|
|
|
|
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it |
|
|
|
|
|
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it |
|
|
.spec.customresourcedefinitions.required[].actionDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.customresourcedefinitions.required[].resources
- Description
-
- Type
-
array
.spec.customresourcedefinitions.required[].resources[]
- Description
-
APIResourceReference is a Kubernetes resource type used by a custom resource
- Type
-
object - Required
-
-
kind -
name -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
.spec.customresourcedefinitions.required[].specDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.customresourcedefinitions.required[].statusDescriptors
- Description
-
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
.spec.icon
- Description
-
- Type
-
array
.spec.icon[]
- Description
-
- Type
-
object - Required
-
-
base64data -
mediatype
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
.spec.install
- Description
-
NamedInstallStrategy represents the block of an ClusterServiceVersion resource where the install strategy is specified.
- Type
-
object - Required
-
-
strategy
-
| Property | Type | Description |
|---|---|---|
|
|
StrategyDetailsDeployment represents the parsed details of a Deployment InstallStrategy. |
|
|
.spec.install.spec
- Description
-
StrategyDetailsDeployment represents the parsed details of a Deployment InstallStrategy.
- Type
-
object - Required
-
-
deployments
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy |
|
|
|
|
|
StrategyDeploymentSpec contains the name, spec and labels for the deployment ALM should create |
|
|
|
|
|
StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy |
.spec.install.spec.clusterPermissions
- Description
-
- Type
-
array
.spec.install.spec.clusterPermissions[]
- Description
-
StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy
- Type
-
object - Required
-
-
rules -
serviceAccountName
-
| Property | Type | 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. |
|
|
.spec.install.spec.clusterPermissions[].rules
- Description
-
- 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
-
| Property | Type | 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. |
|
|
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. |
|
|
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. |
|
|
Resources is a list of resources this rule applies to. '*' represents all resources. |
|
|
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs. |
.spec.install.spec.deployments
- Description
-
- Type
-
array
.spec.install.spec.deployments[]
- Description
-
StrategyDeploymentSpec contains the name, spec and labels for the deployment ALM should create
- Type
-
object - Required
-
-
name -
spec
-
| Property | Type | Description |
|---|---|---|
|
|
Set is a map of label:value. It implements Labels. |
|
|
|
|
|
DeploymentSpec is the specification of the desired behavior of the Deployment. |
.spec.install.spec.deployments[].spec
- Description
-
DeploymentSpec is the specification of the desired behavior of the Deployment.
- Type
-
object - Required
-
-
selector -
template
-
| Property | Type | Description |
|---|---|---|
|
|
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) |
|
|
Indicates that the deployment is paused. |
|
|
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. |
|
|
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
|
|
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. |
|
|
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. |
|
|
The deployment strategy to use to replace existing pods with new ones. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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.strategy
- Description
-
The deployment strategy to use to replace existing pods with new ones.
- Type
-
object
| Property | Type | 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 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
| Property | Type | Description |
|---|---|---|
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
`` |
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. |
|
|
If specified, the pod’s scheduling constraints |
|
|
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. |
|
|
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. |
|
|
A single application container that you want to run within a pod. |
|
|
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. |
|
|
Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. |
|
|
enableServiceLinks indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. Optional: Defaults to true. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file. |
|
|
Use the host’s ipc namespace. Optional: Default to false. |
|
|
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. |
|
|
Use the host’s pid namespace. Optional: Default to false. |
|
|
Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value. |
|
|
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 |
|
|
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. |
|
|
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/ |
|
|
A single application container that you want to run within a pod. |
|
|
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. |
|
|
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/ |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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 |
|
|
PodReadinessGate contains the reference to a pod condition |
|
|
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 |
|
|
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. |
|
|
If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. |
|
|
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
|
|
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. |
|
|
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/ |
|
|
If true the pod’s hostname will be configured as the pod’s FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKeY_LOCAL_MACHINe\\SYSTeM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. |
|
|
Share 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. |
|
|
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all. |
|
|
Optional 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. |
|
|
If specified, the pod’s tolerations. |
|
|
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. |
|
|
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. |
|
|
TopologySpreadConstraint specifies how to spread matching pods among the given topology. |
|
|
List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes |
|
|
Volume represents a named volume in a pod that may be accessed by any container in the pod. |
.spec.install.spec.deployments[].spec.template.spec.affinity
- Description
-
If specified, the pod’s scheduling constraints
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
Describes node affinity scheduling rules for the pod. |
|
|
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
|
|
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
| Property | Type | 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. |
|
|
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). |
|
|
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
-
-
preference -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
A node selector term, associated with the corresponding weight. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
A list of node selector requirements by node’s labels. |
|
|
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
A list of node selector requirements by node’s fields. |
|
|
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
.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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
The label key that the selector applies to. |
|
|
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt. |
|
|
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
- 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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
The label key that the selector applies to. |
|
|
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt. |
|
|
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
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
Required. A list of node selector terms. The terms are ORed. |
|
|
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. |
.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
| Property | Type | Description |
|---|---|---|
|
|
A list of node selector requirements by node’s labels. |
|
|
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
A list of node selector requirements by node’s fields. |
|
|
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
.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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
The label key that the selector applies to. |
|
|
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt. |
|
|
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
- 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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
The label key that the selector applies to. |
|
|
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt. |
|
|
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.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
| Property | Type | 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. |
|
|
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) |
|
|
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. |
|
|
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 |
.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
-
-
podAffinityTerm -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
Required. A pod affinity term, associated with the corresponding weight. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
A label query over a set of resources, in this case pods. |
|
|
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. |
|
|
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" |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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
- 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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
A label query over a set of resources, in this case pods. |
|
|
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. |
|
|
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" |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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
- 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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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
- 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
| Property | Type | 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. |
|
|
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) |
|
|
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. |
|
|
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 |
.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
-
-
podAffinityTerm -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
Required. A pod affinity term, associated with the corresponding weight. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
A label query over a set of resources, in this case pods. |
|
|
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. |
|
|
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" |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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
- 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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
A label query over a set of resources, in this case pods. |
|
|
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. |
|
|
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" |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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
- 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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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.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
-
| Property | Type | 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 |
|
|
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 |
|
|
List of environment variables to set in the container. Cannot be updated. |
|
|
envVar represents an environment variable present in a Container. |
|
|
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. |
|
|
envFromSource represents the source of a set of ConfigMaps |
|
|
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. |
|
|
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 |
|
|
Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
|
|
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 |
|
|
Name of the container specified as a DNS_LABeL. each container in a pod must have a unique name (DNS_LABeL). Cannot be updated. |
|
|
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. |
|
|
ContainerPort represents a network port in a single container. |
|
|
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 |
|
|
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
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/ |
|
|
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 |
|
|
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. |
|
|
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an eOF. Default is false |
|
|
Optional: 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. |
|
|
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. |
|
|
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
|
volumeDevices is the list of block devices to be used by the container. |
|
|
volumeDevice describes a mapping of a raw block device within a container. |
|
|
Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
VolumeMount describes a mounting of a Volume within a container. |
|
|
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[].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
-
| Property | Type | Description |
|---|---|---|
|
|
Name of the environment variable. Must be a C_IDeNTIFIeR. |
|
|
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 "". |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Selects a key of a ConfigMap. |
|
|
Selects a field of the pod: supports metadata.name, metadata.namespace, |
|
|
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. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
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? |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Container name: required for volumes, optional for env vars |
|
|
Specifies the output format of the exposed resources, defaults to "1" |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
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? |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
The ConfigMap to select from |
|
|
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDeNTIFIeR. |
|
|
The Secret to select from |
.spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].configMapRef
- Description
-
The ConfigMap to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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? |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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? |
|
|
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
| Property | Type | 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 |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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 |
|
|
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
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. |
|
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
|
|
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. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
|
|
What host IP to bind the external port to. |
|
|
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. |
|
|
If specified, this must be an IANA_SVC_NAMe and unique within the pod. each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
|
|
Protocol 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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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 |
|
|
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
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. |
|
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
|
|
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. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
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[].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
| Property | Type | Description |
|---|---|---|
|
|
AllowPrivilegeescalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeescalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
|
|
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
|
|
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
|
|
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. |
|
|
Whether this container has a read-only root filesystem. Default is false. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Added capabilities |
|
|
Removed capabilities |
.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
| Property | Type | Description |
|---|---|---|
|
|
Level is SeLinux level label that applies to the container. |
|
|
Role is a SeLinux role label that applies to the container. |
|
|
Type is a SeLinux type label that applies to the container. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is "Localhost". |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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 |
|
|
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
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. |
|
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
|
|
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. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
-
-
devicePath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
devicePath is the path inside of the container that the device will be mapped to. |
|
|
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
-
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
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. |
|
|
This must match the Name of a Volume. |
|
|
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
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
| Property | Type | 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. |
|
|
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. |
|
|
PodDNSConfigOption defines DNS resolver options of a pod. |
|
|
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.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
| Property | Type | Description |
|---|---|---|
|
|
Required. |
|
|
.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
-
| Property | Type | 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 |
|
|
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 |
|
|
List of environment variables to set in the container. Cannot be updated. |
|
|
envVar represents an environment variable present in a Container. |
|
|
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. |
|
|
envFromSource represents the source of a set of ConfigMaps |
|
|
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images |
|
|
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
|
Lifecycle is not allowed for ephemeral containers. |
|
|
Probes are not allowed for ephemeral containers. |
|
|
Name of the ephemeral container specified as a DNS_LABeL. This name must be unique among all containers, init containers and ephemeral containers. |
|
|
Ports are not allowed for ephemeral containers. |
|
|
ContainerPort represents a network port in a single container. |
|
|
Probes are not allowed for ephemeral containers. |
|
|
Resources are not allowed for ephemeral containers. ephemeral containers use spare resources already allocated to the pod. |
|
|
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. |
|
|
Probes are not allowed for ephemeral containers. |
|
|
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. |
|
|
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 |
|
|
If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. |
|
|
Optional: 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. |
|
|
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. |
|
|
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
|
volumeDevices is the list of block devices to be used by the container. |
|
|
volumeDevice describes a mapping of a raw block device within a container. |
|
|
Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
VolumeMount describes a mounting of a Volume within a container. |
|
|
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[].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
-
| Property | Type | Description |
|---|---|---|
|
|
Name of the environment variable. Must be a C_IDeNTIFIeR. |
|
|
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 "". |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Selects a key of a ConfigMap. |
|
|
Selects a field of the pod: supports metadata.name, metadata.namespace, |
|
|
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. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
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? |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Container name: required for volumes, optional for env vars |
|
|
Specifies the output format of the exposed resources, defaults to "1" |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
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? |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
The ConfigMap to select from |
|
|
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDeNTIFIeR. |
|
|
The Secret to select from |
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].configMapRef
- Description
-
The ConfigMap to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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? |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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? |
|
|
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
| Property | Type | 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 |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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 |
|
|
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
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. |
|
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
|
|
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. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
|
|
What host IP to bind the external port to. |
|
|
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. |
|
|
If specified, this must be an IANA_SVC_NAMe and unique within the pod. each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
|
|
Protocol 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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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 |
|
|
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
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. |
|
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
|
|
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. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
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[].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
| Property | Type | Description |
|---|---|---|
|
|
AllowPrivilegeescalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeescalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
|
|
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
|
|
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
|
|
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. |
|
|
Whether this container has a read-only root filesystem. Default is false. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Added capabilities |
|
|
Removed capabilities |
.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
| Property | Type | Description |
|---|---|---|
|
|
Level is SeLinux level label that applies to the container. |
|
|
Role is a SeLinux role label that applies to the container. |
|
|
Type is a SeLinux type label that applies to the container. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is "Localhost". |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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 |
|
|
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
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. |
|
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
|
|
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. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
-
-
devicePath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
devicePath is the path inside of the container that the device will be mapped to. |
|
|
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
-
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
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. |
|
|
This must match the Name of a Volume. |
|
|
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Hostnames for the above IP address. |
|
|
IP address of the host file entry. |
.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
| Property | Type | Description |
|---|---|---|
|
|
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
-
| Property | Type | 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 |
|
|
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 |
|
|
List of environment variables to set in the container. Cannot be updated. |
|
|
envVar represents an environment variable present in a Container. |
|
|
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. |
|
|
envFromSource represents the source of a set of ConfigMaps |
|
|
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. |
|
|
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 |
|
|
Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
|
|
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 |
|
|
Name of the container specified as a DNS_LABeL. each container in a pod must have a unique name (DNS_LABeL). Cannot be updated. |
|
|
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. |
|
|
ContainerPort represents a network port in a single container. |
|
|
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 |
|
|
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
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/ |
|
|
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 |
|
|
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. |
|
|
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an eOF. Default is false |
|
|
Optional: 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. |
|
|
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. |
|
|
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
|
volumeDevices is the list of block devices to be used by the container. |
|
|
volumeDevice describes a mapping of a raw block device within a container. |
|
|
Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
VolumeMount describes a mounting of a Volume within a container. |
|
|
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[].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
-
| Property | Type | Description |
|---|---|---|
|
|
Name of the environment variable. Must be a C_IDeNTIFIeR. |
|
|
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 "". |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Selects a key of a ConfigMap. |
|
|
Selects a field of the pod: supports metadata.name, metadata.namespace, |
|
|
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. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
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? |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Container name: required for volumes, optional for env vars |
|
|
Specifies the output format of the exposed resources, defaults to "1" |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
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? |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
The ConfigMap to select from |
|
|
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDeNTIFIeR. |
|
|
The Secret to select from |
.spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].configMapRef
- Description
-
The ConfigMap to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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? |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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? |
|
|
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
| Property | Type | 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 |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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 |
|
|
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
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. |
|
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
|
|
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. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
|
|
What host IP to bind the external port to. |
|
|
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. |
|
|
If specified, this must be an IANA_SVC_NAMe and unique within the pod. each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
|
|
Protocol 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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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 |
|
|
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
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. |
|
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
|
|
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. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
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[].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
| Property | Type | Description |
|---|---|---|
|
|
AllowPrivilegeescalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeescalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
|
|
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
|
|
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
|
|
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. |
|
|
Whether this container has a read-only root filesystem. Default is false. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Added capabilities |
|
|
Removed capabilities |
.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
| Property | Type | Description |
|---|---|---|
|
|
Level is SeLinux level label that applies to the container. |
|
|
Role is a SeLinux role label that applies to the container. |
|
|
Type is a SeLinux type label that applies to the container. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is "Localhost". |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
HTTPGet specifies the http request to perform. |
|
|
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 |
|
|
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
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. |
|
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
|
|
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. |
|
|
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
| Property | Type | 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. |
.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet
- Description
-
HTTPGet specifies the http request to perform.
- Type
-
object - Required
-
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
HTTPHeader describes a custom header to be used in HTTP probes |
|
|
Path to access on the HTTP server. |
|
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
Scheme 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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
|
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
-
-
devicePath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
devicePath is the path inside of the container that the device will be mapped to. |
|
|
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
-
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
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. |
|
|
This must match the Name of a Volume. |
|
|
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
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.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
-
| Property | Type | Description |
|---|---|---|
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
The seccomp options to use by the containers in this pod. |
|
|
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. |
|
|
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. |
|
|
Sysctl defines a kernel parameter to be set |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Level is SeLinux level label that applies to the container. |
|
|
Role is a SeLinux role label that applies to the container. |
|
|
Type is a SeLinux type label that applies to the container. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is "Localhost". |
|
|
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.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
-
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
Name of a property to set |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
effect indicates the taint effect to match. empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and Noexecute. |
|
|
Key is the taint key that the toleration applies to. empty means match all taint keys. If the key is empty, operator must be exists; this combination means to match all values and all keys. |
|
|
Operator 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. |
|
|
TolerationSeconds represents the period of time the toleration (which must be of effect Noexecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
|
|
Value 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
-
-
maxSkew -
topologyKey -
whenUnsatisfiable
-
| Property | Type | 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. |
|
|
MaxSkew describes the degree to which pods may be unevenly distributed. When |
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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
- 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
-
| Property | Type | 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 |
|
|
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
|
|
AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
|
|
CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime |
|
|
Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
|
|
ConfigMap represents a configMap that should populate this volume |
|
|
CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). |
|
|
DownwardAPI represents downward API about the pod that should populate this volume |
|
|
emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
|
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. |
|
|
FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
|
|
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. |
|
|
Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running |
|
|
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 |
|
|
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. |
|
|
Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md |
|
|
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. |
|
|
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 |
|
|
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 |
|
|
NFS represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
|
|
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
|
|
Items for all in one resources secrets, configmaps, and downward API |
|
|
Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime |
|
|
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 |
|
|
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
|
|
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
|
StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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). |
|
|
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 |
|
|
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
-
-
diskName -
diskURI
-
| Property | Type | Description |
|---|---|---|
|
|
Host Caching mode: None, Read Only, Read Write. |
|
|
The Name of the data disk in the blob storage |
|
|
The URI the data disk in the blob storage |
|
|
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. |
|
|
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 |
|
|
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
-
-
secretName -
shareName
-
| Property | Type | Description |
|---|---|---|
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
the name of secret that contains Azure Storage Account Name and Key |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
|
Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
|
Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
|
Optional: 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 |
|
|
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.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
| Property | Type | Description |
|---|---|---|
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
|
|
Optional: points to a secret object containing parameters used to connect to OpenStack. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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. |
|
|
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 '..'. |
|
|
Maps a string key to a path within a volume. |
|
|
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? |
|
|
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
-
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
The key to project. |
|
|
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. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. |
|
|
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. |
|
|
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. |
|
|
Specifies a read-only configuration for the volume. Defaults to false (read/write). |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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[].downwardAPI
- Description
-
DownwardAPI represents downward API about the pod that should populate this volume
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
Items is a list of downward API volume file |
|
|
DownwardAPIVolumeFile represents information to create the file containing the pod field |
.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
-
| Property | Type | Description |
|---|---|---|
|
|
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
|
|
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. |
|
|
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 '..' |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Container name: required for volumes, optional for env vars |
|
|
Specifies the output format of the exposed resources, defaults to "1" |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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
| Property | Type | 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 |
.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 thePodSpec.Volumesarray 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
-
| Property | Type | Description |
|---|---|---|
|
|
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. |
|
|
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.metadata
- Description
-
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
- Type
-
object
.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
| Property | Type | Description |
|---|---|---|
|
|
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
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. |
|
|
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. |
|
|
Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
|
A label query over volumes to consider for binding. |
|
|
Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
VolumeName is the binding reference to the PersistentVolume backing this claim. |
.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
-
-
kind -
name
-
| Property | Type | Description |
|---|---|---|
|
|
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
Kind is the type of resource being referenced |
|
|
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
-
-
kind -
name
-
| Property | Type | Description |
|---|---|---|
|
|
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
Kind is the type of resource being referenced |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
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.selector
- Description
-
A label query over volumes to consider for binding.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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[].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
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine |
|
|
Optional: FC target lun number |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
Optional: FC target worldwide names (WWNs) |
|
|
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[].flexVolume
- Description
-
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
- Type
-
object - Required
-
-
driver
-
| Property | Type | Description |
|---|---|---|
|
|
Driver is the name of the driver to use for this volume. |
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. |
|
|
Optional: extra command options if any. |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
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.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
| Property | Type | Description |
|---|---|---|
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
|
|
Repository URL |
|
|
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
-
-
endpoints -
path
-
| Property | Type | Description |
|---|---|---|
|
|
endpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md#create-a-pod |
|
|
Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md#create-a-pod |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
|
Type 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
-
-
iqn -
lun -
targetPortal
-
| Property | Type | Description |
|---|---|---|
|
|
whether support iSCSI Discovery CHAP authentication |
|
|
whether support iSCSI Session CHAP authentication |
|
|
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 |
|
|
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. |
|
|
Target iSCSI Qualified Name. |
|
|
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). |
|
|
iSCSI Target Lun number. |
|
|
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). |
|
|
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
|
|
CHAP Secret for iSCSI target and initiator authentication |
|
|
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.secretRef
- Description
-
CHAP Secret for iSCSI target and initiator authentication
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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
-
-
path -
server
-
| Property | Type | Description |
|---|---|---|
|
|
Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
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 |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
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. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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. |
|
|
list of volume projections |
|
|
Projection that may be projected along with other supported volume types |
.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
| Property | Type | Description |
|---|---|---|
|
|
information about the configMap data to project |
|
|
information about the downwardAPI data to project |
|
|
information about the secret data to project |
|
|
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
| Property | Type | 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 '..'. |
|
|
Maps a string key to a path within a volume. |
|
|
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? |
|
|
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
-
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
The key to project. |
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Items is a list of DownwardAPIVolume file |
|
|
DownwardAPIVolumeFile represents information to create the file containing the pod field |
.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
-
| Property | Type | Description |
|---|---|---|
|
|
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
|
|
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. |
|
|
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 '..' |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Container name: required for volumes, optional for env vars |
|
|
Specifies the output format of the exposed resources, defaults to "1" |
|
|
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
| Property | Type | 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 '..'. |
|
|
Maps a string key to a path within a volume. |
|
|
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? |
|
|
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
-
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
The key to project. |
|
|
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. |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. |
|
|
expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. |
|
|
Path 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
-
-
registry -
volume
-
| Property | Type | Description |
|---|---|---|
|
|
Group to map volume access to Default is no group |
|
|
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
|
|
Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
|
|
Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin |
|
|
User to map volume access to Defaults to serivceaccount user |
|
|
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
-
-
image -
monitors
-
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
The rados image name. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
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 |
|
|
A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
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 |
|
|
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 |
|
|
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.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
| Property | Type | Description |
|---|---|---|
|
|
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
-
-
gateway -
secretRef -
system
-
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Default is "xfs". |
|
|
The host address of the ScaleIO API Gateway. |
|
|
The name of the ScaleIO Protection Domain for the configured storage. |
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
|
|
Flag to enable/disable SSL communication with Gateway, default false |
|
|
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. |
|
|
The ScaleIO Storage Pool associated with the protection domain. |
|
|
The name of the storage system as configured in ScaleIO. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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. |
|
|
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 '..'. |
|
|
Maps a string key to a path within a volume. |
|
|
Specify whether the Secret or its keys must be defined |
|
|
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
-
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
The key to project. |
|
|
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. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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. |
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. |
|
|
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. |
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. |
|
|
Storage Policy Based Management (SPBM) profile name. |
|
|
Path that identifies vSphere volume vmdk |
.spec.install.spec.permissions
- Description
-
- Type
-
array
.spec.install.spec.permissions[]
- Description
-
StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy
- Type
-
object - Required
-
-
rules -
serviceAccountName
-
| Property | Type | 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. |
|
|
.spec.install.spec.permissions[].rules
- Description
-
- 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
-
| Property | Type | 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. |
|
|
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. |
|
|
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. |
|
|
Resources is a list of resources this rule applies to. '*' represents all resources. |
|
|
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs. |
.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
-
-
supported -
type
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
InstallModeType is a supported type of install mode for CSV installation |
.spec.links
- Description
-
- Type
-
array
.spec.links[]
- Description
-
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
.spec.maintainers
- Description
-
- Type
-
array
.spec.maintainers[]
- Description
-
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
.spec.nativeAPIs
- Description
-
- 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
-
-
group -
kind -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
.spec.provider
- Description
-
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
.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[]
- Description
-
- Type
-
object - Required
-
-
image -
name
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
.spec.selector
- Description
-
Label selector for related resources.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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
- Description
-
- Type
-
array
.spec.webhookdefinitions[]
- Description
-
WebhookDescription provides details to OLM about required webhooks
- Type
-
object - Required
-
-
admissionReviewVersions -
generateName -
sideeffects -
type
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
FailurePolicyType specifies a failure policy that defines how unrecognized errors from the admission endpoint are handled. |
|
|
|
|
|
MatchPolicyType specifies the type of match policy. |
|
|
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. |
|
|
ReinvocationPolicyType specifies what type of policy the admission hook uses. |
|
|
|
|
|
RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid. |
|
|
SideeffectClass specifies the types of side effects a webhook may have. |
|
|
|
|
|
|
|
|
WebhookAdmissionType is the type of admission webhooks supported by OLM |
|
|
.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
| Property | Type | Description |
|---|---|---|
|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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
-
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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[].rules
- Description
-
- 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
| Property | Type | 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. |
|
|
APIVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required. |
|
|
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. |
|
|
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. |
|
|
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 "*". |
.status
- Description
-
ClusterServiceVersionStatus represents information about the status of a CSV. Status may trail the actual state of a system.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
Last time the owned APIService certs were updated |
|
|
Time the owned APIService certs will rotate next |
|
|
CleanupStatus represents information about the status of cleanup while a CSV is pending deletion |
|
|
List of conditions, a history of state transitions |
|
|
Conditions appear in the status as a record of state transitions on the ClusterServiceVersion |
|
|
Last time the status transitioned from one status to another. |
|
|
Last time we updated the status |
|
|
A human readable message indicating details about why the ClusterServiceVersion is in this condition. |
|
|
Current condition of the ClusterServiceVersion |
|
|
A brief CamelCase message indicating details about why the ClusterServiceVersion is in this state. e.g. 'RequirementsNotMet' |
|
|
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
| Property | Type | 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. |
|
|
ResourceList represents a list of resources which are of the same Group/Kind |
.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
-
-
group -
instances -
kind
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
.status.cleanup.pendingDeletion[].instances
- Description
-
- Type
-
array
.status.cleanup.pendingDeletion[].instances[]
- Description
-
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
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
| Property | Type | Description |
|---|---|---|
|
|
Last time the status transitioned from one status to another. |
|
|
Last time we updated the status |
|
|
A human readable message indicating details about why the ClusterServiceVersion is in this condition. |
|
|
Condition of the ClusterServiceVersion |
|
|
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[]
- Description
-
- Type
-
object - Required
-
-
group -
kind -
message -
name -
status -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
DependentStatus is the status for a dependent requirement (to prevent infinite nesting) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
StatusReason is a camelcased reason for the status of a RequirementStatus or DependentStatus |
|
|
|
|
|
.status.requirementStatus[].dependents
- Description
-
- Type
-
array
.status.requirementStatus[].dependents[]
- Description
-
DependentStatus is the status for a dependent requirement (to prevent infinite nesting)
- Type
-
object - Required
-
-
group -
kind -
status -
version
-
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
StatusReason is a camelcased reason for the status of a RequirementStatus or DependentStatus |
|
|
|
|
|
API endpoints
The following API endpoints are available:
-
/apis/operators.coreos.com/v1alpha1/clusterserviceversions-
GeT: list objects of kind ClusterServiceVersion
-
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions-
DeLeTe: delete collection of ClusterServiceVersion -
GeT: list objects of kind ClusterServiceVersion -
POST: create a ClusterServiceVersion
-
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}-
DeLeTe: delete a 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/clusterserviceversions
| Parameter | Type | Description |
|---|---|---|
|
|
allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 Resourceexpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
If 'true', then the output is pretty printed. |
|
|
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
- HTTP method
-
GeT - Description
-
list objects of kind ClusterServiceVersion
| HTTP code | Reponse body |
|---|---|
200 - OK |
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions
| Parameter | Type | Description |
|---|---|---|
|
|
object name and auth scope, such as for teams and projects |
| Parameter | Type | Description |
|---|---|---|
|
|
If 'true', then the output is pretty printed. |
- HTTP method
-
DeLeTe - Description
-
delete collection of ClusterServiceVersion
| Parameter | Type | Description |
|---|---|---|
|
|
allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 Resourceexpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
- HTTP method
-
GeT - Description
-
list objects of kind ClusterServiceVersion
| Parameter | Type | Description |
|---|---|---|
|
|
allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 Resourceexpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
- HTTP method
-
POST - Description
-
create a ClusterServiceVersion
| Parameter | Type | Description |
|---|---|---|
|
|
When 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 |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
name of the ClusterServiceVersion |
|
|
object name and auth scope, such as for teams and projects |
| Parameter | Type | Description |
|---|---|---|
|
|
If 'true', then the output is pretty printed. |
- HTTP method
-
DeLeTe - Description
-
delete a ClusterServiceVersion
| Parameter | Type | Description |
|---|---|---|
|
|
When 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 |
|
|
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
|
|
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. either this field or PropagationPolicy may be set, but not both. |
|
|
Whether and how garbage collection will be performed. either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
- HTTP method
-
GeT - Description
-
read the specified ClusterServiceVersion
| Parameter | Type | Description |
|---|---|---|
|
|
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
| HTTP code | Reponse body |
|---|---|
200 - OK |
- HTTP method
-
PATCH - Description
-
partially update the specified ClusterServiceVersion
| Parameter | Type | Description |
|---|---|---|
|
|
When 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 |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
- HTTP method
-
PUT - Description
-
replace the specified ClusterServiceVersion
| Parameter | Type | Description |
|---|---|---|
|
|
When 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 |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}/status
| Parameter | Type | Description |
|---|---|---|
|
|
name of the ClusterServiceVersion |
|
|
object name and auth scope, such as for teams and projects |
| Parameter | Type | Description |
|---|---|---|
|
|
If 'true', then the output is pretty printed. |
- HTTP method
-
GeT - Description
-
read status of the specified ClusterServiceVersion
| Parameter | Type | Description |
|---|---|---|
|
|
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
| HTTP code | Reponse body |
|---|---|
200 - OK |
- HTTP method
-
PATCH - Description
-
partially update status of the specified ClusterServiceVersion
| Parameter | Type | Description |
|---|---|---|
|
|
When 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 |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
- HTTP method
-
PUT - Description
-
replace status of the specified ClusterServiceVersion
| Parameter | Type | Description |
|---|---|---|
|
|
When 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 |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |