Alertmanager
Scope: Namespaced
Version: v1
Alertmanager describes an Alertmanager cluster.
- stringapiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- stringkind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- objectmetadata
- objectspec
Required value
Specification of the desired behavior of the Alertmanager cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- array of stringsspec.additionalPeers
AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster.
- objectspec.affinity
If specified, the pod’s scheduling constraints.
- objectspec.affinity.nodeAffinity
Describes node affinity scheduling rules for the pod.
- array of objectsspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
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).
- objectspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference
Required value
A node selector term, associated with the corresponding weight.
- array of objectsspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions
A list of node selector requirements by node’s labels.
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.key
Required value
The label key that the selector applies to.
- stringspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.operator
Required value
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array of stringsspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.values
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- array of objectsspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields
A list of node selector requirements by node’s fields.
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.key
Required value
The label key that the selector applies to.
- stringspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.operator
Required value
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array of stringsspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.values
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- integerspec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.weight
Required value
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
- objectspec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
- array of objectsspec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
Required value
Required. A list of node selector terms. The terms are ORed.
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
- array of objectsspec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions
A list of node selector requirements by node’s labels.
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.key
Required value
The label key that the selector applies to.
- stringspec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.operator
Required value
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array of stringsspec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.values
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- array of objectsspec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields
A list of node selector requirements by node’s fields.
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.key
Required value
The label key that the selector applies to.
- stringspec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.operator
Required value
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array of stringsspec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.values
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- objectspec.affinity.podAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- array of objectsspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- objectspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm
Required value
Required. A pod affinity term, associated with the corresponding weight.
- objectspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods.
- array of objectsspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- objectspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
- array of objectsspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- array of stringsspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.
- stringspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey
Required value
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
- integerspec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.weight
Required value
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- array of objectsspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
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
matches that of any node on which a pod of the set of pods is running - objectspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector
A label query over a set of resources, in this case pods.
- array of objectsspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- objectspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
- array of objectsspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- array of stringsspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaces
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.
- stringspec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey
Required value
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
- objectspec.affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- array of objectsspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- objectspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm
Required value
Required. A pod affinity term, associated with the corresponding weight.
- objectspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods.
- array of objectsspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- objectspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
- array of objectsspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- array of stringsspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.
- stringspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey
Required value
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
- integerspec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.weight
Required value
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- array of objectsspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
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
matches that of any node on which a pod of the set of pods is running - objectspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector
A label query over a set of resources, in this case pods.
- array of objectsspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- objectspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
- array of objectsspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- array of stringsspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaces
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.
- stringspec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey
Required value
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
- objectspec.alertmanagerConfigMatcherStrategy
The AlertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects match the alerts. In the future more options may be added.
- stringspec.alertmanagerConfigMatcherStrategy.type
If set to
OnNamespace, the operator injects a label matcher matching the namespace of the AlertmanagerConfig object for all its routes and inhibition rules.Nonewill not add any additional matchers other than the ones specified in the AlertmanagerConfig. Default isOnNamespace.Default:
"OnNamespace"Allowed values:
OnNamespace,None
- objectspec.alertmanagerConfigNamespaceSelector
Namespaces to be selected for AlertmanagerConfig discovery. If nil, only check own namespace.
- array of objectsspec.alertmanagerConfigNamespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.alertmanagerConfigNamespaceSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.alertmanagerConfigNamespaceSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.alertmanagerConfigNamespaceSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.alertmanagerConfigNamespaceSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- objectspec.alertmanagerConfigSelector
AlertmanagerConfigs to be selected for to merge and configure Alertmanager with.
- array of objectsspec.alertmanagerConfigSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.alertmanagerConfigSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.alertmanagerConfigSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.alertmanagerConfigSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.alertmanagerConfigSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- objectspec.alertmanagerConfiguration
EXPERIMENTAL: alertmanagerConfiguration specifies the configuration of Alertmanager. If defined, it takes precedence over the
configSecretfield. This field may change in future releases.- objectspec.alertmanagerConfiguration.global
Defines the global parameters of the Alertmanager configuration.
- objectspec.alertmanagerConfiguration.global.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- objectspec.alertmanagerConfiguration.global.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- objectspec.alertmanagerConfiguration.global.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- stringspec.alertmanagerConfiguration.global.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- objectspec.alertmanagerConfiguration.global.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- stringspec.alertmanagerConfiguration.global.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- objectspec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret
The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the Alertmanager object and accessible by the Prometheus Operator.
- stringspec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- booleanspec.alertmanagerConfiguration.global.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- objectspec.alertmanagerConfiguration.global.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- objectspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- objectspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- stringspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- stringspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- objectspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- stringspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- objectspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- stringspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- objectspec.alertmanagerConfiguration.global.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- array of stringsspec.alertmanagerConfiguration.global.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- stringspec.alertmanagerConfiguration.global.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- stringspec.alertmanagerConfiguration.global.httpConfig.proxyURL
Optional proxy URL.
- objectspec.alertmanagerConfiguration.global.httpConfig.tlsConfig
TLS configuration for the client.
- objectspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- objectspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- objectspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- objectspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- objectspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- objectspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- booleanspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- objectspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- stringspec.alertmanagerConfiguration.global.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- objectspec.alertmanagerConfiguration.global.opsGenieApiKey
The default OpsGenie API Key.
- stringspec.alertmanagerConfiguration.global.opsGenieApiKey.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.opsGenieApiKey.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.opsGenieApiKey.optional
Specify whether the Secret or its key must be defined
- objectspec.alertmanagerConfiguration.global.opsGenieApiUrl
The default OpsGenie API URL.
- stringspec.alertmanagerConfiguration.global.opsGenieApiUrl.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.opsGenieApiUrl.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.opsGenieApiUrl.optional
Specify whether the Secret or its key must be defined
- stringspec.alertmanagerConfiguration.global.pagerdutyUrl
The default Pagerduty URL.
- stringspec.alertmanagerConfiguration.global.resolveTimeout
ResolveTimeout is the default value used by alertmanager if the alert does not include EndsAt, after this time passes it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ - objectspec.alertmanagerConfiguration.global.slackApiUrl
The default Slack API URL.
- stringspec.alertmanagerConfiguration.global.slackApiUrl.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.slackApiUrl.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.slackApiUrl.optional
Specify whether the Secret or its key must be defined
- objectspec.alertmanagerConfiguration.global.smtp
Configures global SMTP parameters.
- stringspec.alertmanagerConfiguration.global.smtp.authIdentity
SMTP Auth using PLAIN
- objectspec.alertmanagerConfiguration.global.smtp.authPassword
SMTP Auth using LOGIN and PLAIN.
- stringspec.alertmanagerConfiguration.global.smtp.authPassword.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.smtp.authPassword.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.smtp.authPassword.optional
Specify whether the Secret or its key must be defined
- objectspec.alertmanagerConfiguration.global.smtp.authSecret
SMTP Auth using CRAM-MD5.
- stringspec.alertmanagerConfiguration.global.smtp.authSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.global.smtp.authSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.global.smtp.authSecret.optional
Specify whether the Secret or its key must be defined
- stringspec.alertmanagerConfiguration.global.smtp.authUsername
SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn’t authenticate to the SMTP server.
- stringspec.alertmanagerConfiguration.global.smtp.from
The default SMTP From header field.
- stringspec.alertmanagerConfiguration.global.smtp.hello
The default hostname to identify to the SMTP server.
- booleanspec.alertmanagerConfiguration.global.smtp.requireTLS
The default SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.
- objectspec.alertmanagerConfiguration.global.smtp.smartHost
The default SMTP smarthost used for sending emails.
- stringspec.alertmanagerConfiguration.global.smtp.smartHost.host
Required value
Defines the host’s address, it can be a DNS name or a literal IP address.
- stringspec.alertmanagerConfiguration.global.smtp.smartHost.port
Required value
Defines the host’s port, it can be a literal port number or a port name.
- stringspec.alertmanagerConfiguration.name
The name of the AlertmanagerConfig resource which is used to generate the Alertmanager configuration. It must be defined in the same namespace as the Alertmanager object. The operator will not enforce a
namespacelabel for routes and inhibition rules. - array of objectsspec.alertmanagerConfiguration.templates
Custom notification templates.
SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive.
- objectspec.alertmanagerConfiguration.templates.configMap
ConfigMap containing data to use for the targets.
- stringspec.alertmanagerConfiguration.templates.configMap.key
Required value
The key to select.
- stringspec.alertmanagerConfiguration.templates.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.templates.configMap.optional
Specify whether the ConfigMap or its key must be defined
- objectspec.alertmanagerConfiguration.templates.secret
Secret containing data to use for the targets.
- stringspec.alertmanagerConfiguration.templates.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.alertmanagerConfiguration.templates.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.alertmanagerConfiguration.templates.secret.optional
Specify whether the Secret or its key must be defined
- booleanspec.automountServiceAccountToken
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod. If the service account has
automountServiceAccountToken: true, set the field tofalseto opt out of automounting API credentials. - stringspec.baseImage
Base image that is used to deploy pods, without tag. Deprecated: use ‘image’ instead
- stringspec.clusterAdvertiseAddress
ClusterAdvertiseAddress is the explicit address to advertise in cluster. Needs to be provided for non RFC1918 [1] (public) addresses. [1] RFC1918: https://tools.ietf.org/html/rfc1918
- stringspec.clusterGossipInterval
Interval between gossip attempts.
Pattern:
^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ - stringspec.clusterPeerTimeout
Timeout for cluster peering.
Pattern:
^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ - stringspec.clusterPushpullInterval
Interval between pushpull attempts.
Pattern:
^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ - array of stringsspec.configMaps
ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. Each ConfigMap is added to the StatefulSet definition as a volume named
configmap-<configmap-name>. The ConfigMaps are mounted into/etc/alertmanager/configmaps/<configmap-name>in the ‘alertmanager’ container. - stringspec.configSecret
ConfigSecret is the name of a Kubernetes Secret in the same namespace as the Alertmanager object, which contains the configuration for this Alertmanager instance. If empty, it defaults to
alertmanager-<alertmanager-name>. The Alertmanager configuration should be available under thealertmanager.yamlkey. Additional keys from the original secret are copied to the generated secret and mounted into the/etc/alertmanager/configdirectory in thealertmanagercontainer. If either the secret or thealertmanager.yamlkey is missing, the operator provisions a minimal Alertmanager configuration with one empty receiver (effectively dropping alert notifications). - array of objectsspec.containers
Containers allows injecting additional containers. This is meant to allow adding an authentication proxy to an Alertmanager pod. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch. The current container names are:
alertmanagerandconfig-reloader. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.A single application container that you want to run within a pod.
- array of stringsspec.containers.args
Arguments to the entrypoint. The container image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double \(are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "\)(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- array of stringsspec.containers.command
Entrypoint array. Not executed within a shell. The container image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double \(are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "\)(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- array of objectsspec.containers.env
List of environment variables to set in the container. Cannot be updated.
EnvVar represents an environment variable present in a Container.
- stringspec.containers.env.name
Required value
Name of the environment variable. Must be a C_IDENTIFIER.
- stringspec.containers.env.value
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double \(are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "\)(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.
- objectspec.containers.env.valueFrom
Source for the environment variable’s value. Cannot be used if value is not empty.
- objectspec.containers.env.valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
- stringspec.containers.env.valueFrom.configMapKeyRef.key
Required value
The key to select.
- stringspec.containers.env.valueFrom.configMapKeyRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.containers.env.valueFrom.configMapKeyRef.optional
Specify whether the ConfigMap or its key must be defined
- objectspec.containers.env.valueFrom.fieldRef
Selects a field of the pod: supports metadata.name, metadata.namespace,
metadata.labels['<KEY>'],metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.- stringspec.containers.env.valueFrom.fieldRef.apiVersion
Version of the schema the FieldPath is written in terms of, defaults to “v1”.
- stringspec.containers.env.valueFrom.fieldRef.fieldPath
Required value
Path of the field to select in the specified API version.
- objectspec.containers.env.valueFrom.resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- stringspec.containers.env.valueFrom.resourceFieldRef.containerName
Container name: required for volumes, optional for env vars
- integer or stringspec.containers.env.valueFrom.resourceFieldRef.divisor
Specifies the output format of the exposed resources, defaults to “1”
Pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - stringspec.containers.env.valueFrom.resourceFieldRef.resource
Required value
Required: resource to select
- objectspec.containers.env.valueFrom.secretKeyRef
Selects a key of a secret in the pod’s namespace
- stringspec.containers.env.valueFrom.secretKeyRef.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.containers.env.valueFrom.secretKeyRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.containers.env.valueFrom.secretKeyRef.optional
Specify whether the Secret or its key must be defined
- array of objectsspec.containers.envFrom
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
EnvFromSource represents the source of a set of ConfigMaps
- objectspec.containers.envFrom.configMapRef
The ConfigMap to select from
- stringspec.containers.envFrom.configMapRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.containers.envFrom.configMapRef.optional
Specify whether the ConfigMap must be defined
- stringspec.containers.envFrom.prefix
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- objectspec.containers.envFrom.secretRef
The Secret to select from
- stringspec.containers.envFrom.secretRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.containers.envFrom.secretRef.optional
Specify whether the Secret must be defined
- stringspec.containers.image
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
- stringspec.containers.imagePullPolicy
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
- objectspec.containers.lifecycle
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- objectspec.containers.lifecycle.postStart
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- objectspec.containers.lifecycle.postStart.exec
Exec specifies the action to take.
- array of stringsspec.containers.lifecycle.postStart.exec.command
Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘ ’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- objectspec.containers.lifecycle.postStart.httpGet
HTTPGet specifies the http request to perform.
- stringspec.containers.lifecycle.postStart.httpGet.host
Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
- array of objectsspec.containers.lifecycle.postStart.httpGet.httpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
HTTPHeader describes a custom header to be used in HTTP probes
- stringspec.containers.lifecycle.postStart.httpGet.httpHeaders.name
Required value
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- stringspec.containers.lifecycle.postStart.httpGet.httpHeaders.value
Required value
The header field value
- stringspec.containers.lifecycle.postStart.httpGet.path
Path to access on the HTTP server.
- integer or stringspec.containers.lifecycle.postStart.httpGet.port
Required value
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- stringspec.containers.lifecycle.postStart.httpGet.scheme
Scheme to use for connecting to the host. Defaults to HTTP.
- objectspec.containers.lifecycle.postStart.tcpSocket
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
- stringspec.containers.lifecycle.postStart.tcpSocket.host
Optional: Host name to connect to, defaults to the pod IP.
- integer or stringspec.containers.lifecycle.postStart.tcpSocket.port
Required value
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- objectspec.containers.lifecycle.preStop
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod’s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- objectspec.containers.lifecycle.preStop.exec
Exec specifies the action to take.
- array of stringsspec.containers.lifecycle.preStop.exec.command
Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘ ’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- objectspec.containers.lifecycle.preStop.httpGet
HTTPGet specifies the http request to perform.
- stringspec.containers.lifecycle.preStop.httpGet.host
Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
- array of objectsspec.containers.lifecycle.preStop.httpGet.httpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
HTTPHeader describes a custom header to be used in HTTP probes
- stringspec.containers.lifecycle.preStop.httpGet.httpHeaders.name
Required value
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- stringspec.containers.lifecycle.preStop.httpGet.httpHeaders.value
Required value
The header field value
- stringspec.containers.lifecycle.preStop.httpGet.path
Path to access on the HTTP server.
- integer or stringspec.containers.lifecycle.preStop.httpGet.port
Required value
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- stringspec.containers.lifecycle.preStop.httpGet.scheme
Scheme to use for connecting to the host. Defaults to HTTP.
- objectspec.containers.lifecycle.preStop.tcpSocket
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
- stringspec.containers.lifecycle.preStop.tcpSocket.host
Optional: Host name to connect to, defaults to the pod IP.
- integer or stringspec.containers.lifecycle.preStop.tcpSocket.port
Required value
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- objectspec.containers.livenessProbe
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- objectspec.containers.livenessProbe.exec
Exec specifies the action to take.
- array of stringsspec.containers.livenessProbe.exec.command
Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘ ’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- integerspec.containers.livenessProbe.failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- objectspec.containers.livenessProbe.grpc
GRPC specifies an action involving a GRPC port.
- integerspec.containers.livenessProbe.grpc.port
Required value
Port number of the gRPC service. Number must be in the range 1 to 65535.
- stringspec.containers.livenessProbe.grpc.service
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- objectspec.containers.livenessProbe.httpGet
HTTPGet specifies the http request to perform.
- stringspec.containers.livenessProbe.httpGet.host
Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
- array of objectsspec.containers.livenessProbe.httpGet.httpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
HTTPHeader describes a custom header to be used in HTTP probes
- stringspec.containers.livenessProbe.httpGet.httpHeaders.name
Required value
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- stringspec.containers.livenessProbe.httpGet.httpHeaders.value
Required value
The header field value
- stringspec.containers.livenessProbe.httpGet.path
Path to access on the HTTP server.
- integer or stringspec.containers.livenessProbe.httpGet.port
Required value
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- stringspec.containers.livenessProbe.httpGet.scheme
Scheme to use for connecting to the host. Defaults to HTTP.
- integerspec.containers.livenessProbe.initialDelaySeconds
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- integerspec.containers.livenessProbe.periodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- integerspec.containers.livenessProbe.successThreshold
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
- objectspec.containers.livenessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port.
- stringspec.containers.livenessProbe.tcpSocket.host
Optional: Host name to connect to, defaults to the pod IP.
- integer or stringspec.containers.livenessProbe.tcpSocket.port
Required value
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- integerspec.containers.livenessProbe.terminationGracePeriodSeconds
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
- integerspec.containers.livenessProbe.timeoutSeconds
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- stringspec.containers.name
Required value
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
- array of objectsspec.containers.ports
List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
ContainerPort represents a network port in a single container.
- integerspec.containers.ports.containerPort
Required value
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
- stringspec.containers.ports.hostIP
What host IP to bind the external port to.
- integerspec.containers.ports.hostPort
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
- stringspec.containers.ports.name
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
- stringspec.containers.ports.protocol
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.
Default:
"TCP"
- objectspec.containers.readinessProbe
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- objectspec.containers.readinessProbe.exec
Exec specifies the action to take.
- array of stringsspec.containers.readinessProbe.exec.command
Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘ ’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- integerspec.containers.readinessProbe.failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- objectspec.containers.readinessProbe.grpc
GRPC specifies an action involving a GRPC port.
- integerspec.containers.readinessProbe.grpc.port
Required value
Port number of the gRPC service. Number must be in the range 1 to 65535.
- stringspec.containers.readinessProbe.grpc.service
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- objectspec.containers.readinessProbe.httpGet
HTTPGet specifies the http request to perform.
- stringspec.containers.readinessProbe.httpGet.host
Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
- array of objectsspec.containers.readinessProbe.httpGet.httpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
HTTPHeader describes a custom header to be used in HTTP probes
- stringspec.containers.readinessProbe.httpGet.httpHeaders.name
Required value
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- stringspec.containers.readinessProbe.httpGet.httpHeaders.value
Required value
The header field value
- stringspec.containers.readinessProbe.httpGet.path
Path to access on the HTTP server.
- integer or stringspec.containers.readinessProbe.httpGet.port
Required value
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- stringspec.containers.readinessProbe.httpGet.scheme
Scheme to use for connecting to the host. Defaults to HTTP.
- integerspec.containers.readinessProbe.initialDelaySeconds
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- integerspec.containers.readinessProbe.periodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- integerspec.containers.readinessProbe.successThreshold
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
- objectspec.containers.readinessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port.
- stringspec.containers.readinessProbe.tcpSocket.host
Optional: Host name to connect to, defaults to the pod IP.
- integer or stringspec.containers.readinessProbe.tcpSocket.port
Required value
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- integerspec.containers.readinessProbe.terminationGracePeriodSeconds
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
- integerspec.containers.readinessProbe.timeoutSeconds
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- array of objectsspec.containers.resizePolicy
Resources resize policy for the container.
ContainerResizePolicy represents resource resize policy for the container.
- stringspec.containers.resizePolicy.resourceName
Required value
Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
- stringspec.containers.resizePolicy.restartPolicy
Required value
Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
- objectspec.containers.resources
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- array of objectsspec.containers.resources.claims
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
ResourceClaim references one entry in PodSpec.ResourceClaims.
- stringspec.containers.resources.claims.name
Required value
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- objectspec.containers.resources.limits
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- objectspec.containers.resources.requests
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- stringspec.containers.restartPolicy
RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is “Always”. For non-init containers or when this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Setting the RestartPolicy as “Always” for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy “Always” will be shut down. This lifecycle differs from normal init containers and is often referred to as a “sidecar” container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
- objectspec.containers.securityContext
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- booleanspec.containers.securityContext.allowPrivilegeEscalation
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
- objectspec.containers.securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
- array of stringsspec.containers.securityContext.capabilities.add
Added capabilities
- stringElement of the array
Capability represent POSIX capabilities type
- array of stringsspec.containers.securityContext.capabilities.drop
Removed capabilities
- stringElement of the array
Capability represent POSIX capabilities type
- booleanspec.containers.securityContext.privileged
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
- stringspec.containers.securityContext.procMount
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
- booleanspec.containers.securityContext.readOnlyRootFilesystem
Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
- integerspec.containers.securityContext.runAsGroup
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
- booleanspec.containers.securityContext.runAsNonRoot
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- integerspec.containers.securityContext.runAsUser
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
- objectspec.containers.securityContext.seLinuxOptions
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
- stringspec.containers.securityContext.seLinuxOptions.level
Level is SELinux level label that applies to the container.
- stringspec.containers.securityContext.seLinuxOptions.role
Role is a SELinux role label that applies to the container.
- stringspec.containers.securityContext.seLinuxOptions.type
Type is a SELinux type label that applies to the container.
- stringspec.containers.securityContext.seLinuxOptions.user
User is a SELinux user label that applies to the container.
- objectspec.containers.securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
- stringspec.containers.securityContext.seccompProfile.localhostProfile
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.
- stringspec.containers.securityContext.seccompProfile.type
Required value
type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
- objectspec.containers.securityContext.windowsOptions
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
- stringspec.containers.securityContext.windowsOptions.gmsaCredentialSpec
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
- stringspec.containers.securityContext.windowsOptions.gmsaCredentialSpecName
GMSACredentialSpecName is the name of the GMSA credential spec to use.
- booleanspec.containers.securityContext.windowsOptions.hostProcess
HostProcess determines if a container should be run as a ‘Host Process’ container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
- stringspec.containers.securityContext.windowsOptions.runAsUserName
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- objectspec.containers.startupProbe
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- objectspec.containers.startupProbe.exec
Exec specifies the action to take.
- array of stringsspec.containers.startupProbe.exec.command
Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘ ’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- integerspec.containers.startupProbe.failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- objectspec.containers.startupProbe.grpc
GRPC specifies an action involving a GRPC port.
- integerspec.containers.startupProbe.grpc.port
Required value
Port number of the gRPC service. Number must be in the range 1 to 65535.
- stringspec.containers.startupProbe.grpc.service
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- objectspec.containers.startupProbe.httpGet
HTTPGet specifies the http request to perform.
- stringspec.containers.startupProbe.httpGet.host
Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
- array of objectsspec.containers.startupProbe.httpGet.httpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
HTTPHeader describes a custom header to be used in HTTP probes
- stringspec.containers.startupProbe.httpGet.httpHeaders.name
Required value
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- stringspec.containers.startupProbe.httpGet.httpHeaders.value
Required value
The header field value
- stringspec.containers.startupProbe.httpGet.path
Path to access on the HTTP server.
- integer or stringspec.containers.startupProbe.httpGet.port
Required value
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- stringspec.containers.startupProbe.httpGet.scheme
Scheme to use for connecting to the host. Defaults to HTTP.
- integerspec.containers.startupProbe.initialDelaySeconds
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- integerspec.containers.startupProbe.periodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- integerspec.containers.startupProbe.successThreshold
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
- objectspec.containers.startupProbe.tcpSocket
TCPSocket specifies an action involving a TCP port.
- stringspec.containers.startupProbe.tcpSocket.host
Optional: Host name to connect to, defaults to the pod IP.
- integer or stringspec.containers.startupProbe.tcpSocket.port
Required value
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- integerspec.containers.startupProbe.terminationGracePeriodSeconds
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
- integerspec.containers.startupProbe.timeoutSeconds
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- booleanspec.containers.stdin
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
- booleanspec.containers.stdinOnce
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
- stringspec.containers.terminationMessagePath
Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
- stringspec.containers.terminationMessagePolicy
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- booleanspec.containers.tty
Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.
- array of objectsspec.containers.volumeDevices
volumeDevices is the list of block devices to be used by the container.
volumeDevice describes a mapping of a raw block device within a container.
- stringspec.containers.volumeDevices.devicePath
Required value
devicePath is the path inside of the container that the device will be mapped to.
- stringspec.containers.volumeDevices.name
Required value
name must match the name of a persistentVolumeClaim in the pod
- array of objectsspec.containers.volumeMounts
Pod volumes to mount into the container’s filesystem. Cannot be updated.
VolumeMount describes a mounting of a Volume within a container.
- stringspec.containers.volumeMounts.mountPath
Required value
Path within the container at which the volume should be mounted. Must not contain ‘:’.
- stringspec.containers.volumeMounts.mountPropagation
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
- stringspec.containers.volumeMounts.name
Required value
This must match the Name of a Volume.
- booleanspec.containers.volumeMounts.readOnly
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- stringspec.containers.volumeMounts.subPath
Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).
- stringspec.containers.volumeMounts.subPathExpr
Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive.
- stringspec.containers.workingDir
Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.
- stringspec.externalUrl
The external URL the Alertmanager instances will be available under. This is necessary to generate correct URLs. This is necessary if Alertmanager is not served from root of a DNS name.
- booleanspec.forceEnableClusterMode
ForceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica. Use case is e.g. spanning an Alertmanager cluster across Kubernetes clusters with a single replica in each.
- array of objectsspec.hostAliases
Pods’ hostAliases configuration
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
- array of stringsspec.hostAliases.hostnames
Required value
Hostnames for the above IP address.
- stringspec.hostAliases.ip
Required value
IP address of the host file entry.
- stringspec.image
Image if specified has precedence over baseImage, tag and SHA combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Alertmanager is being configured.
- stringspec.imagePullPolicy
Image pull policy for the ‘alertmanager’, ‘init-config-reloader’ and ‘config-reloader’ containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.
Allowed values:
,Always,Never,IfNotPresent - array of objectsspec.imagePullSecrets
An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
- stringspec.imagePullSecrets.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- array of objectsspec.initContainers
InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Alertmanager configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator generated init containers if they share the same name and modifications are done via a strategic merge patch. The current init container name is:
init-config-reloader. Overriding init containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.A single application container that you want to run within a pod.
- array of stringsspec.initContainers.args
Arguments to the entrypoint. The container image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double \(are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "\)(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- array of stringsspec.initContainers.command
Entrypoint array. Not executed within a shell. The container image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double \(are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "\)(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- array of objectsspec.initContainers.env
List of environment variables to set in the container. Cannot be updated.
EnvVar represents an environment variable present in a Container.
- stringspec.initContainers.env.name
Required value
Name of the environment variable. Must be a C_IDENTIFIER.
- stringspec.initContainers.env.value
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double \(are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "\)(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.
- objectspec.initContainers.env.valueFrom
Source for the environment variable’s value. Cannot be used if value is not empty.
- objectspec.initContainers.env.valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
- stringspec.initContainers.env.valueFrom.configMapKeyRef.key
Required value
The key to select.
- stringspec.initContainers.env.valueFrom.configMapKeyRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.initContainers.env.valueFrom.configMapKeyRef.optional
Specify whether the ConfigMap or its key must be defined
- objectspec.initContainers.env.valueFrom.fieldRef
Selects a field of the pod: supports metadata.name, metadata.namespace,
metadata.labels['<KEY>'],metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.- stringspec.initContainers.env.valueFrom.fieldRef.apiVersion
Version of the schema the FieldPath is written in terms of, defaults to “v1”.
- stringspec.initContainers.env.valueFrom.fieldRef.fieldPath
Required value
Path of the field to select in the specified API version.
- objectspec.initContainers.env.valueFrom.resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- stringspec.initContainers.env.valueFrom.resourceFieldRef.containerName
Container name: required for volumes, optional for env vars
- integer or stringspec.initContainers.env.valueFrom.resourceFieldRef.divisor
Specifies the output format of the exposed resources, defaults to “1”
Pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - stringspec.initContainers.env.valueFrom.resourceFieldRef.resource
Required value
Required: resource to select
- objectspec.initContainers.env.valueFrom.secretKeyRef
Selects a key of a secret in the pod’s namespace
- stringspec.initContainers.env.valueFrom.secretKeyRef.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.initContainers.env.valueFrom.secretKeyRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.initContainers.env.valueFrom.secretKeyRef.optional
Specify whether the Secret or its key must be defined
- array of objectsspec.initContainers.envFrom
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
EnvFromSource represents the source of a set of ConfigMaps
- objectspec.initContainers.envFrom.configMapRef
The ConfigMap to select from
- stringspec.initContainers.envFrom.configMapRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.initContainers.envFrom.configMapRef.optional
Specify whether the ConfigMap must be defined
- stringspec.initContainers.envFrom.prefix
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- objectspec.initContainers.envFrom.secretRef
The Secret to select from
- stringspec.initContainers.envFrom.secretRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.initContainers.envFrom.secretRef.optional
Specify whether the Secret must be defined
- stringspec.initContainers.image
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
- stringspec.initContainers.imagePullPolicy
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
- objectspec.initContainers.lifecycle
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- objectspec.initContainers.lifecycle.postStart
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- objectspec.initContainers.lifecycle.postStart.exec
Exec specifies the action to take.
- array of stringsspec.initContainers.lifecycle.postStart.exec.command
Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘ ’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- objectspec.initContainers.lifecycle.postStart.httpGet
HTTPGet specifies the http request to perform.
- stringspec.initContainers.lifecycle.postStart.httpGet.host
Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
- array of objectsspec.initContainers.lifecycle.postStart.httpGet.httpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
HTTPHeader describes a custom header to be used in HTTP probes
- stringspec.initContainers.lifecycle.postStart.httpGet.httpHeaders.name
Required value
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- stringspec.initContainers.lifecycle.postStart.httpGet.httpHeaders.value
Required value
The header field value
- stringspec.initContainers.lifecycle.postStart.httpGet.path
Path to access on the HTTP server.
- integer or stringspec.initContainers.lifecycle.postStart.httpGet.port
Required value
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- stringspec.initContainers.lifecycle.postStart.httpGet.scheme
Scheme to use for connecting to the host. Defaults to HTTP.
- objectspec.initContainers.lifecycle.postStart.tcpSocket
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
- stringspec.initContainers.lifecycle.postStart.tcpSocket.host
Optional: Host name to connect to, defaults to the pod IP.
- integer or stringspec.initContainers.lifecycle.postStart.tcpSocket.port
Required value
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- objectspec.initContainers.lifecycle.preStop
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod’s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- objectspec.initContainers.lifecycle.preStop.exec
Exec specifies the action to take.
- array of stringsspec.initContainers.lifecycle.preStop.exec.command
Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘ ’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- objectspec.initContainers.lifecycle.preStop.httpGet
HTTPGet specifies the http request to perform.
- stringspec.initContainers.lifecycle.preStop.httpGet.host
Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
- array of objectsspec.initContainers.lifecycle.preStop.httpGet.httpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
HTTPHeader describes a custom header to be used in HTTP probes
- stringspec.initContainers.lifecycle.preStop.httpGet.httpHeaders.name
Required value
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- stringspec.initContainers.lifecycle.preStop.httpGet.httpHeaders.value
Required value
The header field value
- stringspec.initContainers.lifecycle.preStop.httpGet.path
Path to access on the HTTP server.
- integer or stringspec.initContainers.lifecycle.preStop.httpGet.port
Required value
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- stringspec.initContainers.lifecycle.preStop.httpGet.scheme
Scheme to use for connecting to the host. Defaults to HTTP.
- objectspec.initContainers.lifecycle.preStop.tcpSocket
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
- stringspec.initContainers.lifecycle.preStop.tcpSocket.host
Optional: Host name to connect to, defaults to the pod IP.
- integer or stringspec.initContainers.lifecycle.preStop.tcpSocket.port
Required value
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- objectspec.initContainers.livenessProbe
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- objectspec.initContainers.livenessProbe.exec
Exec specifies the action to take.
- array of stringsspec.initContainers.livenessProbe.exec.command
Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘ ’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- integerspec.initContainers.livenessProbe.failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- objectspec.initContainers.livenessProbe.grpc
GRPC specifies an action involving a GRPC port.
- integerspec.initContainers.livenessProbe.grpc.port
Required value
Port number of the gRPC service. Number must be in the range 1 to 65535.
- stringspec.initContainers.livenessProbe.grpc.service
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- objectspec.initContainers.livenessProbe.httpGet
HTTPGet specifies the http request to perform.
- stringspec.initContainers.livenessProbe.httpGet.host
Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
- array of objectsspec.initContainers.livenessProbe.httpGet.httpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
HTTPHeader describes a custom header to be used in HTTP probes
- stringspec.initContainers.livenessProbe.httpGet.httpHeaders.name
Required value
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- stringspec.initContainers.livenessProbe.httpGet.httpHeaders.value
Required value
The header field value
- stringspec.initContainers.livenessProbe.httpGet.path
Path to access on the HTTP server.
- integer or stringspec.initContainers.livenessProbe.httpGet.port
Required value
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- stringspec.initContainers.livenessProbe.httpGet.scheme
Scheme to use for connecting to the host. Defaults to HTTP.
- integerspec.initContainers.livenessProbe.initialDelaySeconds
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- integerspec.initContainers.livenessProbe.periodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- integerspec.initContainers.livenessProbe.successThreshold
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
- objectspec.initContainers.livenessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port.
- stringspec.initContainers.livenessProbe.tcpSocket.host
Optional: Host name to connect to, defaults to the pod IP.
- integer or stringspec.initContainers.livenessProbe.tcpSocket.port
Required value
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- integerspec.initContainers.livenessProbe.terminationGracePeriodSeconds
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
- integerspec.initContainers.livenessProbe.timeoutSeconds
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- stringspec.initContainers.name
Required value
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
- array of objectsspec.initContainers.ports
List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
ContainerPort represents a network port in a single container.
- integerspec.initContainers.ports.containerPort
Required value
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
- stringspec.initContainers.ports.hostIP
What host IP to bind the external port to.
- integerspec.initContainers.ports.hostPort
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
- stringspec.initContainers.ports.name
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
- stringspec.initContainers.ports.protocol
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.
Default:
"TCP"
- objectspec.initContainers.readinessProbe
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- objectspec.initContainers.readinessProbe.exec
Exec specifies the action to take.
- array of stringsspec.initContainers.readinessProbe.exec.command
Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘ ’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- integerspec.initContainers.readinessProbe.failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- objectspec.initContainers.readinessProbe.grpc
GRPC specifies an action involving a GRPC port.
- integerspec.initContainers.readinessProbe.grpc.port
Required value
Port number of the gRPC service. Number must be in the range 1 to 65535.
- stringspec.initContainers.readinessProbe.grpc.service
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- objectspec.initContainers.readinessProbe.httpGet
HTTPGet specifies the http request to perform.
- stringspec.initContainers.readinessProbe.httpGet.host
Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
- array of objectsspec.initContainers.readinessProbe.httpGet.httpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
HTTPHeader describes a custom header to be used in HTTP probes
- stringspec.initContainers.readinessProbe.httpGet.httpHeaders.name
Required value
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- stringspec.initContainers.readinessProbe.httpGet.httpHeaders.value
Required value
The header field value
- stringspec.initContainers.readinessProbe.httpGet.path
Path to access on the HTTP server.
- integer or stringspec.initContainers.readinessProbe.httpGet.port
Required value
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- stringspec.initContainers.readinessProbe.httpGet.scheme
Scheme to use for connecting to the host. Defaults to HTTP.
- integerspec.initContainers.readinessProbe.initialDelaySeconds
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- integerspec.initContainers.readinessProbe.periodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- integerspec.initContainers.readinessProbe.successThreshold
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
- objectspec.initContainers.readinessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port.
- stringspec.initContainers.readinessProbe.tcpSocket.host
Optional: Host name to connect to, defaults to the pod IP.
- integer or stringspec.initContainers.readinessProbe.tcpSocket.port
Required value
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- integerspec.initContainers.readinessProbe.terminationGracePeriodSeconds
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
- integerspec.initContainers.readinessProbe.timeoutSeconds
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- array of objectsspec.initContainers.resizePolicy
Resources resize policy for the container.
ContainerResizePolicy represents resource resize policy for the container.
- stringspec.initContainers.resizePolicy.resourceName
Required value
Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
- stringspec.initContainers.resizePolicy.restartPolicy
Required value
Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
- objectspec.initContainers.resources
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- array of objectsspec.initContainers.resources.claims
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
ResourceClaim references one entry in PodSpec.ResourceClaims.
- stringspec.initContainers.resources.claims.name
Required value
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- objectspec.initContainers.resources.limits
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- objectspec.initContainers.resources.requests
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- stringspec.initContainers.restartPolicy
RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is “Always”. For non-init containers or when this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Setting the RestartPolicy as “Always” for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy “Always” will be shut down. This lifecycle differs from normal init containers and is often referred to as a “sidecar” container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
- objectspec.initContainers.securityContext
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- booleanspec.initContainers.securityContext.allowPrivilegeEscalation
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
- objectspec.initContainers.securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
- array of stringsspec.initContainers.securityContext.capabilities.add
Added capabilities
- stringElement of the array
Capability represent POSIX capabilities type
- array of stringsspec.initContainers.securityContext.capabilities.drop
Removed capabilities
- stringElement of the array
Capability represent POSIX capabilities type
- booleanspec.initContainers.securityContext.privileged
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
- stringspec.initContainers.securityContext.procMount
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
- booleanspec.initContainers.securityContext.readOnlyRootFilesystem
Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
- integerspec.initContainers.securityContext.runAsGroup
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
- booleanspec.initContainers.securityContext.runAsNonRoot
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- integerspec.initContainers.securityContext.runAsUser
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
- objectspec.initContainers.securityContext.seLinuxOptions
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
- stringspec.initContainers.securityContext.seLinuxOptions.level
Level is SELinux level label that applies to the container.
- stringspec.initContainers.securityContext.seLinuxOptions.role
Role is a SELinux role label that applies to the container.
- stringspec.initContainers.securityContext.seLinuxOptions.type
Type is a SELinux type label that applies to the container.
- stringspec.initContainers.securityContext.seLinuxOptions.user
User is a SELinux user label that applies to the container.
- objectspec.initContainers.securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
- stringspec.initContainers.securityContext.seccompProfile.localhostProfile
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.
- stringspec.initContainers.securityContext.seccompProfile.type
Required value
type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
- objectspec.initContainers.securityContext.windowsOptions
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
- stringspec.initContainers.securityContext.windowsOptions.gmsaCredentialSpec
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
- stringspec.initContainers.securityContext.windowsOptions.gmsaCredentialSpecName
GMSACredentialSpecName is the name of the GMSA credential spec to use.
- booleanspec.initContainers.securityContext.windowsOptions.hostProcess
HostProcess determines if a container should be run as a ‘Host Process’ container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
- stringspec.initContainers.securityContext.windowsOptions.runAsUserName
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- objectspec.initContainers.startupProbe
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- objectspec.initContainers.startupProbe.exec
Exec specifies the action to take.
- array of stringsspec.initContainers.startupProbe.exec.command
Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘ ’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- integerspec.initContainers.startupProbe.failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- objectspec.initContainers.startupProbe.grpc
GRPC specifies an action involving a GRPC port.
- integerspec.initContainers.startupProbe.grpc.port
Required value
Port number of the gRPC service. Number must be in the range 1 to 65535.
- stringspec.initContainers.startupProbe.grpc.service
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- objectspec.initContainers.startupProbe.httpGet
HTTPGet specifies the http request to perform.
- stringspec.initContainers.startupProbe.httpGet.host
Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.
- array of objectsspec.initContainers.startupProbe.httpGet.httpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
HTTPHeader describes a custom header to be used in HTTP probes
- stringspec.initContainers.startupProbe.httpGet.httpHeaders.name
Required value
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- stringspec.initContainers.startupProbe.httpGet.httpHeaders.value
Required value
The header field value
- stringspec.initContainers.startupProbe.httpGet.path
Path to access on the HTTP server.
- integer or stringspec.initContainers.startupProbe.httpGet.port
Required value
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- stringspec.initContainers.startupProbe.httpGet.scheme
Scheme to use for connecting to the host. Defaults to HTTP.
- integerspec.initContainers.startupProbe.initialDelaySeconds
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- integerspec.initContainers.startupProbe.periodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- integerspec.initContainers.startupProbe.successThreshold
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
- objectspec.initContainers.startupProbe.tcpSocket
TCPSocket specifies an action involving a TCP port.
- stringspec.initContainers.startupProbe.tcpSocket.host
Optional: Host name to connect to, defaults to the pod IP.
- integer or stringspec.initContainers.startupProbe.tcpSocket.port
Required value
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
- integerspec.initContainers.startupProbe.terminationGracePeriodSeconds
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
- integerspec.initContainers.startupProbe.timeoutSeconds
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- booleanspec.initContainers.stdin
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
- booleanspec.initContainers.stdinOnce
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
- stringspec.initContainers.terminationMessagePath
Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
- stringspec.initContainers.terminationMessagePolicy
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- booleanspec.initContainers.tty
Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.
- array of objectsspec.initContainers.volumeDevices
volumeDevices is the list of block devices to be used by the container.
volumeDevice describes a mapping of a raw block device within a container.
- stringspec.initContainers.volumeDevices.devicePath
Required value
devicePath is the path inside of the container that the device will be mapped to.
- stringspec.initContainers.volumeDevices.name
Required value
name must match the name of a persistentVolumeClaim in the pod
- array of objectsspec.initContainers.volumeMounts
Pod volumes to mount into the container’s filesystem. Cannot be updated.
VolumeMount describes a mounting of a Volume within a container.
- stringspec.initContainers.volumeMounts.mountPath
Required value
Path within the container at which the volume should be mounted. Must not contain ‘:’.
- stringspec.initContainers.volumeMounts.mountPropagation
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
- stringspec.initContainers.volumeMounts.name
Required value
This must match the Name of a Volume.
- booleanspec.initContainers.volumeMounts.readOnly
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- stringspec.initContainers.volumeMounts.subPath
Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).
- stringspec.initContainers.volumeMounts.subPathExpr
Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive.
- stringspec.initContainers.workingDir
Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.
- booleanspec.listenLocal
ListenLocal makes the Alertmanager server listen on loopback, so that it does not bind against the Pod IP. Note this is only for the Alertmanager UI, not the gossip communication.
- stringspec.logFormat
Log format for Alertmanager to be configured with.
Allowed values:
,logfmt,json - stringspec.logLevel
Log level for Alertmanager to be configured with.
Allowed values:
,debug,info,warn,error - integerspec.minReadySeconds
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate.
- objectspec.nodeSelector
Define which Nodes the Pods are scheduled on.
- booleanspec.paused
If set to true all actions on the underlying managed objects are not goint to be performed, except for delete actions.
- objectspec.podMetadata
PodMetadata configures Labels and Annotations which are propagated to the alertmanager pods.
- objectspec.podMetadata.annotations
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
- objectspec.podMetadata.labels
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
- stringspec.podMetadata.name
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- stringspec.portName
Port name used for the pods and governing service. Defaults to
web.Default:
"web" - stringspec.priorityClassName
Priority class assigned to the Pods
- integerspec.replicas
Size is the expected size of the alertmanager cluster. The controller will eventually make the size of the running cluster equal to the expected size.
- objectspec.resources
Define resources requests and limits for single Pods.
- array of objectsspec.resources.claims
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
ResourceClaim references one entry in PodSpec.ResourceClaims.
- stringspec.resources.claims.name
Required value
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- objectspec.resources.limits
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- objectspec.resources.requests
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- stringspec.retention
Time duration Alertmanager shall retain data for. Default is ‘120h’, and must match the regular expression
[0-9]+(ms|s|m|h)(milliseconds seconds minutes hours).Default:
"120h"Pattern:
^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ - stringspec.routePrefix
The route prefix Alertmanager registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with
kubectl proxy. - array of stringsspec.secrets
Secrets is a list of Secrets in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. Each Secret is added to the StatefulSet definition as a volume named
secret-<secret-name>. The Secrets are mounted into/etc/alertmanager/secrets/<secret-name>in the ‘alertmanager’ container. - objectspec.securityContext
SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
- integerspec.securityContext.fsGroup
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
- The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw—- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.
- stringspec.securityContext.fsGroupChangePolicy
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified, “Always” is used. Note that this field cannot be set when spec.os.name is windows.
- integerspec.securityContext.runAsGroup
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- booleanspec.securityContext.runAsNonRoot
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- integerspec.securityContext.runAsUser
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- objectspec.securityContext.seLinuxOptions
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- stringspec.securityContext.seLinuxOptions.level
Level is SELinux level label that applies to the container.
- stringspec.securityContext.seLinuxOptions.role
Role is a SELinux role label that applies to the container.
- stringspec.securityContext.seLinuxOptions.type
Type is a SELinux type label that applies to the container.
- stringspec.securityContext.seLinuxOptions.user
User is a SELinux user label that applies to the container.
- objectspec.securityContext.seccompProfile
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
- stringspec.securityContext.seccompProfile.localhostProfile
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.
- stringspec.securityContext.seccompProfile.type
Required value
type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
- array of integersspec.securityContext.supplementalGroups
A list of groups applied to the first process run in each container, in addition to the container’s primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.
- array of objectsspec.securityContext.sysctls
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
Sysctl defines a kernel parameter to be set
- stringspec.securityContext.sysctls.name
Required value
Name of a property to set
- stringspec.securityContext.sysctls.value
Required value
Value of a property to set
- objectspec.securityContext.windowsOptions
The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
- stringspec.securityContext.windowsOptions.gmsaCredentialSpec
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
- stringspec.securityContext.windowsOptions.gmsaCredentialSpecName
GMSACredentialSpecName is the name of the GMSA credential spec to use.
- booleanspec.securityContext.windowsOptions.hostProcess
HostProcess determines if a container should be run as a ‘Host Process’ container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
- stringspec.securityContext.windowsOptions.runAsUserName
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- stringspec.serviceAccountName
ServiceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.
- stringspec.sha
SHA of Alertmanager container image to be deployed. Defaults to the value of
version. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use ‘image’ instead. The image digest can be specified as part of the image URL. - objectspec.storage
Storage is the definition of how storage will be used by the Alertmanager instances.
- booleanspec.storage.disableMountSubPath
Deprecated: subPath usage will be removed in a future release.
- objectspec.storage.emptyDir
EmptyDirVolumeSource to be used by the StatefulSet. If specified, it takes precedence over
ephemeralandvolumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir- stringspec.storage.emptyDir.medium
medium represents what type of storage medium should back this directory. The default is “” which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- integer or stringspec.storage.emptyDir.sizeLimit
sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
Pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
- objectspec.storage.ephemeral
EphemeralVolumeSource to be used by the StatefulSet. This is a beta field in k8s 1.21 and GA in 1.15. For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes
- objectspec.storage.ephemeral.volumeClaimTemplate
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be
<pod name>-<volume name>where<volume name>is the name from thePodSpec.Volumesarray entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.- objectspec.storage.ephemeral.volumeClaimTemplate.metadata
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
- objectspec.storage.ephemeral.volumeClaimTemplate.spec
Required value
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.
- array of stringsspec.storage.ephemeral.volumeClaimTemplate.spec.accessModes
accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
- objectspec.storage.ephemeral.volumeClaimTemplate.spec.dataSource
dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.apiGroup
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.kind
Required value
Kind is the type of resource being referenced
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.name
Required value
Name is the name of resource being referenced
- objectspec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn’t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.apiGroup
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.kind
Required value
Kind is the type of resource being referenced
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.name
Required value
Name is the name of resource being referenced
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.namespace
Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace’s owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- objectspec.storage.ephemeral.volumeClaimTemplate.spec.resources
resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
- array of objectsspec.storage.ephemeral.volumeClaimTemplate.spec.resources.claims
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
ResourceClaim references one entry in PodSpec.ResourceClaims.
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.resources.claims.name
Required value
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- objectspec.storage.ephemeral.volumeClaimTemplate.spec.resources.limits
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- objectspec.storage.ephemeral.volumeClaimTemplate.spec.resources.requests
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- objectspec.storage.ephemeral.volumeClaimTemplate.spec.selector
selector is a label query over volumes to consider for binding.
- array of objectsspec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.storageClassName
storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.volumeMode
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
- stringspec.storage.ephemeral.volumeClaimTemplate.spec.volumeName
volumeName is the binding reference to the PersistentVolume backing this claim.
- objectspec.storage.volumeClaimTemplate
Defines the PVC spec to be used by the Prometheus StatefulSets. The easiest way to use a volume that cannot be automatically provisioned is to use a label selector alongside manually created PersistentVolumes.
- stringspec.storage.volumeClaimTemplate.apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- stringspec.storage.volumeClaimTemplate.kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- objectspec.storage.volumeClaimTemplate.metadata
EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
- objectspec.storage.volumeClaimTemplate.metadata.annotations
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
- objectspec.storage.volumeClaimTemplate.metadata.labels
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
- stringspec.storage.volumeClaimTemplate.metadata.name
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- objectspec.storage.volumeClaimTemplate.spec
Defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- array of stringsspec.storage.volumeClaimTemplate.spec.accessModes
accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
- objectspec.storage.volumeClaimTemplate.spec.dataSource
dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- stringspec.storage.volumeClaimTemplate.spec.dataSource.apiGroup
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
- stringspec.storage.volumeClaimTemplate.spec.dataSource.kind
Required value
Kind is the type of resource being referenced
- stringspec.storage.volumeClaimTemplate.spec.dataSource.name
Required value
Name is the name of resource being referenced
- objectspec.storage.volumeClaimTemplate.spec.dataSourceRef
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn’t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- stringspec.storage.volumeClaimTemplate.spec.dataSourceRef.apiGroup
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
- stringspec.storage.volumeClaimTemplate.spec.dataSourceRef.kind
Required value
Kind is the type of resource being referenced
- stringspec.storage.volumeClaimTemplate.spec.dataSourceRef.name
Required value
Name is the name of resource being referenced
- stringspec.storage.volumeClaimTemplate.spec.dataSourceRef.namespace
Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace’s owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- objectspec.storage.volumeClaimTemplate.spec.resources
resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
- array of objectsspec.storage.volumeClaimTemplate.spec.resources.claims
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
ResourceClaim references one entry in PodSpec.ResourceClaims.
- stringspec.storage.volumeClaimTemplate.spec.resources.claims.name
Required value
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- objectspec.storage.volumeClaimTemplate.spec.resources.limits
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- objectspec.storage.volumeClaimTemplate.spec.resources.requests
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- objectspec.storage.volumeClaimTemplate.spec.selector
selector is a label query over volumes to consider for binding.
- array of objectsspec.storage.volumeClaimTemplate.spec.selector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.storage.volumeClaimTemplate.spec.selector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.storage.volumeClaimTemplate.spec.selector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.storage.volumeClaimTemplate.spec.selector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.storage.volumeClaimTemplate.spec.selector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- stringspec.storage.volumeClaimTemplate.spec.storageClassName
storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- stringspec.storage.volumeClaimTemplate.spec.volumeMode
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
- stringspec.storage.volumeClaimTemplate.spec.volumeName
volumeName is the binding reference to the PersistentVolume backing this claim.
- objectspec.storage.volumeClaimTemplate.status
Deprecated: this field is never set.
- array of stringsspec.storage.volumeClaimTemplate.status.accessModes
accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
- objectspec.storage.volumeClaimTemplate.status.allocatedResourceStatuses
allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as “example.com/my-custom-resource” Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don’t set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus[‘storage’] = “ControllerResizeInProgress” - pvc.status.allocatedResourceStatus[‘storage’] = “ControllerResizeFailed” - pvc.status.allocatedResourceStatus[‘storage’] = “NodeResizePending” - pvc.status.allocatedResourceStatus[‘storage’] = “NodeResizeInProgress” - pvc.status.allocatedResourceStatus[‘storage’] = “NodeResizeFailed” When this field is not set, it means that no resize operation is in progress for the given PVC. A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
- objectspec.storage.volumeClaimTemplate.status.allocatedResources
allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as “example.com/my-custom-resource” Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
- objectspec.storage.volumeClaimTemplate.status.capacity
capacity represents the actual resources of the underlying volume.
- array of objectsspec.storage.volumeClaimTemplate.status.conditions
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to ‘ResizeStarted’.
PersistentVolumeClaimCondition contains details about state of pvc
- stringspec.storage.volumeClaimTemplate.status.conditions.lastProbeTime
lastProbeTime is the time we probed the condition.
- stringspec.storage.volumeClaimTemplate.status.conditions.lastTransitionTime
lastTransitionTime is the time the condition transitioned from one status to another.
- stringspec.storage.volumeClaimTemplate.status.conditions.message
message is the human-readable message indicating details about last transition.
- stringspec.storage.volumeClaimTemplate.status.conditions.reason
reason is a unique, this should be a short, machine understandable string that gives the reason for condition’s last transition. If it reports “ResizeStarted” that means the underlying persistent volume is being resized.
- stringspec.storage.volumeClaimTemplate.status.conditions.status
Required value
- stringspec.storage.volumeClaimTemplate.status.conditions.type
Required value
PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
- stringspec.storage.volumeClaimTemplate.status.phase
phase represents the current phase of PersistentVolumeClaim.
- stringspec.tag
Tag of Alertmanager container image to be deployed. Defaults to the value of
version. Version is ignored if Tag is set. Deprecated: use ‘image’ instead. The image tag can be specified as part of the image URL. - array of objectsspec.tolerations
If specified, the pod’s tolerations.
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator
. - stringspec.tolerations.effect
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- stringspec.tolerations.key
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
- stringspec.tolerations.operator
Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
- integerspec.tolerations.tolerationSeconds
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
- stringspec.tolerations.value
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
- array of objectsspec.topologySpreadConstraints
If specified, the pod’s topology spread constraints.
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
- objectspec.topologySpreadConstraints.labelSelector
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
- array of objectsspec.topologySpreadConstraints.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.topologySpreadConstraints.labelSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.topologySpreadConstraints.labelSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.topologySpreadConstraints.labelSelector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.topologySpreadConstraints.labelSelector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- array of stringsspec.topologySpreadConstraints.matchLabelKeys
MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn’t set. Keys that don’t exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
- integerspec.topologySpreadConstraints.maxSkew
Required value
MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1.zone1 zone2 zone3 P P P P P - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It’s a required field. Default value is 1 and 0 is not allowed. - integerspec.topologySpreadConstraints.minDomains
MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats “global minimum” as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won’t schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so “global minimum” is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).
- stringspec.topologySpreadConstraints.nodeAffinityPolicy
NodeAffinityPolicy indicates how we will treat Pod’s nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- stringspec.topologySpreadConstraints.nodeTaintsPolicy
NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- stringspec.topologySpreadConstraints.topologyKey
Required value
TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a “bucket”, and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is “kubernetes.io/hostname”, each Node is a domain of that topology. And, if TopologyKey is “topology.kubernetes.io/zone”, each zone is a domain of that topology. It’s a required field.
- stringspec.topologySpreadConstraints.whenUnsatisfiable
Required value
WhenUnsatisfiable indicates how to deal with a pod if it doesn’t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered “Unsatisfiable” for an incoming pod if and only if every possible node assignment for that pod would violate “MaxSkew” on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: zone1 zone2 zone3 P P P P P If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won’t make it more imbalanced. It’s a required field.
- stringspec.version
Version the cluster should be on.
- array of objectsspec.volumeMounts
VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the alertmanager container, that are generated as a result of StorageSpec objects.
VolumeMount describes a mounting of a Volume within a container.
- stringspec.volumeMounts.mountPath
Required value
Path within the container at which the volume should be mounted. Must not contain ‘:’.
- stringspec.volumeMounts.mountPropagation
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
- stringspec.volumeMounts.name
Required value
This must match the Name of a Volume.
- booleanspec.volumeMounts.readOnly
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- stringspec.volumeMounts.subPath
Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).
- stringspec.volumeMounts.subPathExpr
Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive.
- array of objectsspec.volumes
Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.
Volume represents a named volume in a pod that may be accessed by any container in the pod.
- objectspec.volumes.awsElasticBlockStore
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- stringspec.volumes.awsElasticBlockStore.fsType
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine
- integerspec.volumes.awsElasticBlockStore.partition
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as “1”. Similarly, the volume partition for /dev/sda is “0” (or you can leave the property empty).
- booleanspec.volumes.awsElasticBlockStore.readOnly
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- stringspec.volumes.awsElasticBlockStore.volumeID
Required value
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- objectspec.volumes.azureDisk
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- stringspec.volumes.azureDisk.cachingMode
cachingMode is the Host Caching mode: None, Read Only, Read Write.
- stringspec.volumes.azureDisk.diskName
Required value
diskName is the Name of the data disk in the blob storage
- stringspec.volumes.azureDisk.diskURI
Required value
diskURI is the URI of data disk in the blob storage
- stringspec.volumes.azureDisk.fsType
fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified.
- stringspec.volumes.azureDisk.kind
kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
- booleanspec.volumes.azureDisk.readOnly
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- objectspec.volumes.azureFile
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
- booleanspec.volumes.azureFile.readOnly
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- stringspec.volumes.azureFile.secretName
Required value
secretName is the name of secret that contains Azure Storage Account Name and Key
- string
Required value
shareName is the azure share Name
- objectspec.volumes.cephfs
cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime
- array of stringsspec.volumes.cephfs.monitors
Required value
monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- stringspec.volumes.cephfs.path
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- booleanspec.volumes.cephfs.readOnly
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- stringspec.volumes.cephfs.secretFile
secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- objectspec.volumes.cephfs.secretRef
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- stringspec.volumes.cephfs.secretRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- stringspec.volumes.cephfs.user
user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- objectspec.volumes.cinder
cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- stringspec.volumes.cinder.fsType
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- booleanspec.volumes.cinder.readOnly
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- objectspec.volumes.cinder.secretRef
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
- stringspec.volumes.cinder.secretRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- stringspec.volumes.cinder.volumeID
Required value
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- objectspec.volumes.configMap
configMap represents a configMap that should populate this volume
- integerspec.volumes.configMap.defaultMode
defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- array of objectsspec.volumes.configMap.items
items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.
Maps a string key to a path within a volume.
- stringspec.volumes.configMap.items.key
Required value
key is the key to project.
- integerspec.volumes.configMap.items.mode
mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- stringspec.volumes.configMap.items.path
Required value
path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element ‘..’. May not start with the string ‘..’.
- stringspec.volumes.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.volumes.configMap.optional
optional specify whether the ConfigMap or its keys must be defined
- objectspec.volumes.csi
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
- stringspec.volumes.csi.driver
Required value
driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
- stringspec.volumes.csi.fsType
fsType to mount. Ex. “ext4”, “xfs”, “ntfs”. If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
- objectspec.volumes.csi.nodePublishSecretRef
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
- stringspec.volumes.csi.nodePublishSecretRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.volumes.csi.readOnly
readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
- objectspec.volumes.csi.volumeAttributes
volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.
- objectspec.volumes.downwardAPI
downwardAPI represents downward API about the pod that should populate this volume
- integerspec.volumes.downwardAPI.defaultMode
Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- array of objectsspec.volumes.downwardAPI.items
Items is a list of downward API volume file
DownwardAPIVolumeFile represents information to create the file containing the pod field
- objectspec.volumes.downwardAPI.items.fieldRef
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
- stringspec.volumes.downwardAPI.items.fieldRef.apiVersion
Version of the schema the FieldPath is written in terms of, defaults to “v1”.
- stringspec.volumes.downwardAPI.items.fieldRef.fieldPath
Required value
Path of the field to select in the specified API version.
- integerspec.volumes.downwardAPI.items.mode
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- stringspec.volumes.downwardAPI.items.path
Required value
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ‘..’ path. Must be utf-8 encoded. The first item of the relative path must not start with ‘..’
- objectspec.volumes.downwardAPI.items.resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- stringspec.volumes.downwardAPI.items.resourceFieldRef.containerName
Container name: required for volumes, optional for env vars
- integer or stringspec.volumes.downwardAPI.items.resourceFieldRef.divisor
Specifies the output format of the exposed resources, defaults to “1”
Pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - stringspec.volumes.downwardAPI.items.resourceFieldRef.resource
Required value
Required: resource to select
- objectspec.volumes.emptyDir
emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- stringspec.volumes.emptyDir.medium
medium represents what type of storage medium should back this directory. The default is “” which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- integer or stringspec.volumes.emptyDir.sizeLimit
sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
Pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
- objectspec.volumes.ephemeral
ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.
- objectspec.volumes.ephemeral.volumeClaimTemplate
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be
<pod name>-<volume name>where<volume name>is the name from thePodSpec.Volumesarray entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.- objectspec.volumes.ephemeral.volumeClaimTemplate.metadata
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
- objectspec.volumes.ephemeral.volumeClaimTemplate.spec
Required value
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.
- array of stringsspec.volumes.ephemeral.volumeClaimTemplate.spec.accessModes
accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
- objectspec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource
dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.apiGroup
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.kind
Required value
Kind is the type of resource being referenced
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.name
Required value
Name is the name of resource being referenced
- objectspec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn’t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.apiGroup
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.kind
Required value
Kind is the type of resource being referenced
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.name
Required value
Name is the name of resource being referenced
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.namespace
Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace’s owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- objectspec.volumes.ephemeral.volumeClaimTemplate.spec.resources
resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
- array of objectsspec.volumes.ephemeral.volumeClaimTemplate.spec.resources.claims
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
ResourceClaim references one entry in PodSpec.ResourceClaims.
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.resources.claims.name
Required value
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- objectspec.volumes.ephemeral.volumeClaimTemplate.spec.resources.limits
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- objectspec.volumes.ephemeral.volumeClaimTemplate.spec.resources.requests
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- objectspec.volumes.ephemeral.volumeClaimTemplate.spec.selector
selector is a label query over volumes to consider for binding.
- array of objectsspec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array of stringsspec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.values
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- objectspec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.storageClassName
storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.volumeMode
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
- stringspec.volumes.ephemeral.volumeClaimTemplate.spec.volumeName
volumeName is the binding reference to the PersistentVolume backing this claim.
- objectspec.volumes.fc
fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
- stringspec.volumes.fc.fsType
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine
- integerspec.volumes.fc.lun
lun is Optional: FC target lun number
- booleanspec.volumes.fc.readOnly
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- array of stringsspec.volumes.fc.targetWWNs
targetWWNs is Optional: FC target worldwide names (WWNs)
- array of stringsspec.volumes.fc.wwids
wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- objectspec.volumes.flexVolume
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
- stringspec.volumes.flexVolume.driver
Required value
driver is the name of the driver to use for this volume.
- stringspec.volumes.flexVolume.fsType
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. The default filesystem depends on FlexVolume script.
- objectspec.volumes.flexVolume.options
options is Optional: this field holds extra command options if any.
- booleanspec.volumes.flexVolume.readOnly
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- objectspec.volumes.flexVolume.secretRef
secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
- stringspec.volumes.flexVolume.secretRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- objectspec.volumes.flocker
flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running
- stringspec.volumes.flocker.datasetName
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
- stringspec.volumes.flocker.datasetUUID
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
- objectspec.volumes.gcePersistentDisk
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- stringspec.volumes.gcePersistentDisk.fsType
fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine
- integerspec.volumes.gcePersistentDisk.partition
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as “1”. Similarly, the volume partition for /dev/sda is “0” (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- stringspec.volumes.gcePersistentDisk.pdName
Required value
pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- booleanspec.volumes.gcePersistentDisk.readOnly
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- objectspec.volumes.gitRepo
gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.
- stringspec.volumes.gitRepo.directory
directory is the target directory name. Must not contain or start with ‘..’. If ‘.’ is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
- stringspec.volumes.gitRepo.repository
Required value
repository is the URL
- stringspec.volumes.gitRepo.revision
revision is the commit hash for the specified revision.
- objectspec.volumes.glusterfs
glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
- stringspec.volumes.glusterfs.endpoints
Required value
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- stringspec.volumes.glusterfs.path
Required value
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- booleanspec.volumes.glusterfs.readOnly
readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- objectspec.volumes.hostPath
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath — TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.
- stringspec.volumes.hostPath.path
Required value
path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- stringspec.volumes.hostPath.type
type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- objectspec.volumes.iscsi
iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
- booleanspec.volumes.iscsi.chapAuthDiscovery
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
- booleanspec.volumes.iscsi.chapAuthSession
chapAuthSession defines whether support iSCSI Session CHAP authentication
- stringspec.volumes.iscsi.fsType
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine
- stringspec.volumes.iscsi.initiatorName
initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
: will be created for the connection. - stringspec.volumes.iscsi.iqn
Required value
iqn is the target iSCSI Qualified Name.
- stringspec.volumes.iscsi.iscsiInterface
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp).
- integerspec.volumes.iscsi.lun
Required value
lun represents iSCSI Target Lun number.
- array of stringsspec.volumes.iscsi.portals
portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
- booleanspec.volumes.iscsi.readOnly
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
- objectspec.volumes.iscsi.secretRef
secretRef is the CHAP Secret for iSCSI target and initiator authentication
- stringspec.volumes.iscsi.secretRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- stringspec.volumes.iscsi.targetPortal
Required value
targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
- stringspec.volumes.name
Required value
name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- objectspec.volumes.nfs
nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- stringspec.volumes.nfs.path
Required value
path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- booleanspec.volumes.nfs.readOnly
readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- stringspec.volumes.nfs.server
Required value
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- objectspec.volumes.persistentVolumeClaim
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- stringspec.volumes.persistentVolumeClaim.claimName
Required value
claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- booleanspec.volumes.persistentVolumeClaim.readOnly
readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
- objectspec.volumes.photonPersistentDisk
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
- stringspec.volumes.photonPersistentDisk.fsType
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified.
- stringspec.volumes.photonPersistentDisk.pdID
Required value
pdID is the ID that identifies Photon Controller persistent disk
- objectspec.volumes.portworxVolume
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
- stringspec.volumes.portworxVolume.fsType
fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”. Implicitly inferred to be “ext4” if unspecified.
- booleanspec.volumes.portworxVolume.readOnly
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- stringspec.volumes.portworxVolume.volumeID
Required value
volumeID uniquely identifies a Portworx volume
- objectspec.volumes.projected
projected items for all in one resources secrets, configmaps, and downward API
- integerspec.volumes.projected.defaultMode
defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- array of objectsspec.volumes.projected.sources
sources is the list of volume projections
Projection that may be projected along with other supported volume types
- objectspec.volumes.projected.sources.configMap
configMap information about the configMap data to project
- array of objectsspec.volumes.projected.sources.configMap.items
items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.
Maps a string key to a path within a volume.
- stringspec.volumes.projected.sources.configMap.items.key
Required value
key is the key to project.
- integerspec.volumes.projected.sources.configMap.items.mode
mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- stringspec.volumes.projected.sources.configMap.items.path
Required value
path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element ‘..’. May not start with the string ‘..’.
- stringspec.volumes.projected.sources.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.volumes.projected.sources.configMap.optional
optional specify whether the ConfigMap or its keys must be defined
- objectspec.volumes.projected.sources.downwardAPI
downwardAPI information about the downwardAPI data to project
- array of objectsspec.volumes.projected.sources.downwardAPI.items
Items is a list of DownwardAPIVolume file
DownwardAPIVolumeFile represents information to create the file containing the pod field
- objectspec.volumes.projected.sources.downwardAPI.items.fieldRef
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
- stringspec.volumes.projected.sources.downwardAPI.items.fieldRef.apiVersion
Version of the schema the FieldPath is written in terms of, defaults to “v1”.
- stringspec.volumes.projected.sources.downwardAPI.items.fieldRef.fieldPath
Required value
Path of the field to select in the specified API version.
- integerspec.volumes.projected.sources.downwardAPI.items.mode
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- stringspec.volumes.projected.sources.downwardAPI.items.path
Required value
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ‘..’ path. Must be utf-8 encoded. The first item of the relative path must not start with ‘..’
- objectspec.volumes.projected.sources.downwardAPI.items.resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- stringspec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.containerName
Container name: required for volumes, optional for env vars
- integer or stringspec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.divisor
Specifies the output format of the exposed resources, defaults to “1”
Pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - stringspec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.resource
Required value
Required: resource to select
- objectspec.volumes.projected.sources.secret
secret information about the secret data to project
- array of objectsspec.volumes.projected.sources.secret.items
items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.
Maps a string key to a path within a volume.
- stringspec.volumes.projected.sources.secret.items.key
Required value
key is the key to project.
- integerspec.volumes.projected.sources.secret.items.mode
mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- stringspec.volumes.projected.sources.secret.items.path
Required value
path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element ‘..’. May not start with the string ‘..’.
- stringspec.volumes.projected.sources.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.volumes.projected.sources.secret.optional
optional field specify whether the Secret or its key must be defined
- objectspec.volumes.projected.sources.serviceAccountToken
serviceAccountToken is information about the serviceAccountToken data to project
- stringspec.volumes.projected.sources.serviceAccountToken.audience
audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
- integerspec.volumes.projected.sources.serviceAccountToken.expirationSeconds
expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
- stringspec.volumes.projected.sources.serviceAccountToken.path
Required value
path is the path relative to the mount point of the file to project the token into.
- objectspec.volumes.quobyte
quobyte represents a Quobyte mount on the host that shares a pod’s lifetime
- stringspec.volumes.quobyte.group
group to map volume access to Default is no group
- booleanspec.volumes.quobyte.readOnly
readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
- stringspec.volumes.quobyte.registry
Required value
registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
- stringspec.volumes.quobyte.tenant
tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
- stringspec.volumes.quobyte.user
user to map volume access to Defaults to serivceaccount user
- stringspec.volumes.quobyte.volume
Required value
volume is a string that references an already created Quobyte volume by name.
- objectspec.volumes.rbd
rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
- stringspec.volumes.rbd.fsType
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine
- stringspec.volumes.rbd.image
Required value
image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- stringspec.volumes.rbd.keyring
keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- array of stringsspec.volumes.rbd.monitors
Required value
monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- stringspec.volumes.rbd.pool
pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- booleanspec.volumes.rbd.readOnly
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- objectspec.volumes.rbd.secretRef
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- stringspec.volumes.rbd.secretRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- stringspec.volumes.rbd.user
user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- objectspec.volumes.scaleIO
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
- stringspec.volumes.scaleIO.fsType
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Default is “xfs”.
- stringspec.volumes.scaleIO.gateway
Required value
gateway is the host address of the ScaleIO API Gateway.
- stringspec.volumes.scaleIO.protectionDomain
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
- booleanspec.volumes.scaleIO.readOnly
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- objectspec.volumes.scaleIO.secretRef
Required value
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
- stringspec.volumes.scaleIO.secretRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.volumes.scaleIO.sslEnabled
sslEnabled Flag enable/disable SSL communication with Gateway, default false
- stringspec.volumes.scaleIO.storageMode
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
- stringspec.volumes.scaleIO.storagePool
storagePool is the ScaleIO Storage Pool associated with the protection domain.
- stringspec.volumes.scaleIO.system
Required value
system is the name of the storage system as configured in ScaleIO.
- stringspec.volumes.scaleIO.volumeName
volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
- objectspec.volumes.secret
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- integerspec.volumes.secret.defaultMode
defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- array of objectsspec.volumes.secret.items
items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.
Maps a string key to a path within a volume.
- stringspec.volumes.secret.items.key
Required value
key is the key to project.
- integerspec.volumes.secret.items.mode
mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- stringspec.volumes.secret.items.path
Required value
path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element ‘..’. May not start with the string ‘..’.
- booleanspec.volumes.secret.optional
optional field specify whether the Secret or its keys must be defined
- stringspec.volumes.secret.secretName
secretName is the name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- objectspec.volumes.storageos
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
- stringspec.volumes.storageos.fsType
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified.
- booleanspec.volumes.storageos.readOnly
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- objectspec.volumes.storageos.secretRef
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
- stringspec.volumes.storageos.secretRef.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- stringspec.volumes.storageos.volumeName
volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
- stringspec.volumes.storageos.volumeNamespace
volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to “default” if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
- objectspec.volumes.vsphereVolume
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
- stringspec.volumes.vsphereVolume.fsType
fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified.
- stringspec.volumes.vsphereVolume.storagePolicyID
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
- stringspec.volumes.vsphereVolume.storagePolicyName
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
- stringspec.volumes.vsphereVolume.volumePath
Required value
volumePath is the path that identifies vSphere volume vmdk
- objectspec.web
Defines the web command line flags when starting Alertmanager.
- integerspec.web.getConcurrency
Maximum number of GET requests processed concurrently. This corresponds to the Alertmanager’s
--web.get-concurrencyflag. - objectspec.web.httpConfig
Defines HTTP parameters for web server.
- objectspec.web.httpConfig.headers
List of headers that can be added to HTTP responses.
- stringspec.web.httpConfig.headers.contentSecurityPolicy
Set the Content-Security-Policy header to HTTP responses. Unset if blank.
- stringspec.web.httpConfig.headers.strictTransportSecurity
Set the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same domain and subdomains over HTTPS. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
- stringspec.web.httpConfig.headers.xContentTypeOptions
Set the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
Allowed values:
,NoSniff - stringspec.web.httpConfig.headers.xFrameOptions
Set the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options
Allowed values:
,Deny,SameOrigin - stringspec.web.httpConfig.headers.xXSSProtection
Set the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
- booleanspec.web.httpConfig.http2
Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered.
- integerspec.web.timeout
Timeout for HTTP requests. This corresponds to the Alertmanager’s
--web.timeoutflag. - objectspec.web.tlsConfig
Defines the TLS parameters for HTTPS.
- objectspec.web.tlsConfig.cert
Required value
Contains the TLS certificate for the server.
- objectspec.web.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- stringspec.web.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.web.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.web.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- objectspec.web.tlsConfig.cert.secret
Secret containing data to use for the targets.
- stringspec.web.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.web.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.web.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- array of stringsspec.web.tlsConfig.cipherSuites
List of supported cipher suites for TLS versions up to TLS 1.2. If empty, Go default cipher suites are used. Available cipher suites are documented in the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants
- stringspec.web.tlsConfig.clientAuthType
Server policy for client authentication. Maps to ClientAuth Policies. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType
- objectspec.web.tlsConfig.client_ca
Contains the CA certificate for client certificate authentication to the server.
- objectspec.web.tlsConfig.client_ca.configMap
ConfigMap containing data to use for the targets.
- stringspec.web.tlsConfig.client_ca.configMap.key
Required value
The key to select.
- stringspec.web.tlsConfig.client_ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.web.tlsConfig.client_ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- objectspec.web.tlsConfig.client_ca.secret
Secret containing data to use for the targets.
- stringspec.web.tlsConfig.client_ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.web.tlsConfig.client_ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.web.tlsConfig.client_ca.secret.optional
Specify whether the Secret or its key must be defined
- array of stringsspec.web.tlsConfig.curvePreferences
Elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the go documentation: https://golang.org/pkg/crypto/tls/#CurveID
- objectspec.web.tlsConfig.keySecret
Required value
Secret containing the TLS key for the server.
- stringspec.web.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- stringspec.web.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- booleanspec.web.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- stringspec.web.tlsConfig.maxVersion
Maximum TLS version that is acceptable. Defaults to TLS13.
- stringspec.web.tlsConfig.minVersion
Minimum TLS version that is acceptable. Defaults to TLS12.
- booleanspec.web.tlsConfig.preferServerCipherSuites
Controls whether the server selects the client’s most preferred cipher suite, or the server’s most preferred cipher suite. If true then the server’s preference, as expressed in the order of elements in cipherSuites, is used.