ClusterServiceVersion [operators.coreos.com/v1alpha1]
- Description
- ClusterServiceVersion is a Custom Resource of type `ClusterServiceVersionSpec`.
- Type
object- Required
metadataspec
Specification
.spec
- Description
- ClusterServiceVersionSpec declarations tell OLM how to install an operator that can manage apps for a given version.
- Type
object- Required
displayNameinstall
.spec.annotations
- Description
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
- Type
object
.spec.apiservicedefinitions
- Description
- APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion.
- Type
object
.spec.apiservicedefinitions.owned
- Type
array
.spec.apiservicedefinitions.owned[]
- Description
- APIServiceDescription provides details to OLM about apis provided via aggregation
- Type
object- Required
groupkindnameversion
.spec.apiservicedefinitions.owned[].actionDescriptors
- Type
array
.spec.apiservicedefinitions.owned[].actionDescriptors[]
- Description
- ActionDescriptor describes a declarative action that can be performed on a custom resource instance
- Type
object- Required
path
.spec.apiservicedefinitions.owned[].actionDescriptors[].x-descriptors
- Type
array
.spec.apiservicedefinitions.owned[].actionDescriptors[].x-descriptors[]
- Type
string
.spec.apiservicedefinitions.owned[].resources
- Type
array
.spec.apiservicedefinitions.owned[].resources[]
- Description
- APIResourceReference is a Kubernetes resource type used by a custom resource
- Type
object- Required
kindnameversion
.spec.apiservicedefinitions.owned[].specDescriptors
- Type
array
.spec.apiservicedefinitions.owned[].specDescriptors[]
- Description
- SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
- Type
object- Required
path
.spec.apiservicedefinitions.owned[].specDescriptors[].x-descriptors
- Type
array
.spec.apiservicedefinitions.owned[].specDescriptors[].x-descriptors[]
- Type
string
.spec.apiservicedefinitions.owned[].statusDescriptors
- Type
array
.spec.apiservicedefinitions.owned[].statusDescriptors[]
- Description
- StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
- Type
object- Required
path
.spec.apiservicedefinitions.owned[].statusDescriptors[].x-descriptors
- Type
array
.spec.apiservicedefinitions.owned[].statusDescriptors[].x-descriptors[]
- Type
string
.spec.apiservicedefinitions.required
- Type
array
.spec.apiservicedefinitions.required[]
- Description
- APIServiceDescription provides details to OLM about apis provided via aggregation
- Type
object- Required
groupkindnameversion
.spec.apiservicedefinitions.required[].actionDescriptors
- Type
array
.spec.apiservicedefinitions.required[].actionDescriptors[]
- Description
- ActionDescriptor describes a declarative action that can be performed on a custom resource instance
- Type
object- Required
path
.spec.apiservicedefinitions.required[].actionDescriptors[].x-descriptors
- Type
array
.spec.apiservicedefinitions.required[].actionDescriptors[].x-descriptors[]
- Type
string
.spec.apiservicedefinitions.required[].resources
- Type
array
.spec.apiservicedefinitions.required[].resources[]
- Description
- APIResourceReference is a Kubernetes resource type used by a custom resource
- Type
object- Required
kindnameversion
.spec.apiservicedefinitions.required[].specDescriptors
- Type
array
.spec.apiservicedefinitions.required[].specDescriptors[]
- Description
- SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
- Type
object- Required
path
.spec.apiservicedefinitions.required[].specDescriptors[].x-descriptors
- Type
array
.spec.apiservicedefinitions.required[].specDescriptors[].x-descriptors[]
- Type
string
.spec.apiservicedefinitions.required[].statusDescriptors
- Type
array
.spec.apiservicedefinitions.required[].statusDescriptors[]
- Description
- StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
- Type
object- Required
path
.spec.apiservicedefinitions.required[].statusDescriptors[].x-descriptors
- Type
array
.spec.apiservicedefinitions.required[].statusDescriptors[].x-descriptors[]
- Type
string
.spec.cleanup
- Description
- Cleanup specifies the cleanup behaviour when the CSV gets deleted
- Type
object- Required
enabled
.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
.spec.customresourcedefinitions.owned
- Type
array
.spec.customresourcedefinitions.owned[]
- Description
- CRDDescription provides details to OLM about the CRDs
- Type
object- Required
kindnameversion
.spec.customresourcedefinitions.owned[].actionDescriptors
- Type
array
.spec.customresourcedefinitions.owned[].actionDescriptors[]
- Description
- ActionDescriptor describes a declarative action that can be performed on a custom resource instance
- Type
object- Required
path
.spec.customresourcedefinitions.owned[].actionDescriptors[].x-descriptors
- Type
array
.spec.customresourcedefinitions.owned[].actionDescriptors[].x-descriptors[]
- Type
string
.spec.customresourcedefinitions.owned[].resources
- Type
array
.spec.customresourcedefinitions.owned[].resources[]
- Description
- APIResourceReference is a Kubernetes resource type used by a custom resource
- Type
object- Required
kindnameversion
.spec.customresourcedefinitions.owned[].specDescriptors
- Type
array
.spec.customresourcedefinitions.owned[].specDescriptors[]
- Description
- SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
- Type
object- Required
path
.spec.customresourcedefinitions.owned[].specDescriptors[].x-descriptors
- Type
array
.spec.customresourcedefinitions.owned[].specDescriptors[].x-descriptors[]
- Type
string
.spec.customresourcedefinitions.owned[].statusDescriptors
- Type
array
.spec.customresourcedefinitions.owned[].statusDescriptors[]
- Description
- StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
- Type
object- Required
path
.spec.customresourcedefinitions.owned[].statusDescriptors[].x-descriptors
- Type
array
.spec.customresourcedefinitions.owned[].statusDescriptors[].x-descriptors[]
- Type
string
.spec.customresourcedefinitions.required
- Type
array
.spec.customresourcedefinitions.required[]
- Description
- CRDDescription provides details to OLM about the CRDs
- Type
object- Required
kindnameversion
.spec.customresourcedefinitions.required[].actionDescriptors
- Type
array
.spec.customresourcedefinitions.required[].actionDescriptors[]
- Description
- ActionDescriptor describes a declarative action that can be performed on a custom resource instance
- Type
object- Required
path
.spec.customresourcedefinitions.required[].actionDescriptors[].x-descriptors
- Type
array
.spec.customresourcedefinitions.required[].actionDescriptors[].x-descriptors[]
- Type
string
.spec.customresourcedefinitions.required[].resources
- Type
array
.spec.customresourcedefinitions.required[].resources[]
- Description
- APIResourceReference is a Kubernetes resource type used by a custom resource
- Type
object- Required
kindnameversion
.spec.customresourcedefinitions.required[].specDescriptors
- Type
array
.spec.customresourcedefinitions.required[].specDescriptors[]
- Description
- SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
- Type
object- Required
path
.spec.customresourcedefinitions.required[].specDescriptors[].x-descriptors
- Type
array
.spec.customresourcedefinitions.required[].specDescriptors[].x-descriptors[]
- Type
string
.spec.customresourcedefinitions.required[].statusDescriptors
- Type
array
.spec.customresourcedefinitions.required[].statusDescriptors[]
- Description
- StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
- Type
object- Required
path
.spec.customresourcedefinitions.required[].statusDescriptors[].x-descriptors
- Type
array
.spec.customresourcedefinitions.required[].statusDescriptors[].x-descriptors[]
- Type
string
.spec.icon
- Type
array
.spec.icon[]
- Type
object- Required
base64datamediatype
.spec.install
- Description
- NamedInstallStrategy represents the block of an ClusterServiceVersion resource where the install strategy is specified.
- Type
object- Required
strategy
.spec.install.spec
- Description
- StrategyDetailsDeployment represents the parsed details of a Deployment InstallStrategy.
- Type
object- Required
deployments
.spec.install.spec.clusterPermissions
- Type
array
.spec.install.spec.clusterPermissions[]
- Description
- StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy
- Type
object- Required
rulesserviceAccountName
.spec.install.spec.clusterPermissions[].rules
- Type
array
.spec.install.spec.clusterPermissions[].rules[]
- Description
- PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
- Type
object- Required
verbs
.spec.install.spec.clusterPermissions[].rules[].apiGroups
- Description
- APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
- Type
array
.spec.install.spec.clusterPermissions[].rules[].apiGroups[]
- Type
string
.spec.install.spec.clusterPermissions[].rules[].nonResourceURLs
- Description
- NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
- Type
array
.spec.install.spec.clusterPermissions[].rules[].nonResourceURLs[]
- Type
string
.spec.install.spec.clusterPermissions[].rules[].resourceNames
- Description
- ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- Type
array
.spec.install.spec.clusterPermissions[].rules[].resourceNames[]
- Type
string
.spec.install.spec.clusterPermissions[].rules[].resources
- Description
- Resources is a list of resources this rule applies to. '*' represents all resources.
- Type
array
.spec.install.spec.clusterPermissions[].rules[].resources[]
- Type
string
.spec.install.spec.clusterPermissions[].rules[].verbs
- Description
- Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs.
- Type
array
.spec.install.spec.clusterPermissions[].rules[].verbs[]
- Type
string
.spec.install.spec.deployments
- Type
array
.spec.install.spec.deployments[]
- Description
- StrategyDeploymentSpec contains the name, spec and labels for the deployment ALM should create
- Type
object- Required
namespec
.spec.install.spec.deployments[].label
- Description
- Set is a map of label:value. It implements Labels.
- Type
object
.spec.install.spec.deployments[].spec
- Description
- DeploymentSpec is the specification of the desired behavior of the Deployment.
- Type
object- Required
selectortemplate
.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
.spec.install.spec.deployments[].spec.selector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.selector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.selector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.selector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.selector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.strategy
- Description
- The deployment strategy to use to replace existing pods with new ones.
- Type
object
.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
.spec.install.spec.deployments[].spec.template
- Description
- Template describes the pods that will be created.
- Type
object
.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
.spec.install.spec.deployments[].spec.template.spec.affinity
- Description
- If specified, the pod's scheduling constraints
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity
- Description
- Describes node affinity scheduling rules for the pod.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
- Description
- The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- Description
- An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
- Type
object- Required
preferenceweight
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference
- Description
- A node selector term, associated with the corresponding weight.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions
- Description
- A list of node selector requirements by node's labels.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[].values
- Description
- An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields
- Description
- A list of node selector requirements by node's fields.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[].values
- Description
- An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
- Description
- If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
- Type
object- Required
nodeSelectorTerms
.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
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions
- Description
- A list of node selector requirements by node's labels.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[].values
- Description
- An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields
- Description
- A list of node selector requirements by node's fields.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[].values
- Description
- An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity
- Description
- Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
- Description
- The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- Description
- The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- Type
object- Required
podAffinityTermweight
.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
.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
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
- Description
- A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces
- Description
- namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
- Description
- If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
- Description
- Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
- Type
object- Required
topologyKey
.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
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
- Description
- A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces
- Description
- namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity
- Description
- Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
- Description
- The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- Description
- The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- Type
object- Required
podAffinityTermweight
.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
.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
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
- Description
- A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces
- Description
- namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
- Description
- If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
- Description
- Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
- Type
object- Required
topologyKey
.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
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
- Description
- A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces
- Description
- namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
- Type
array
.spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.containers
- Description
- List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[]
- Description
- A single application container that you want to run within a pod.
- Type
object- Required
name
.spec.install.spec.deployments[].spec.template.spec.containers[].args
- Description
- Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].args[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.containers[].command
- Description
- Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.containers[].env
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].env[]
- Description
- EnvVar represents an environment variable present in a Container.
- Type
object- Required
name
.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
.spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.configMapKeyRef
- Description
- Selects a key of a ConfigMap.
- Type
object- Required
key
.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
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].configMapRef
- Description
- The ConfigMap to select from
- Type
object
.spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].secretRef
- Description
- The Secret to select from
- Type
object
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.spec.install.spec.deployments[].spec.template.spec.containers[].resources.limits
- Description
- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.install.spec.deployments[].spec.template.spec.containers[].resources.requests
- Description
- Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext
- Description
- SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- Type
object
.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
.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities.add
- Description
- Added capabilities
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities.add[]
- Description
- Capability represent POSIX capabilities type
- Type
string
.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities.drop
- Description
- Removed capabilities
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities.drop[]
- Description
- Capability represent POSIX capabilities type
- Type
string
.spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seLinuxOptions
- Description
- The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Type
object
.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
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices[]
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
object- Required
devicePathname
.spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts
- Description
- Pod volumes to mount into the container's filesystem. Cannot be updated.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts[]
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
object- Required
mountPathname
.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
.spec.install.spec.deployments[].spec.template.spec.dnsConfig.nameservers
- Description
- A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.dnsConfig.nameservers[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.dnsConfig.options
- Description
- A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.dnsConfig.options[]
- Description
- PodDNSConfigOption defines DNS resolver options of a pod.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.dnsConfig.searches
- Description
- A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.dnsConfig.searches[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers
- Description
- List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[]
- Description
- An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.
- Type
object- Required
name
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].args
- Description
- Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].args[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].command
- Description
- Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[]
- Description
- EnvVar represents an environment variable present in a Container.
- Type
object- Required
name
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.configMapKeyRef
- Description
- Selects a key of a ConfigMap.
- Type
object- Required
key
.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
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].configMapRef
- Description
- The ConfigMap to select from
- Type
object
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].secretRef
- Description
- The Secret to select from
- Type
object
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle
- Description
- Lifecycle is not allowed for ephemeral containers.
- Type
object
.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
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe
- Description
- Probes are not allowed for ephemeral containers.
- Type
object
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe
- Description
- Probes are not allowed for ephemeral containers.
- Type
object
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources.limits
- Description
- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources.requests
- Description
- Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext
- Description
- Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- Type
object
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities.add
- Description
- Added capabilities
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities.add[]
- Description
- Capability represent POSIX capabilities type
- Type
string
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities.drop
- Description
- Removed capabilities
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities.drop[]
- Description
- Capability represent POSIX capabilities type
- Type
string
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seLinuxOptions
- Description
- The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Type
object
.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
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe
- Description
- Probes are not allowed for ephemeral containers.
- Type
object
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices[]
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
object- Required
devicePathname
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts
- Description
- Pod volumes to mount into the container's filesystem. Cannot be updated.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts[]
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
object- Required
mountPathname
.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
.spec.install.spec.deployments[].spec.template.spec.hostAliases[].hostnames
- Description
- Hostnames for the above IP address.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.hostAliases[].hostnames[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.imagePullSecrets
- Description
- ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
- Type
array
.spec.install.spec.deployments[].spec.template.spec.imagePullSecrets[]
- Description
- LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
- Type
object
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].args
- Description
- Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].args[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.initContainers[].command
- Description
- Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.initContainers[].env
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].env[]
- Description
- EnvVar represents an environment variable present in a Container.
- Type
object- Required
name
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.configMapKeyRef
- Description
- Selects a key of a ConfigMap.
- Type
object- Required
key
.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
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].configMapRef
- Description
- The ConfigMap to select from
- Type
object
.spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].secretRef
- Description
- The Secret to select from
- Type
object
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].resources.limits
- Description
- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.install.spec.deployments[].spec.template.spec.initContainers[].resources.requests
- Description
- Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext
- Description
- SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- Type
object
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities.add
- Description
- Added capabilities
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities.add[]
- Description
- Capability represent POSIX capabilities type
- Type
string
.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities.drop
- Description
- Removed capabilities
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities.drop[]
- Description
- Capability represent POSIX capabilities type
- Type
string
.spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seLinuxOptions
- Description
- The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Type
object
.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
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.exec.command[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.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
.spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices[]
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
object- Required
devicePathname
.spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts
- Description
- Pod volumes to mount into the container's filesystem. Cannot be updated.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts[]
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
object- Required
mountPathname
.spec.install.spec.deployments[].spec.template.spec.nodeSelector
- Description
- NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
- Type
object
.spec.install.spec.deployments[].spec.template.spec.overhead
- Description
- Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.readinessGates
- Description
- If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
- Type
array
.spec.install.spec.deployments[].spec.template.spec.readinessGates[]
- Description
- PodReadinessGate contains the reference to a pod condition
- Type
object- Required
conditionType
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.securityContext.supplementalGroups
- Description
- A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.securityContext.supplementalGroups[]
- Type
integer
.spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls
- Description
- Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls[]
- Description
- Sysctl defines a kernel parameter to be set
- Type
object- Required
namevalue
.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
.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
.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints
- Description
- TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[]
- Description
- TopologySpreadConstraint specifies how to spread matching pods among the given topology.
- Type
object- Required
maxSkewtopologyKeywhenUnsatisfiable
.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
.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes
- Description
- List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[]
- Description
- Volume represents a named volume in a pod that may be accessed by any container in the pod.
- Type
object- Required
name
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].azureDisk
- Description
- AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- Type
object- Required
diskNamediskURI
.spec.install.spec.deployments[].spec.template.spec.volumes[].azureFile
- Description
- AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
- Type
object- Required
secretNameshareName
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs.monitors
- Description
- Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs.monitors[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs.secretRef
- Description
- Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- Type
object
.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
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].configMap
- Description
- ConfigMap represents a configMap that should populate this volume
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items
- Description
- If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items[]
- Description
- Maps a string key to a path within a volume.
- Type
object- Required
keypath
.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
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].csi.volumeAttributes
- Description
- VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI
- Description
- DownwardAPI represents downward API about the pod that should populate this volume
- Type
object
.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
.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
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate
- Description
- Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.
- Type
object- Required
spec
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.accessModes
- Description
- AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.accessModes[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource
- Description
- This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
- Type
object- Required
kindname
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef
- Description
- Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
- Type
object- Required
kindname
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources.limits
- Description
- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources.requests
- Description
- Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector
- Description
- A label query over volumes to consider for binding.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].fc
- Description
- FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].fc.targetWWNs
- Description
- Optional: FC target worldwide names (WWNs)
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].fc.targetWWNs[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.volumes[].fc.wwids
- Description
- Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].fc.wwids[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume
- Description
- FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
- Type
object- Required
driver
.spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume.options
- Description
- Optional: Extra command options if any.
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume.secretRef
- Description
- Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
- Type
object
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].glusterfs
- Description
- Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
- Type
object- Required
endpointspath
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi
- Description
- ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
- Type
object- Required
iqnluntargetPortal
.spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi.portals
- Description
- iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi.portals[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi.secretRef
- Description
- CHAP Secret for iSCSI target and initiator authentication
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].nfs
- Description
- NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- Type
object- Required
pathserver
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].projected
- Description
- Items for all in one resources secrets, configmaps, and downward API
- Type
object
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap
- Description
- information about the configMap data to project
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items
- Description
- If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items[]
- Description
- Maps a string key to a path within a volume.
- Type
object- Required
keypath
.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI
- Description
- information about the downwardAPI data to project
- Type
object
.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
.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
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret
- Description
- information about the secret data to project
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items
- Description
- If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items[]
- Description
- Maps a string key to a path within a volume.
- Type
object- Required
keypath
.spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].serviceAccountToken
- Description
- information about the serviceAccountToken data to project
- Type
object- Required
path
.spec.install.spec.deployments[].spec.template.spec.volumes[].quobyte
- Description
- Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
- Type
object- Required
registryvolume
.spec.install.spec.deployments[].spec.template.spec.volumes[].rbd
- Description
- RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
- Type
object- Required
imagemonitors
.spec.install.spec.deployments[].spec.template.spec.volumes[].rbd.monitors
- Description
- A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].rbd.monitors[]
- Type
string
.spec.install.spec.deployments[].spec.template.spec.volumes[].rbd.secretRef
- Description
- SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- Type
object
.spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO
- Description
- ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
- Type
object- Required
gatewaysecretRefsystem
.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
.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
.spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items
- Description
- If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
- Type
array
.spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items[]
- Description
- Maps a string key to a path within a volume.
- Type
object- Required
keypath
.spec.install.spec.deployments[].spec.template.spec.volumes[].storageos
- Description
- StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
- Type
object
.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
.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
.spec.install.spec.permissions
- Type
array
.spec.install.spec.permissions[]
- Description
- StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy
- Type
object- Required
rulesserviceAccountName
.spec.install.spec.permissions[].rules
- Type
array
.spec.install.spec.permissions[].rules[]
- Description
- PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
- Type
object- Required
verbs
.spec.install.spec.permissions[].rules[].apiGroups
- Description
- APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
- Type
array
.spec.install.spec.permissions[].rules[].apiGroups[]
- Type
string
.spec.install.spec.permissions[].rules[].nonResourceURLs
- Description
- NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
- Type
array
.spec.install.spec.permissions[].rules[].nonResourceURLs[]
- Type
string
.spec.install.spec.permissions[].rules[].resourceNames
- Description
- ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- Type
array
.spec.install.spec.permissions[].rules[].resourceNames[]
- Type
string
.spec.install.spec.permissions[].rules[].resources
- Description
- Resources is a list of resources this rule applies to. '*' represents all resources.
- Type
array
.spec.install.spec.permissions[].rules[].resources[]
- Type
string
.spec.install.spec.permissions[].rules[].verbs
- Description
- Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs.
- Type
array
.spec.install.spec.permissions[].rules[].verbs[]
- Type
string
.spec.installModes
- Description
- InstallModes specify supported installation types
- Type
array
.spec.installModes[]
- Description
- InstallMode associates an InstallModeType with a flag representing if the CSV supports it
- Type
object- Required
supportedtype
.spec.keywords
- Type
array
.spec.keywords[]
- Type
string
.spec.labels
- Description
- Map of string keys and values that can be used to organize and categorize (scope and select) objects.
- Type
object
.spec.links
- Type
array
.spec.links[]
- Type
object
.spec.maintainers
- Type
array
.spec.maintainers[]
- Type
object
.spec.nativeAPIs
- Type
array
.spec.nativeAPIs[]
- Description
- GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling
- Type
object- Required
groupkindversion
.spec.provider
- Type
object
.spec.relatedImages
- Description
- List any related images, or other container images that your Operator might require to perform their functions. This list should also include operand images as well. All image references should be specified by digest (SHA) and not by tag. This field is only used during catalog creation and plays no part in cluster runtime.
- Type
array
.spec.relatedImages[]
- Type
object- Required
imagename
.spec.selector
- Description
- Label selector for related resources.
- Type
object
.spec.selector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.selector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.selector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.selector.matchExpressions[].values[]
- Type
string
.spec.selector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.skips
- Description
- The name(s) of one or more CSV(s) that should be skipped in the upgrade graph. Should match the `metadata.Name` field of the CSV that should be skipped. This field is only used during catalog creation and plays no part in cluster runtime.
- Type
array
.spec.skips[]
- Type
string
.spec.webhookdefinitions
- Type
array
.spec.webhookdefinitions[]
- Description
- WebhookDescription provides details to OLM about required webhooks
- Type
object- Required
admissionReviewVersionsgenerateNamesideEffectstype
.spec.webhookdefinitions[].admissionReviewVersions
- Type
array
.spec.webhookdefinitions[].admissionReviewVersions[]
- Type
string
.spec.webhookdefinitions[].conversionCRDs
- Type
array
.spec.webhookdefinitions[].conversionCRDs[]
- Type
string
.spec.webhookdefinitions[].objectSelector
- Description
- A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- Type
object
.spec.webhookdefinitions[].objectSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.webhookdefinitions[].objectSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.webhookdefinitions[].objectSelector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.webhookdefinitions[].objectSelector.matchExpressions[].values[]
- Type
string
.spec.webhookdefinitions[].objectSelector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.spec.webhookdefinitions[].rules
- Type
array
.spec.webhookdefinitions[].rules[]
- Description
- RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.
- Type
object
.spec.webhookdefinitions[].rules[].apiGroups
- Description
- APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- Type
array
.spec.webhookdefinitions[].rules[].apiGroups[]
- Type
string
.spec.webhookdefinitions[].rules[].apiVersions
- Description
- APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- Type
array
.spec.webhookdefinitions[].rules[].apiVersions[]
- Type
string
.spec.webhookdefinitions[].rules[].operations
- Description
- Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- Type
array
.spec.webhookdefinitions[].rules[].operations[]
- Description
- OperationType specifies an operation for a request.
- Type
string
.spec.webhookdefinitions[].rules[].resources
- Description
- Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required.
- Type
array
.spec.webhookdefinitions[].rules[].resources[]
- Type
string
.status
- Description
- ClusterServiceVersionStatus represents information about the status of a CSV. Status may trail the actual state of a system.
- Type
object
.status.cleanup
- Description
- CleanupStatus represents information about the status of cleanup while a CSV is pending deletion
- Type
object
.status.cleanup.pendingDeletion
- Description
- PendingDeletion is the list of custom resource objects that are pending deletion and blocked on finalizers. This indicates the progress of cleanup that is blocking CSV deletion or operator uninstall.
- Type
array
.status.cleanup.pendingDeletion[]
- Description
- ResourceList represents a list of resources which are of the same Group/Kind
- Type
object- Required
groupinstanceskind
.status.cleanup.pendingDeletion[].instances
- Type
array
.status.cleanup.pendingDeletion[].instances[]
- Type
object- Required
name
.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
.status.requirementStatus
- Description
- The status of each requirement for this CSV
- Type
array
.status.requirementStatus[]
- Type
object- Required
groupkindmessagenamestatusversion
.status.requirementStatus[].dependents
- Type
array
.status.requirementStatus[].dependents[]
- Description
- DependentStatus is the status for a dependent requirement (to prevent infinite nesting)
- Type
object- Required
groupkindstatusversion
API Endpoints
The following API endpoints are available:
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversionsDELETE: delete collection of ClusterServiceVersionGET: list objects of kind ClusterServiceVersionPOST: create a new ClusterServiceVersion
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}DELETE: delete the specified ClusterServiceVersionGET: read the specified ClusterServiceVersionPATCH: partially update the specified ClusterServiceVersionPUT: replace the specified ClusterServiceVersion
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}/statusGET: read status of the specified ClusterServiceVersionPATCH: partially update status of the specified ClusterServiceVersionPUT: replace status of the specified ClusterServiceVersion
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions
- HTTP method
DELETE- Description
- delete collection of ClusterServiceVersion
- HTTP responses
- HTTP method
GET- Description
- list objects of kind ClusterServiceVersion
- HTTP responses
- HTTP method
POST- Description
- create a new ClusterServiceVersion
- Query parameters
- Body parameters
- HTTP responses
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}
- HTTP method
DELETE- Description
- delete the specified ClusterServiceVersion
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified ClusterServiceVersion
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified ClusterServiceVersion
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified ClusterServiceVersion
- Query parameters
- Body parameters
- HTTP responses
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}/status
- HTTP method
GET- Description
- read status of the specified ClusterServiceVersion
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified ClusterServiceVersion
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified ClusterServiceVersion
- Query parameters
- Body parameters
- HTTP responses