Alertmanager

string

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

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

.metadata
object required

.spec

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

.spec .additionalArgs

AdditionalArgs allows setting additional arguments for the ‘Alertmanager’ container. It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the Alertmanager container which may cause issues if they are invalid or not supported by the given Alertmanager version.
string required

.spec .additionalArgs[] .name

Name of the argument, e.g. “scrape.discovery-reload-interval”.
string

.spec .additionalArgs[] .value

Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. –storage.tsdb.no-lockfile)
array

.spec .additionalPeers

AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster.
object

.spec .affinity

If specified, the pod’s scheduling constraints.
object

.spec .affinity .nodeAffinity

Describes node affinity scheduling rules for the pod.
array

.spec .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.
object required

.spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference

A node selector term, associated with the corresponding weight.
array

.spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions

A list of node selector requirements by node’s labels.
string required

.spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .key

The label key that the selector applies to.
string required

.spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .operator

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

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

.spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields

A list of node selector requirements by node’s fields.
string required

.spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .key

The label key that the selector applies to.
string required

.spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .operator

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

.spec .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.
integer required

.spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight

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

.spec .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 required

.spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms

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

.spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions

A list of node selector requirements by node’s labels.
string required

.spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .key

The label key that the selector applies to.
string required

.spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .operator

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

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

.spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields

A list of node selector requirements by node’s fields.
string required

.spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .key

The label key that the selector applies to.
string required

.spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .operator

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

.spec .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.
object

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

.spec .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.
object required

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm

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

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
array

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions

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

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .operator

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

.spec .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.
object

.spec .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.
array

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .matchLabelKeys

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
array

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .mismatchLabelKeys

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
object

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

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions

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

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .operator

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

.spec .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.
object

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

.spec .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”.
string required

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .topologyKey

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
integer required

.spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight

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

.spec .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.
object

.spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
array

.spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions

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

.spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .operator

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

.spec .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.
object

.spec .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.
array

.spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .matchLabelKeys

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
array

.spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .mismatchLabelKeys

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
object

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

.spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions

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

.spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .operator

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

.spec .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.
object

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

.spec .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”.
string required

.spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .topologyKey

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
object

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

.spec .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.
object required

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm

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

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
array

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions

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

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .operator

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

.spec .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.
object

.spec .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.
array

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .matchLabelKeys

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
array

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .mismatchLabelKeys

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
object

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

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions

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

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .operator

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

.spec .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.
object

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

.spec .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”.
string required

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .topologyKey

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
integer required

.spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight

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

.spec .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.
object

.spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
array

.spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions

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

.spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .operator

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

.spec .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.
object

.spec .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.
array

.spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .matchLabelKeys

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
array

.spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .mismatchLabelKeys

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
object

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

.spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions

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

.spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .operator

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

.spec .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.
object

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

.spec .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”.
string required

.spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .topologyKey

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
object

.spec .alertmanagerConfigMatcherStrategy

AlertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects process incoming alerts.
string

.spec .alertmanagerConfigMatcherStrategy .type

AlertmanagerConfigMatcherStrategyType defines the strategy used by AlertmanagerConfig objects to match alerts in the routes and inhibition rules.

The default value is OnNamespace.
object

.spec .alertmanagerConfigNamespaceSelector

Namespaces to be selected for AlertmanagerConfig discovery. If nil, only check own namespace.
array

.spec .alertmanagerConfigNamespaceSelector .matchExpressions

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

.spec .alertmanagerConfigNamespaceSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .alertmanagerConfigNamespaceSelector .matchExpressions[] .operator

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

.spec .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.
object

.spec .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.
object

.spec .alertmanagerConfigSelector

AlertmanagerConfigs to be selected for to merge and configure Alertmanager with.
array

.spec .alertmanagerConfigSelector .matchExpressions

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

.spec .alertmanagerConfigSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .alertmanagerConfigSelector .matchExpressions[] .operator

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

.spec .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.
object

.spec .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.
object

.spec .alertmanagerConfiguration

alertmanagerConfiguration specifies the configuration of Alertmanager.

If defined, it takes precedence over the configSecret field.

This is an experimental feature, it may change in any upcoming release in a breaking way.
object

.spec .alertmanagerConfiguration .global

Defines the global parameters of the Alertmanager configuration.
object

.spec .alertmanagerConfiguration .global .httpConfig

HTTP client configuration.
object

.spec .alertmanagerConfiguration .global .httpConfig .authorization

Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object

.spec .alertmanagerConfiguration .global .httpConfig .authorization .credentials

Selects a key of a Secret in the namespace that contains the credentials for authentication.
string required

.spec .alertmanagerConfiguration .global .httpConfig .authorization .credentials .key

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

.spec .alertmanagerConfiguration .global .httpConfig .authorization .credentials .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .authorization .credentials .optional

Specify whether the Secret or its key must be defined
string

.spec .alertmanagerConfiguration .global .httpConfig .authorization .type

Defines the authentication type. The value is case-insensitive.

“Basic” is not a supported value.

Default: “Bearer”
object

.spec .alertmanagerConfiguration .global .httpConfig .basicAuth

BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object

.spec .alertmanagerConfiguration .global .httpConfig .basicAuth .password

password specifies a key of a Secret containing the password for authentication.
string required

.spec .alertmanagerConfiguration .global .httpConfig .basicAuth .password .key

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

.spec .alertmanagerConfiguration .global .httpConfig .basicAuth .password .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .basicAuth .password .optional

Specify whether the Secret or its key must be defined
object

.spec .alertmanagerConfiguration .global .httpConfig .basicAuth .username

username specifies a key of a Secret containing the username for authentication.
string required

.spec .alertmanagerConfiguration .global .httpConfig .basicAuth .username .key

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

.spec .alertmanagerConfiguration .global .httpConfig .basicAuth .username .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .basicAuth .username .optional

Specify whether the Secret or its key must be defined
object

.spec .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.
string required

.spec .alertmanagerConfiguration .global .httpConfig .bearerTokenSecret .key

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

.spec .alertmanagerConfiguration .global .httpConfig .bearerTokenSecret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .bearerTokenSecret .optional

Specify whether the Secret or its key must be defined
boolean

.spec .alertmanagerConfiguration .global .httpConfig .followRedirects

FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
string

.spec .alertmanagerConfiguration .global .httpConfig .noProxy

noProxy is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2

OAuth2 client credentials used to fetch a token for the targets.
object required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientId

clientId specifies a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientId .configMap

ConfigMap containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientId .configMap .key

The key to select.
string

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientId .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientId .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientId .secret

Secret containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientId .secret .key

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

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientId .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientId .secret .optional

Specify whether the Secret or its key must be defined
object required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientSecret

clientSecret specifies a key of a Secret containing the OAuth2 client’s secret.
string required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientSecret .key

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

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientSecret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .clientSecret .optional

Specify whether the Secret or its key must be defined
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .endpointParams

endpointParams configures the HTTP parameters to append to the token URL.
string

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .noProxy

noProxy is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .proxyConnectHeader

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
boolean

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .proxyFromEnvironment

Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
string

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .proxyUrl

proxyURL defines the HTTP proxy server to use.
array

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .scopes

scopes defines the OAuth2 scopes used for the token request.
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig

TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .ca

Certificate authority used when verifying server certificates.
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .ca .configMap

ConfigMap containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .ca .configMap .key

The key to select.
string

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .ca .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .ca .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .ca .secret

Secret containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .ca .secret .key

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

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .ca .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .ca .secret .optional

Specify whether the Secret or its key must be defined
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .cert

Client certificate to present when doing client-authentication.
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .cert .configMap

ConfigMap containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .cert .configMap .key

The key to select.
string

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .cert .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .cert .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .cert .secret

Secret containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .cert .secret .key

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

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .cert .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .cert .secret .optional

Specify whether the Secret or its key must be defined
boolean

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .insecureSkipVerify

Disable target certificate validation.
object

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .keySecret

Secret containing the client key file for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .keySecret .key

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

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .keySecret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .keySecret .optional

Specify whether the Secret or its key must be defined
string

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .maxVersion

Maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
string

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .minVersion

Minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
string

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tlsConfig .serverName

Used to verify the hostname for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .oauth2 .tokenUrl

tokenURL configures the URL to fetch the token from.
object

.spec .alertmanagerConfiguration .global .httpConfig .proxyConnectHeader

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
boolean

.spec .alertmanagerConfiguration .global .httpConfig .proxyFromEnvironment

Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
string

.spec .alertmanagerConfiguration .global .httpConfig .proxyUrl

proxyURL defines the HTTP proxy server to use.
object

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig

TLS configuration for the client.
object

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .ca

Certificate authority used when verifying server certificates.
object

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .ca .configMap

ConfigMap containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .ca .configMap .key

The key to select.
string

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .ca .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .ca .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .ca .secret

Secret containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .ca .secret .key

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

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .ca .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .ca .secret .optional

Specify whether the Secret or its key must be defined
object

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .cert

Client certificate to present when doing client-authentication.
object

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .cert .configMap

ConfigMap containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .cert .configMap .key

The key to select.
string

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .cert .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .cert .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .cert .secret

Secret containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .cert .secret .key

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

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .cert .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .cert .secret .optional

Specify whether the Secret or its key must be defined
boolean

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .insecureSkipVerify

Disable target certificate validation.
object

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .keySecret

Secret containing the client key file for the targets.
string required

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .keySecret .key

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

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .keySecret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .keySecret .optional

Specify whether the Secret or its key must be defined
string

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .maxVersion

Maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
string

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .minVersion

Minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
string

.spec .alertmanagerConfiguration .global .httpConfig .tlsConfig .serverName

Used to verify the hostname for the targets.
object

.spec .alertmanagerConfiguration .global .opsGenieApiKey

The default OpsGenie API Key.
string required

.spec .alertmanagerConfiguration .global .opsGenieApiKey .key

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

.spec .alertmanagerConfiguration .global .opsGenieApiKey .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .opsGenieApiKey .optional

Specify whether the Secret or its key must be defined
object

.spec .alertmanagerConfiguration .global .opsGenieApiUrl

The default OpsGenie API URL.
string required

.spec .alertmanagerConfiguration .global .opsGenieApiUrl .key

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

.spec .alertmanagerConfiguration .global .opsGenieApiUrl .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .opsGenieApiUrl .optional

Specify whether the Secret or its key must be defined
string

.spec .alertmanagerConfiguration .global .pagerdutyUrl

The default Pagerduty URL.
string

.spec .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.
object

.spec .alertmanagerConfiguration .global .slackApiUrl

The default Slack API URL.
string required

.spec .alertmanagerConfiguration .global .slackApiUrl .key

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

.spec .alertmanagerConfiguration .global .slackApiUrl .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .slackApiUrl .optional

Specify whether the Secret or its key must be defined
object

.spec .alertmanagerConfiguration .global .smtp

Configures global SMTP parameters.
string

.spec .alertmanagerConfiguration .global .smtp .authIdentity

SMTP Auth using PLAIN
object

.spec .alertmanagerConfiguration .global .smtp .authPassword

SMTP Auth using LOGIN and PLAIN.
string required

.spec .alertmanagerConfiguration .global .smtp .authPassword .key

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

.spec .alertmanagerConfiguration .global .smtp .authPassword .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .smtp .authPassword .optional

Specify whether the Secret or its key must be defined
object

.spec .alertmanagerConfiguration .global .smtp .authSecret

SMTP Auth using CRAM-MD5.
string required

.spec .alertmanagerConfiguration .global .smtp .authSecret .key

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

.spec .alertmanagerConfiguration .global .smtp .authSecret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .smtp .authSecret .optional

Specify whether the Secret or its key must be defined
string

.spec .alertmanagerConfiguration .global .smtp .authUsername

SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn’t authenticate to the SMTP server.
string

.spec .alertmanagerConfiguration .global .smtp .from

The default SMTP From header field.
string

.spec .alertmanagerConfiguration .global .smtp .hello

The default hostname to identify to the SMTP server.
boolean

.spec .alertmanagerConfiguration .global .smtp .requireTLS

The default SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.
object

.spec .alertmanagerConfiguration .global .smtp .smartHost

The default SMTP smarthost used for sending emails.
string required

.spec .alertmanagerConfiguration .global .smtp .smartHost .host

Defines the host’s address, it can be a DNS name or a literal IP address.
string required

.spec .alertmanagerConfiguration .global .smtp .smartHost .port

Defines the host’s port, it can be a literal port number or a port name.
object

.spec .alertmanagerConfiguration .global .smtp .tlsConfig

The default TLS configuration for SMTP receivers
object

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .ca

Certificate authority used when verifying server certificates.
object

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .ca .configMap

ConfigMap containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .ca .configMap .key

The key to select.
string

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .ca .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .ca .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .ca .secret

Secret containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .ca .secret .key

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

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .ca .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .ca .secret .optional

Specify whether the Secret or its key must be defined
object

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .cert

Client certificate to present when doing client-authentication.
object

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .cert .configMap

ConfigMap containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .cert .configMap .key

The key to select.
string

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .cert .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .cert .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .cert .secret

Secret containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .cert .secret .key

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

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .cert .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .cert .secret .optional

Specify whether the Secret or its key must be defined
boolean

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .insecureSkipVerify

Disable target certificate validation.
object

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .keySecret

Secret containing the client key file for the targets.
string required

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .keySecret .key

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

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .keySecret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .keySecret .optional

Specify whether the Secret or its key must be defined
string

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .maxVersion

Maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
string

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .minVersion

Minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
string

.spec .alertmanagerConfiguration .global .smtp .tlsConfig .serverName

Used to verify the hostname for the targets.
string

.spec .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 namespace label for routes and inhibition rules.
array

.spec .alertmanagerConfiguration .templates

Custom notification templates.
object

.spec .alertmanagerConfiguration .templates[] .configMap

ConfigMap containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .templates[] .configMap .key

The key to select.
string

.spec .alertmanagerConfiguration .templates[] .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .templates[] .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .alertmanagerConfiguration .templates[] .secret

Secret containing data to use for the targets.
string required

.spec .alertmanagerConfiguration .templates[] .secret .key

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

.spec .alertmanagerConfiguration .templates[] .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .alertmanagerConfiguration .templates[] .secret .optional

Specify whether the Secret or its key must be defined
boolean

.spec .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 to false to opt out of automounting API credentials.
string

.spec .baseImage

Base image that is used to deploy pods, without tag. Deprecated: use ‘image’ instead.
string

.spec .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
string

.spec .clusterGossipInterval

Interval between gossip attempts.
string

.spec .clusterLabel

Defines the identifier that uniquely identifies the Alertmanager cluster. You should only set it when the Alertmanager cluster includes Alertmanager instances which are external to this Alertmanager resource. In practice, the addresses of the external instances are provided via the .spec.additionalPeers field.
string

.spec .clusterPeerTimeout

Timeout for cluster peering.
string

.spec .clusterPushpullInterval

Interval between pushpull attempts.
object

.spec .clusterTLS

Configures the mutual TLS configuration for the Alertmanager cluster’s gossip protocol.

It requires Alertmanager >= 0.24.0.
object required

.spec .clusterTLS .client

Client-side configuration for mutual TLS.
object

.spec .clusterTLS .client .ca

Certificate authority used when verifying server certificates.
object

.spec .clusterTLS .client .ca .configMap

ConfigMap containing data to use for the targets.
string required

.spec .clusterTLS .client .ca .configMap .key

The key to select.
string

.spec .clusterTLS .client .ca .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .clusterTLS .client .ca .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .clusterTLS .client .ca .secret

Secret containing data to use for the targets.
string required

.spec .clusterTLS .client .ca .secret .key

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

.spec .clusterTLS .client .ca .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .clusterTLS .client .ca .secret .optional

Specify whether the Secret or its key must be defined
object

.spec .clusterTLS .client .cert

Client certificate to present when doing client-authentication.
object

.spec .clusterTLS .client .cert .configMap

ConfigMap containing data to use for the targets.
string required

.spec .clusterTLS .client .cert .configMap .key

The key to select.
string

.spec .clusterTLS .client .cert .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .clusterTLS .client .cert .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .clusterTLS .client .cert .secret

Secret containing data to use for the targets.
string required

.spec .clusterTLS .client .cert .secret .key

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

.spec .clusterTLS .client .cert .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .clusterTLS .client .cert .secret .optional

Specify whether the Secret or its key must be defined
boolean

.spec .clusterTLS .client .insecureSkipVerify

Disable target certificate validation.
object

.spec .clusterTLS .client .keySecret

Secret containing the client key file for the targets.
string required

.spec .clusterTLS .client .keySecret .key

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

.spec .clusterTLS .client .keySecret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .clusterTLS .client .keySecret .optional

Specify whether the Secret or its key must be defined
string

.spec .clusterTLS .client .maxVersion

Maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
string

.spec .clusterTLS .client .minVersion

Minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
string

.spec .clusterTLS .client .serverName

Used to verify the hostname for the targets.
object required

.spec .clusterTLS .server

Server-side configuration for mutual TLS.
object

.spec .clusterTLS .server .cert

Secret or ConfigMap containing the TLS certificate for the web server.

Either keySecret or keyFile must be defined.

It is mutually exclusive with certFile.
object

.spec .clusterTLS .server .cert .configMap

ConfigMap containing data to use for the targets.
string required

.spec .clusterTLS .server .cert .configMap .key

The key to select.
string

.spec .clusterTLS .server .cert .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .clusterTLS .server .cert .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .clusterTLS .server .cert .secret

Secret containing data to use for the targets.
string required

.spec .clusterTLS .server .cert .secret .key

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

.spec .clusterTLS .server .cert .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .clusterTLS .server .cert .secret .optional

Specify whether the Secret or its key must be defined
string

.spec .clusterTLS .server .certFile

Path to the TLS certificate file in the container for the web server.

Either keySecret or keyFile must be defined.

It is mutually exclusive with cert.
array

.spec .clusterTLS .server .cipherSuites

List of supported cipher suites for TLS versions up to TLS 1.2.

If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants
object

.spec .clusterTLS .server .client_ca

Secret or ConfigMap containing the CA certificate for client certificate authentication to the server.

It is mutually exclusive with clientCAFile.
object

.spec .clusterTLS .server .client_ca .configMap

ConfigMap containing data to use for the targets.
string required

.spec .clusterTLS .server .client_ca .configMap .key

The key to select.
string

.spec .clusterTLS .server .client_ca .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .clusterTLS .server .client_ca .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .clusterTLS .server .client_ca .secret

Secret containing data to use for the targets.
string required

.spec .clusterTLS .server .client_ca .secret .key

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

.spec .clusterTLS .server .client_ca .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .clusterTLS .server .client_ca .secret .optional

Specify whether the Secret or its key must be defined
string

.spec .clusterTLS .server .clientAuthType

The server policy for client TLS authentication.

For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType
string

.spec .clusterTLS .server .clientCAFile

Path to the CA certificate file for client certificate authentication to the server.

It is mutually exclusive with client_ca.
array

.spec .clusterTLS .server .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
string

.spec .clusterTLS .server .keyFile

Path to the TLS private key file in the container for the web server.

If defined, either cert or certFile must be defined.

It is mutually exclusive with keySecret.
object

.spec .clusterTLS .server .keySecret

Secret containing the TLS private key for the web server.

Either cert or certFile must be defined.

It is mutually exclusive with keyFile.
string required

.spec .clusterTLS .server .keySecret .key

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

.spec .clusterTLS .server .keySecret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .clusterTLS .server .keySecret .optional

Specify whether the Secret or its key must be defined
string

.spec .clusterTLS .server .maxVersion

Maximum TLS version that is acceptable.
string

.spec .clusterTLS .server .minVersion

Minimum TLS version that is acceptable.
boolean

.spec .clusterTLS .server .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.
array

.spec .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.
string

.spec .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 the alertmanager.yaml key. Additional keys from the original secret are copied to the generated secret and mounted into the /etc/alertmanager/config directory in the alertmanager container.

If either the secret or the alertmanager.yaml key is missing, the operator provisions a minimal Alertmanager configuration with one empty receiver (effectively dropping alert notifications).
array

.spec .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: alertmanager and config-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.
array

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

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

.spec .containers[] .env

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

.spec .containers[] .env[] .name

Name of the environment variable. Must be a C_IDENTIFIER.
string

.spec .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 “”.
object

.spec .containers[] .env[] .valueFrom

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

.spec .containers[] .env[] .valueFrom .configMapKeyRef

Selects a key of a ConfigMap.
string required

.spec .containers[] .env[] .valueFrom .configMapKeyRef .key

The key to select.
string

.spec .containers[] .env[] .valueFrom .configMapKeyRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .containers[] .env[] .valueFrom .configMapKeyRef .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .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.
string

.spec .containers[] .env[] .valueFrom .fieldRef .apiVersion

Version of the schema the FieldPath is written in terms of, defaults to “v1”.
string required

.spec .containers[] .env[] .valueFrom .fieldRef .fieldPath

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

.spec .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.
string

.spec .containers[] .env[] .valueFrom .resourceFieldRef .containerName

Container name: required for volumes, optional for env vars
integer | string

.spec .containers[] .env[] .valueFrom .resourceFieldRef .divisor

Specifies the output format of the exposed resources, defaults to “1”
string required

.spec .containers[] .env[] .valueFrom .resourceFieldRef .resource

Required: resource to select
object

.spec .containers[] .env[] .valueFrom .secretKeyRef

Selects a key of a secret in the pod’s namespace
string required

.spec .containers[] .env[] .valueFrom .secretKeyRef .key

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

.spec .containers[] .env[] .valueFrom .secretKeyRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .containers[] .env[] .valueFrom .secretKeyRef .optional

Specify whether the Secret or its key must be defined
array

.spec .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.
object

.spec .containers[] .envFrom[] .configMapRef

The ConfigMap to select from
string

.spec .containers[] .envFrom[] .configMapRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .containers[] .envFrom[] .configMapRef .optional

Specify whether the ConfigMap must be defined
string

.spec .containers[] .envFrom[] .prefix

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

.spec .containers[] .envFrom[] .secretRef

The Secret to select from
string

.spec .containers[] .envFrom[] .secretRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .containers[] .envFrom[] .secretRef .optional

Specify whether the Secret must be defined
string

.spec .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.
string

.spec .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
object

.spec .containers[] .lifecycle

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

.spec .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
object

.spec .containers[] .lifecycle .postStart .exec

Exec specifies a command to execute in the container.
array

.spec .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.
object

.spec .containers[] .lifecycle .postStart .httpGet

HTTPGet specifies an HTTP GET request to perform.
string

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

.spec .containers[] .lifecycle .postStart .httpGet .httpHeaders

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

.spec .containers[] .lifecycle .postStart .httpGet .httpHeaders[] .name

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string required

.spec .containers[] .lifecycle .postStart .httpGet .httpHeaders[] .value

The header field value
string

.spec .containers[] .lifecycle .postStart .httpGet .path

Path to access on the HTTP server.
integer | string required

.spec .containers[] .lifecycle .postStart .httpGet .port

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

.spec .containers[] .lifecycle .postStart .httpGet .scheme

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

.spec .containers[] .lifecycle .postStart .sleep

Sleep represents a duration that the container should sleep.
integer required

.spec .containers[] .lifecycle .postStart .sleep .seconds

Seconds is the number of seconds to sleep.
object

.spec .containers[] .lifecycle .postStart .tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
string

.spec .containers[] .lifecycle .postStart .tcpSocket .host

Optional: Host name to connect to, defaults to the pod IP.
integer | string required

.spec .containers[] .lifecycle .postStart .tcpSocket .port

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

.spec .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
object

.spec .containers[] .lifecycle .preStop .exec

Exec specifies a command to execute in the container.
array

.spec .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.
object

.spec .containers[] .lifecycle .preStop .httpGet

HTTPGet specifies an HTTP GET request to perform.
string

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

.spec .containers[] .lifecycle .preStop .httpGet .httpHeaders

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

.spec .containers[] .lifecycle .preStop .httpGet .httpHeaders[] .name

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string required

.spec .containers[] .lifecycle .preStop .httpGet .httpHeaders[] .value

The header field value
string

.spec .containers[] .lifecycle .preStop .httpGet .path

Path to access on the HTTP server.
integer | string required

.spec .containers[] .lifecycle .preStop .httpGet .port

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

.spec .containers[] .lifecycle .preStop .httpGet .scheme

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

.spec .containers[] .lifecycle .preStop .sleep

Sleep represents a duration that the container should sleep.
integer required

.spec .containers[] .lifecycle .preStop .sleep .seconds

Seconds is the number of seconds to sleep.
object

.spec .containers[] .lifecycle .preStop .tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
string

.spec .containers[] .lifecycle .preStop .tcpSocket .host

Optional: Host name to connect to, defaults to the pod IP.
integer | string required

.spec .containers[] .lifecycle .preStop .tcpSocket .port

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

.spec .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
object

.spec .containers[] .livenessProbe .exec

Exec specifies a command to execute in the container.
array

.spec .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.
integer

.spec .containers[] .livenessProbe .failureThreshold

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

.spec .containers[] .livenessProbe .grpc

GRPC specifies a GRPC HealthCheckRequest.
integer required

.spec .containers[] .livenessProbe .grpc .port

Port number of the gRPC service. Number must be in the range 1 to 65535.
string

.spec .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.
object

.spec .containers[] .livenessProbe .httpGet

HTTPGet specifies an HTTP GET request to perform.
string

.spec .containers[] .livenessProbe .httpGet .host

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

.spec .containers[] .livenessProbe .httpGet .httpHeaders

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

.spec .containers[] .livenessProbe .httpGet .httpHeaders[] .name

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string required

.spec .containers[] .livenessProbe .httpGet .httpHeaders[] .value

The header field value
string

.spec .containers[] .livenessProbe .httpGet .path

Path to access on the HTTP server.
integer | string required

.spec .containers[] .livenessProbe .httpGet .port

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

.spec .containers[] .livenessProbe .httpGet .scheme

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

.spec .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
integer

.spec .containers[] .livenessProbe .periodSeconds

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

.spec .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.
object

.spec .containers[] .livenessProbe .tcpSocket

TCPSocket specifies a connection to a TCP port.
string

.spec .containers[] .livenessProbe .tcpSocket .host

Optional: Host name to connect to, defaults to the pod IP.
integer | string required

.spec .containers[] .livenessProbe .tcpSocket .port

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

.spec .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.
integer

.spec .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
string required

.spec .containers[] .name

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

.spec .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.
integer required

.spec .containers[] .ports[] .containerPort

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

.spec .containers[] .ports[] .hostIP

What host IP to bind the external port to.
integer

.spec .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.
string

.spec .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.
string

.spec .containers[] .ports[] .protocol

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.
object

.spec .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
object

.spec .containers[] .readinessProbe .exec

Exec specifies a command to execute in the container.
array

.spec .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.
integer

.spec .containers[] .readinessProbe .failureThreshold

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

.spec .containers[] .readinessProbe .grpc

GRPC specifies a GRPC HealthCheckRequest.
integer required

.spec .containers[] .readinessProbe .grpc .port

Port number of the gRPC service. Number must be in the range 1 to 65535.
string

.spec .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.
object

.spec .containers[] .readinessProbe .httpGet

HTTPGet specifies an HTTP GET request to perform.
string

.spec .containers[] .readinessProbe .httpGet .host

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

.spec .containers[] .readinessProbe .httpGet .httpHeaders

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

.spec .containers[] .readinessProbe .httpGet .httpHeaders[] .name

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string required

.spec .containers[] .readinessProbe .httpGet .httpHeaders[] .value

The header field value
string

.spec .containers[] .readinessProbe .httpGet .path

Path to access on the HTTP server.
integer | string required

.spec .containers[] .readinessProbe .httpGet .port

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

.spec .containers[] .readinessProbe .httpGet .scheme

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

.spec .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
integer

.spec .containers[] .readinessProbe .periodSeconds

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

.spec .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.
object

.spec .containers[] .readinessProbe .tcpSocket

TCPSocket specifies a connection to a TCP port.
string

.spec .containers[] .readinessProbe .tcpSocket .host

Optional: Host name to connect to, defaults to the pod IP.
integer | string required

.spec .containers[] .readinessProbe .tcpSocket .port

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

.spec .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.
integer

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

.spec .containers[] .resizePolicy

Resources resize policy for the container.
string required

.spec .containers[] .resizePolicy[] .resourceName

Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
string required

.spec .containers[] .resizePolicy[] .restartPolicy

Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
object

.spec .containers[] .resources

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

.spec .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.
string required

.spec .containers[] .resources .claims[] .name

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

.spec .containers[] .resources .claims[] .request

Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object

.spec .containers[] .resources .limits

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

.spec .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/
string

.spec .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.
object

.spec .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/
boolean

.spec .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.
object

.spec .containers[] .securityContext .appArmorProfile

appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod’s appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
string

.spec .containers[] .securityContext .appArmorProfile .localhostProfile

localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is “Localhost”.
string required

.spec .containers[] .securityContext .appArmorProfile .type

type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime’s default profile. Unconfined - no AppArmor enforcement.
object

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

.spec .containers[] .securityContext .capabilities .add

Added capabilities
array

.spec .containers[] .securityContext .capabilities .drop

Removed capabilities
boolean

.spec .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.
string

.spec .containers[] .securityContext .procMount

procMount denotes the type of proc mount to use for the containers. The default value is Default 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.
boolean

.spec .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.
integer

.spec .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.
boolean

.spec .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.
integer

.spec .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.
object

.spec .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.
string

.spec .containers[] .securityContext .seLinuxOptions .level

Level is SELinux level label that applies to the container.
string

.spec .containers[] .securityContext .seLinuxOptions .role

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

.spec .containers[] .securityContext .seLinuxOptions .type

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

.spec .containers[] .securityContext .seLinuxOptions .user

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

.spec .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.
string

.spec .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.
string required

.spec .containers[] .securityContext .seccompProfile .type

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

.spec .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.
string

.spec .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.
string

.spec .containers[] .securityContext .windowsOptions .gmsaCredentialSpecName

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

.spec .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.
string

.spec .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.
object

.spec .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
object

.spec .containers[] .startupProbe .exec

Exec specifies a command to execute in the container.
array

.spec .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.
integer

.spec .containers[] .startupProbe .failureThreshold

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

.spec .containers[] .startupProbe .grpc

GRPC specifies a GRPC HealthCheckRequest.
integer required

.spec .containers[] .startupProbe .grpc .port

Port number of the gRPC service. Number must be in the range 1 to 65535.
string

.spec .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.
object

.spec .containers[] .startupProbe .httpGet

HTTPGet specifies an HTTP GET request to perform.
string

.spec .containers[] .startupProbe .httpGet .host

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

.spec .containers[] .startupProbe .httpGet .httpHeaders

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

.spec .containers[] .startupProbe .httpGet .httpHeaders[] .name

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string required

.spec .containers[] .startupProbe .httpGet .httpHeaders[] .value

The header field value
string

.spec .containers[] .startupProbe .httpGet .path

Path to access on the HTTP server.
integer | string required

.spec .containers[] .startupProbe .httpGet .port

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

.spec .containers[] .startupProbe .httpGet .scheme

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

.spec .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
integer

.spec .containers[] .startupProbe .periodSeconds

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

.spec .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.
object

.spec .containers[] .startupProbe .tcpSocket

TCPSocket specifies a connection to a TCP port.
string

.spec .containers[] .startupProbe .tcpSocket .host

Optional: Host name to connect to, defaults to the pod IP.
integer | string required

.spec .containers[] .startupProbe .tcpSocket .port

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

.spec .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.
integer

.spec .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
boolean

.spec .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.
boolean

.spec .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
string

.spec .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.
string

.spec .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.
boolean

.spec .containers[] .tty

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

.spec .containers[] .volumeDevices

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

.spec .containers[] .volumeDevices[] .devicePath

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

.spec .containers[] .volumeDevices[] .name

name must match the name of a persistentVolumeClaim in the pod
array

.spec .containers[] .volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.
string required

.spec .containers[] .volumeMounts[] .mountPath

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

.spec .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. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
string required

.spec .containers[] .volumeMounts[] .name

This must match the Name of a Volume.
boolean

.spec .containers[] .volumeMounts[] .readOnly

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

.spec .containers[] .volumeMounts[] .recursiveReadOnly

RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.
string

.spec .containers[] .volumeMounts[] .subPath

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).
string

.spec .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.
string

.spec .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.
object

.spec .dnsConfig

Defines the DNS configuration for the pods.
array

.spec .dnsConfig .nameservers

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

.spec .dnsConfig .options

A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Resolution options given in Options will override those that appear in the base DNSPolicy.
string required

.spec .dnsConfig .options[] .name

Name is required and must be unique.
string

.spec .dnsConfig .options[] .value

Value is optional.
array

.spec .dnsConfig .searches

A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy.
string

.spec .dnsPolicy

Defines the DNS policy for the pods.
array

.spec .enableFeatures

Enable access to Alertmanager feature flags. By default, no features are enabled. Enabling features which are disabled by default 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.

It requires Alertmanager >= 0.27.0.
boolean

.spec .enableServiceLinks

Indicates whether information about services should be injected into pod’s environment variables
string

.spec .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.
boolean

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

.spec .hostAliases

Pods’ hostAliases configuration
array required

.spec .hostAliases[] .hostnames

Hostnames for the above IP address.
string required

.spec .hostAliases[] .ip

IP address of the host file entry.
string

.spec .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.
string

.spec .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.
array

.spec .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
string

.spec .imagePullSecrets[] .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
array

.spec .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.
array

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

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

.spec .initContainers[] .env

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

.spec .initContainers[] .env[] .name

Name of the environment variable. Must be a C_IDENTIFIER.
string

.spec .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 “”.
object

.spec .initContainers[] .env[] .valueFrom

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

.spec .initContainers[] .env[] .valueFrom .configMapKeyRef

Selects a key of a ConfigMap.
string required

.spec .initContainers[] .env[] .valueFrom .configMapKeyRef .key

The key to select.
string

.spec .initContainers[] .env[] .valueFrom .configMapKeyRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .initContainers[] .env[] .valueFrom .configMapKeyRef .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .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.
string

.spec .initContainers[] .env[] .valueFrom .fieldRef .apiVersion

Version of the schema the FieldPath is written in terms of, defaults to “v1”.
string required

.spec .initContainers[] .env[] .valueFrom .fieldRef .fieldPath

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

.spec .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.
string

.spec .initContainers[] .env[] .valueFrom .resourceFieldRef .containerName

Container name: required for volumes, optional for env vars
integer | string

.spec .initContainers[] .env[] .valueFrom .resourceFieldRef .divisor

Specifies the output format of the exposed resources, defaults to “1”
string required

.spec .initContainers[] .env[] .valueFrom .resourceFieldRef .resource

Required: resource to select
object

.spec .initContainers[] .env[] .valueFrom .secretKeyRef

Selects a key of a secret in the pod’s namespace
string required

.spec .initContainers[] .env[] .valueFrom .secretKeyRef .key

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

.spec .initContainers[] .env[] .valueFrom .secretKeyRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .initContainers[] .env[] .valueFrom .secretKeyRef .optional

Specify whether the Secret or its key must be defined
array

.spec .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.
object

.spec .initContainers[] .envFrom[] .configMapRef

The ConfigMap to select from
string

.spec .initContainers[] .envFrom[] .configMapRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .initContainers[] .envFrom[] .configMapRef .optional

Specify whether the ConfigMap must be defined
string

.spec .initContainers[] .envFrom[] .prefix

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

.spec .initContainers[] .envFrom[] .secretRef

The Secret to select from
string

.spec .initContainers[] .envFrom[] .secretRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .initContainers[] .envFrom[] .secretRef .optional

Specify whether the Secret must be defined
string

.spec .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.
string

.spec .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
object

.spec .initContainers[] .lifecycle

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

.spec .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
object

.spec .initContainers[] .lifecycle .postStart .exec

Exec specifies a command to execute in the container.
array

.spec .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.
object

.spec .initContainers[] .lifecycle .postStart .httpGet

HTTPGet specifies an HTTP GET request to perform.
string

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

.spec .initContainers[] .lifecycle .postStart .httpGet .httpHeaders

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

.spec .initContainers[] .lifecycle .postStart .httpGet .httpHeaders[] .name

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string required

.spec .initContainers[] .lifecycle .postStart .httpGet .httpHeaders[] .value

The header field value
string

.spec .initContainers[] .lifecycle .postStart .httpGet .path

Path to access on the HTTP server.
integer | string required

.spec .initContainers[] .lifecycle .postStart .httpGet .port

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

.spec .initContainers[] .lifecycle .postStart .httpGet .scheme

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

.spec .initContainers[] .lifecycle .postStart .sleep

Sleep represents a duration that the container should sleep.
integer required

.spec .initContainers[] .lifecycle .postStart .sleep .seconds

Seconds is the number of seconds to sleep.
object

.spec .initContainers[] .lifecycle .postStart .tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
string

.spec .initContainers[] .lifecycle .postStart .tcpSocket .host

Optional: Host name to connect to, defaults to the pod IP.
integer | string required

.spec .initContainers[] .lifecycle .postStart .tcpSocket .port

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

.spec .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
object

.spec .initContainers[] .lifecycle .preStop .exec

Exec specifies a command to execute in the container.
array

.spec .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.
object

.spec .initContainers[] .lifecycle .preStop .httpGet

HTTPGet specifies an HTTP GET request to perform.
string

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

.spec .initContainers[] .lifecycle .preStop .httpGet .httpHeaders

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

.spec .initContainers[] .lifecycle .preStop .httpGet .httpHeaders[] .name

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string required

.spec .initContainers[] .lifecycle .preStop .httpGet .httpHeaders[] .value

The header field value
string

.spec .initContainers[] .lifecycle .preStop .httpGet .path

Path to access on the HTTP server.
integer | string required

.spec .initContainers[] .lifecycle .preStop .httpGet .port

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

.spec .initContainers[] .lifecycle .preStop .httpGet .scheme

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

.spec .initContainers[] .lifecycle .preStop .sleep

Sleep represents a duration that the container should sleep.
integer required

.spec .initContainers[] .lifecycle .preStop .sleep .seconds

Seconds is the number of seconds to sleep.
object

.spec .initContainers[] .lifecycle .preStop .tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
string

.spec .initContainers[] .lifecycle .preStop .tcpSocket .host

Optional: Host name to connect to, defaults to the pod IP.
integer | string required

.spec .initContainers[] .lifecycle .preStop .tcpSocket .port

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

.spec .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
object

.spec .initContainers[] .livenessProbe .exec

Exec specifies a command to execute in the container.
array

.spec .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.
integer

.spec .initContainers[] .livenessProbe .failureThreshold

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

.spec .initContainers[] .livenessProbe .grpc

GRPC specifies a GRPC HealthCheckRequest.
integer required

.spec .initContainers[] .livenessProbe .grpc .port

Port number of the gRPC service. Number must be in the range 1 to 65535.
string

.spec .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.
object

.spec .initContainers[] .livenessProbe .httpGet

HTTPGet specifies an HTTP GET request to perform.
string

.spec .initContainers[] .livenessProbe .httpGet .host

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

.spec .initContainers[] .livenessProbe .httpGet .httpHeaders

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

.spec .initContainers[] .livenessProbe .httpGet .httpHeaders[] .name

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string required

.spec .initContainers[] .livenessProbe .httpGet .httpHeaders[] .value

The header field value
string

.spec .initContainers[] .livenessProbe .httpGet .path

Path to access on the HTTP server.
integer | string required

.spec .initContainers[] .livenessProbe .httpGet .port

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

.spec .initContainers[] .livenessProbe .httpGet .scheme

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

.spec .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
integer

.spec .initContainers[] .livenessProbe .periodSeconds

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

.spec .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.
object

.spec .initContainers[] .livenessProbe .tcpSocket

TCPSocket specifies a connection to a TCP port.
string

.spec .initContainers[] .livenessProbe .tcpSocket .host

Optional: Host name to connect to, defaults to the pod IP.
integer | string required

.spec .initContainers[] .livenessProbe .tcpSocket .port

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

.spec .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.
integer

.spec .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
string required

.spec .initContainers[] .name

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

.spec .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.
integer required

.spec .initContainers[] .ports[] .containerPort

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

.spec .initContainers[] .ports[] .hostIP

What host IP to bind the external port to.
integer

.spec .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.
string

.spec .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.
string

.spec .initContainers[] .ports[] .protocol

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.
object

.spec .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
object

.spec .initContainers[] .readinessProbe .exec

Exec specifies a command to execute in the container.
array

.spec .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.
integer

.spec .initContainers[] .readinessProbe .failureThreshold

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

.spec .initContainers[] .readinessProbe .grpc

GRPC specifies a GRPC HealthCheckRequest.
integer required

.spec .initContainers[] .readinessProbe .grpc .port

Port number of the gRPC service. Number must be in the range 1 to 65535.
string

.spec .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.
object

.spec .initContainers[] .readinessProbe .httpGet

HTTPGet specifies an HTTP GET request to perform.
string

.spec .initContainers[] .readinessProbe .httpGet .host

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

.spec .initContainers[] .readinessProbe .httpGet .httpHeaders

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

.spec .initContainers[] .readinessProbe .httpGet .httpHeaders[] .name

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string required

.spec .initContainers[] .readinessProbe .httpGet .httpHeaders[] .value

The header field value
string

.spec .initContainers[] .readinessProbe .httpGet .path

Path to access on the HTTP server.
integer | string required

.spec .initContainers[] .readinessProbe .httpGet .port

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

.spec .initContainers[] .readinessProbe .httpGet .scheme

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

.spec .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
integer

.spec .initContainers[] .readinessProbe .periodSeconds

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

.spec .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.
object

.spec .initContainers[] .readinessProbe .tcpSocket

TCPSocket specifies a connection to a TCP port.
string

.spec .initContainers[] .readinessProbe .tcpSocket .host

Optional: Host name to connect to, defaults to the pod IP.
integer | string required

.spec .initContainers[] .readinessProbe .tcpSocket .port

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

.spec .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.
integer

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

.spec .initContainers[] .resizePolicy

Resources resize policy for the container.
string required

.spec .initContainers[] .resizePolicy[] .resourceName

Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
string required

.spec .initContainers[] .resizePolicy[] .restartPolicy

Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
object

.spec .initContainers[] .resources

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

.spec .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.
string required

.spec .initContainers[] .resources .claims[] .name

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

.spec .initContainers[] .resources .claims[] .request

Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object

.spec .initContainers[] .resources .limits

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

.spec .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/
string

.spec .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.
object

.spec .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/
boolean

.spec .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.
object

.spec .initContainers[] .securityContext .appArmorProfile

appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod’s appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
string

.spec .initContainers[] .securityContext .appArmorProfile .localhostProfile

localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is “Localhost”.
string required

.spec .initContainers[] .securityContext .appArmorProfile .type

type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime’s default profile. Unconfined - no AppArmor enforcement.
object

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

.spec .initContainers[] .securityContext .capabilities .add

Added capabilities
array

.spec .initContainers[] .securityContext .capabilities .drop

Removed capabilities
boolean

.spec .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.
string

.spec .initContainers[] .securityContext .procMount

procMount denotes the type of proc mount to use for the containers. The default value is Default 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.
boolean

.spec .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.
integer

.spec .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.
boolean

.spec .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.
integer

.spec .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.
object

.spec .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.
string

.spec .initContainers[] .securityContext .seLinuxOptions .level

Level is SELinux level label that applies to the container.
string

.spec .initContainers[] .securityContext .seLinuxOptions .role

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

.spec .initContainers[] .securityContext .seLinuxOptions .type

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

.spec .initContainers[] .securityContext .seLinuxOptions .user

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

.spec .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.
string

.spec .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.
string required

.spec .initContainers[] .securityContext .seccompProfile .type

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

.spec .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.
string

.spec .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.
string

.spec .initContainers[] .securityContext .windowsOptions .gmsaCredentialSpecName

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

.spec .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.
string

.spec .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.
object

.spec .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
object

.spec .initContainers[] .startupProbe .exec

Exec specifies a command to execute in the container.
array

.spec .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.
integer

.spec .initContainers[] .startupProbe .failureThreshold

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

.spec .initContainers[] .startupProbe .grpc

GRPC specifies a GRPC HealthCheckRequest.
integer required

.spec .initContainers[] .startupProbe .grpc .port

Port number of the gRPC service. Number must be in the range 1 to 65535.
string

.spec .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.
object

.spec .initContainers[] .startupProbe .httpGet

HTTPGet specifies an HTTP GET request to perform.
string

.spec .initContainers[] .startupProbe .httpGet .host

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

.spec .initContainers[] .startupProbe .httpGet .httpHeaders

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

.spec .initContainers[] .startupProbe .httpGet .httpHeaders[] .name

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string required

.spec .initContainers[] .startupProbe .httpGet .httpHeaders[] .value

The header field value
string

.spec .initContainers[] .startupProbe .httpGet .path

Path to access on the HTTP server.
integer | string required

.spec .initContainers[] .startupProbe .httpGet .port

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

.spec .initContainers[] .startupProbe .httpGet .scheme

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

.spec .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
integer

.spec .initContainers[] .startupProbe .periodSeconds

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

.spec .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.
object

.spec .initContainers[] .startupProbe .tcpSocket

TCPSocket specifies a connection to a TCP port.
string

.spec .initContainers[] .startupProbe .tcpSocket .host

Optional: Host name to connect to, defaults to the pod IP.
integer | string required

.spec .initContainers[] .startupProbe .tcpSocket .port

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

.spec .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.
integer

.spec .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
boolean

.spec .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.
boolean

.spec .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
string

.spec .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.
string

.spec .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.
boolean

.spec .initContainers[] .tty

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

.spec .initContainers[] .volumeDevices

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

.spec .initContainers[] .volumeDevices[] .devicePath

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

.spec .initContainers[] .volumeDevices[] .name

name must match the name of a persistentVolumeClaim in the pod
array

.spec .initContainers[] .volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.
string required

.spec .initContainers[] .volumeMounts[] .mountPath

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

.spec .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. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
string required

.spec .initContainers[] .volumeMounts[] .name

This must match the Name of a Volume.
boolean

.spec .initContainers[] .volumeMounts[] .readOnly

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

.spec .initContainers[] .volumeMounts[] .recursiveReadOnly

RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.
string

.spec .initContainers[] .volumeMounts[] .subPath

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).
string

.spec .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.
string

.spec .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.
object

.spec .limits

Defines the limits command line flags when starting Alertmanager.
string

.spec .limits .maxPerSilenceBytes

The maximum size of an individual silence as stored on disk. This corresponds to the Alertmanager’s --silences.max-per-silence-bytes flag. It requires Alertmanager >= v0.28.0.
integer

.spec .limits .maxSilences

The maximum number active and pending silences. This corresponds to the Alertmanager’s --silences.max-silences flag. It requires Alertmanager >= v0.28.0.
boolean

.spec .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.
string

.spec .logFormat

Log format for Alertmanager to be configured with.
string

.spec .logLevel

Log level for Alertmanager to be configured with.
integer

.spec .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.
object

.spec .nodeSelector

Define which Nodes the Pods are scheduled on.
boolean

.spec .paused

If set to true all actions on the underlying managed objects are not goint to be performed, except for delete actions.
object

.spec .persistentVolumeClaimRetentionPolicy

The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. The default behavior is all PVCs are retained. This is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26. It requires enabling the StatefulSetAutoDeletePVC feature gate.
string

.spec .persistentVolumeClaimRetentionPolicy .whenDeleted

WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of Retain causes PVCs to not be affected by StatefulSet deletion. The Delete policy causes those PVCs to be deleted.
string

.spec .persistentVolumeClaimRetentionPolicy .whenScaled

WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of Retain causes PVCs to not be affected by a scaledown. The Delete policy causes the associated PVCs for any excess pods above the replica count to be deleted.
object

.spec .podMetadata
PodMetadata configures labels and annotations which are propagated to the Alertmanager pods.

The following items are reserved and cannot be overridden:
- “alertmanager” label, set to the name of the Alertmanager instance.
- “app.kubernetes.io/instance” label, set to the name of the Alertmanager instance.
- “app.kubernetes.io/managed-by” label, set to “prometheus-operator”.
- “app.kubernetes.io/name” label, set to “alertmanager”.
- “app.kubernetes.io/version” label, set to the Alertmanager version.
- “kubectl.kubernetes.io/default-container” annotation, set to “alertmanager”.
object

.spec .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
object

.spec .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
string

.spec .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
string

.spec .portName

Port name used for the pods and governing service. Defaults to web.
string

.spec .priorityClassName

Priority class assigned to the Pods
integer

.spec .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.
object

.spec .resources

Define resources requests and limits for single Pods.
array

.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.
string required

.spec .resources .claims[] .name

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

.spec .resources .claims[] .request

Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object

.spec .resources .limits

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

.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/
string

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

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

.spec .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.
object

.spec .securityContext

SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
object

.spec .securityContext .appArmorProfile

appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
string

.spec .securityContext .appArmorProfile .localhostProfile

localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is “Localhost”.
string required

.spec .securityContext .appArmorProfile .type

type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime’s default profile. Unconfined - no AppArmor enforcement.
integer

.spec .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:
1. The owning GID will be the FSGroup
2. The setgid bit is set (new files created in the volume will be owned by FSGroup)
3. The permission bits are OR’d with rw-rw—-
If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.
string

.spec .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.
integer

.spec .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.
boolean

.spec .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.
integer

.spec .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.
string

.spec .securityContext .seLinuxChangePolicy

seLinuxChangePolicy defines how the container’s SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are “MountOption” and “Recursive”.

“Recursive” means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.

“MountOption” mounts all eligible Pod volumes with -o context mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. “MountOption” value is allowed only when SELinuxMount feature gate is enabled.

If not specified and SELinuxMount feature gate is enabled, “MountOption” is used. If not specified and SELinuxMount feature gate is disabled, “MountOption” is used for ReadWriteOncePod volumes and “Recursive” for all other volumes.

This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.

All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows.
object

.spec .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.
string

.spec .securityContext .seLinuxOptions .level

Level is SELinux level label that applies to the container.
string

.spec .securityContext .seLinuxOptions .role

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

.spec .securityContext .seLinuxOptions .type

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

.spec .securityContext .seLinuxOptions .user

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

.spec .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.
string

.spec .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.
string required

.spec .securityContext .seccompProfile .type

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

.spec .securityContext .supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows.
string

.spec .securityContext .supplementalGroupsPolicy

Defines how supplemental groups of the first container processes are calculated. Valid values are “Merge” and “Strict”. If not specified, “Merge” is used. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature. Note that this field cannot be set when spec.os.name is windows.
array

.spec .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.
string required

.spec .securityContext .sysctls[] .name

Name of a property to set
string required

.spec .securityContext .sysctls[] .value

Value of a property to set
object

.spec .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.
string

.spec .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.
string

.spec .securityContext .windowsOptions .gmsaCredentialSpecName

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

.spec .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.
string

.spec .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.
string

.spec .serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.
string

.spec .serviceName

The name of the service name used by the underlying StatefulSet(s) as the governing service. If defined, the Service must be created before the Alertmanager resource in the same namespace and it must define a selector that matches the pod labels. If empty, the operator will create and manage a headless service named alertmanager-operated for Alermanager resources. When deploying multiple Alertmanager resources in the same namespace, it is recommended to specify a different value for each. See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.
string

.spec .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.
object

.spec .storage

Storage is the definition of how storage will be used by the Alertmanager instances.
boolean

.spec .storage .disableMountSubPath

Deprecated: subPath usage will be removed in a future release.
object

.spec .storage .emptyDir

EmptyDirVolumeSource to be used by the StatefulSet. If specified, it takes precedence over ephemeral and volumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
string

.spec .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 | string

.spec .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
object

.spec .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
object

.spec .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 the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.
object

.spec .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.
object required

.spec .storage .ephemeral .volumeClaimTemplate .spec

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

.spec .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
object

.spec .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.
string

.spec .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.
string required

.spec .storage .ephemeral .volumeClaimTemplate .spec .dataSource .kind

Kind is the type of resource being referenced
string required

.spec .storage .ephemeral .volumeClaimTemplate .spec .dataSource .name

Name is the name of resource being referenced
object

.spec .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.
string

.spec .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.
string required

.spec .storage .ephemeral .volumeClaimTemplate .spec .dataSourceRef .kind

Kind is the type of resource being referenced
string required

.spec .storage .ephemeral .volumeClaimTemplate .spec .dataSourceRef .name

Name is the name of resource being referenced
string

.spec .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.
object

.spec .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
object

.spec .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/
object

.spec .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/
object

.spec .storage .ephemeral .volumeClaimTemplate .spec .selector

selector is a label query over volumes to consider for binding.
array

.spec .storage .ephemeral .volumeClaimTemplate .spec .selector .matchExpressions

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

.spec .storage .ephemeral .volumeClaimTemplate .spec .selector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .storage .ephemeral .volumeClaimTemplate .spec .selector .matchExpressions[] .operator

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

.spec .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.
object

.spec .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.
string

.spec .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
string

.spec .storage .ephemeral .volumeClaimTemplate .spec .volumeAttributesClassName

volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it’s not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
string

.spec .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.
string

.spec .storage .ephemeral .volumeClaimTemplate .spec .volumeName

volumeName is the binding reference to the PersistentVolume backing this claim.
object

.spec .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.
string

.spec .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
string

.spec .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
object

.spec .storage .volumeClaimTemplate .metadata

EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
object

.spec .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
object

.spec .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
string

.spec .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
object

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

.spec .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
object

.spec .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.
string

.spec .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.
string required

.spec .storage .volumeClaimTemplate .spec .dataSource .kind

Kind is the type of resource being referenced
string required

.spec .storage .volumeClaimTemplate .spec .dataSource .name

Name is the name of resource being referenced
object

.spec .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.
string

.spec .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.
string required

.spec .storage .volumeClaimTemplate .spec .dataSourceRef .kind

Kind is the type of resource being referenced
string required

.spec .storage .volumeClaimTemplate .spec .dataSourceRef .name

Name is the name of resource being referenced
string

.spec .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.
object

.spec .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
object

.spec .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/
object

.spec .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/
object

.spec .storage .volumeClaimTemplate .spec .selector

selector is a label query over volumes to consider for binding.
array

.spec .storage .volumeClaimTemplate .spec .selector .matchExpressions

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

.spec .storage .volumeClaimTemplate .spec .selector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .storage .volumeClaimTemplate .spec .selector .matchExpressions[] .operator

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

.spec .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.
object

.spec .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.
string

.spec .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
string

.spec .storage .volumeClaimTemplate .spec .volumeAttributesClassName

volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it’s not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
string

.spec .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.
string

.spec .storage .volumeClaimTemplate .spec .volumeName

volumeName is the binding reference to the PersistentVolume backing this claim.
object

.spec .storage .volumeClaimTemplate .status

Deprecated: this field is never set.
array

.spec .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
object

.spec .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.
object

.spec .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.
object

.spec .storage .volumeClaimTemplate .status .capacity

capacity represents the actual resources of the underlying volume.
array

.spec .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 ‘Resizing’.
string

.spec .storage .volumeClaimTemplate .status .conditions[] .lastProbeTime

lastProbeTime is the time we probed the condition.
string

.spec .storage .volumeClaimTemplate .status .conditions[] .lastTransitionTime

lastTransitionTime is the time the condition transitioned from one status to another.
string

.spec .storage .volumeClaimTemplate .status .conditions[] .message

message is the human-readable message indicating details about last transition.
string

.spec .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 “Resizing” that means the underlying persistent volume is being resized.
string required

.spec .storage .volumeClaimTemplate .status .conditions[] .status

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required
string required

.spec .storage .volumeClaimTemplate .status .conditions[] .type

Type is the type of the condition. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about
string

.spec .storage .volumeClaimTemplate .status .currentVolumeAttributesClassName

currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
object

.spec .storage .volumeClaimTemplate .status .modifyVolumeStatus

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
string required

.spec .storage .volumeClaimTemplate .status .modifyVolumeStatus .status
status is the status of the ControllerModifyVolume operation. It can be in any of following states:
- Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing.
- InProgress InProgress indicates that the volume is being modified.
- Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified.
Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
string

.spec .storage .volumeClaimTemplate .status .modifyVolumeStatus .targetVolumeAttributesClassName

targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
string

.spec .storage .volumeClaimTemplate .status .phase

phase represents the current phase of PersistentVolumeClaim.
string

.spec .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.
integer

.spec .terminationGracePeriodSeconds

Optional duration in seconds the pod needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down) which may lead to data corruption.

Defaults to 120 seconds.
array

.spec .tolerations

If specified, the pod’s tolerations.
string

.spec .tolerations[] .effect

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

.spec .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.
string

.spec .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.
integer

.spec .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.
string

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

.spec .topologySpreadConstraints

If specified, the pod’s topology spread constraints.
object

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

.spec .topologySpreadConstraints[] .labelSelector .matchExpressions

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

.spec .topologySpreadConstraints[] .labelSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .topologySpreadConstraints[] .labelSelector .matchExpressions[] .operator

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

.spec .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.
object

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

.spec .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).
integer required

.spec .topologySpreadConstraints[] .maxSkew
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.
integer

.spec .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.
string

.spec .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.
string

.spec .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.
string required

.spec .topologySpreadConstraints[] .topologyKey

TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each 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.
string required

.spec .topologySpreadConstraints[] .whenUnsatisfiable
WhenUnsatisfiable indicates how to deal with a pod if it doesn’t satisfy the spread constraint.
- DoNotSchedule (default) tells the scheduler not to schedule it.
- ScheduleAnyway tells the scheduler to 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.
string

.spec .version

Version the cluster should be on.
array

.spec .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.
string required

.spec .volumeMounts[] .mountPath

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

.spec .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. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
string required

.spec .volumeMounts[] .name

This must match the Name of a Volume.
boolean

.spec .volumeMounts[] .readOnly

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

.spec .volumeMounts[] .recursiveReadOnly

RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.
string

.spec .volumeMounts[] .subPath

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).
string

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

.spec .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.
object

.spec .volumes[] .awsElasticBlockStore

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
string

.spec .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
integer

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

.spec .volumes[] .awsElasticBlockStore .readOnly

readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
string required

.spec .volumes[] .awsElasticBlockStore .volumeID

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

.spec .volumes[] .azureDisk

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.
string

.spec .volumes[] .azureDisk .cachingMode

cachingMode is the Host Caching mode: None, Read Only, Read Write.
string required

.spec .volumes[] .azureDisk .diskName

diskName is the Name of the data disk in the blob storage
string required

.spec .volumes[] .azureDisk .diskURI

diskURI is the URI of data disk in the blob storage
string

.spec .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.
string

.spec .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
boolean

.spec .volumes[] .azureDisk .readOnly

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

.spec .volumes[] .azureFile

azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.
boolean

.spec .volumes[] .azureFile .readOnly

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
string required

.spec .volumes[] .azureFile .secretName

secretName is the name of secret that contains Azure Storage Account Name and Key
string required

.spec .volumes[] .azureFile .shareName

shareName is the azure share Name
object

.spec .volumes[] .cephfs

cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
array required

.spec .volumes[] .cephfs .monitors

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

.spec .volumes[] .cephfs .path

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

.spec .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
string

.spec .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
object

.spec .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
string

.spec .volumes[] .cephfs .secretRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
string

.spec .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
object

.spec .volumes[] .cinder

cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
string

.spec .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
boolean

.spec .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
object

.spec .volumes[] .cinder .secretRef

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
string

.spec .volumes[] .cinder .secretRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
string required

.spec .volumes[] .cinder .volumeID

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

.spec .volumes[] .configMap

configMap represents a configMap that should populate this volume
integer

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

.spec .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 ‘..’.
string required

.spec .volumes[] .configMap .items[] .key

key is the key to project.
integer

.spec .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.
string required

.spec .volumes[] .configMap .items[] .path

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

.spec .volumes[] .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .volumes[] .configMap .optional

optional specify whether the ConfigMap or its keys must be defined
object

.spec .volumes[] .csi

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
string required

.spec .volumes[] .csi .driver

driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
string

.spec .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.
object

.spec .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.
string

.spec .volumes[] .csi .nodePublishSecretRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .volumes[] .csi .readOnly

readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
object

.spec .volumes[] .csi .volumeAttributes

volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.
object

.spec .volumes[] .downwardAPI

downwardAPI represents downward API about the pod that should populate this volume
integer

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

.spec .volumes[] .downwardAPI .items

Items is a list of downward API volume file
object

.spec .volumes[] .downwardAPI .items[] .fieldRef

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
string

.spec .volumes[] .downwardAPI .items[] .fieldRef .apiVersion

Version of the schema the FieldPath is written in terms of, defaults to “v1”.
string required

.spec .volumes[] .downwardAPI .items[] .fieldRef .fieldPath

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

.spec .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.
string required

.spec .volumes[] .downwardAPI .items[] .path

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ‘..’ path. Must be utf-8 encoded. The first item of the relative path must not start with ‘..’
object

.spec .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.
string

.spec .volumes[] .downwardAPI .items[] .resourceFieldRef .containerName

Container name: required for volumes, optional for env vars
integer | string

.spec .volumes[] .downwardAPI .items[] .resourceFieldRef .divisor

Specifies the output format of the exposed resources, defaults to “1”
string required

.spec .volumes[] .downwardAPI .items[] .resourceFieldRef .resource

Required: resource to select
object

.spec .volumes[] .emptyDir

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
string

.spec .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 | string

.spec .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
object

.spec .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.
object

.spec .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 the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.
object

.spec .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.
object required

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec

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

.spec .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
object

.spec .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.
string

.spec .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.
string required

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec .dataSource .kind

Kind is the type of resource being referenced
string required

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec .dataSource .name

Name is the name of resource being referenced
object

.spec .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.
string

.spec .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.
string required

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec .dataSourceRef .kind

Kind is the type of resource being referenced
string required

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec .dataSourceRef .name

Name is the name of resource being referenced
string

.spec .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.
object

.spec .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
object

.spec .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/
object

.spec .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/
object

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec .selector

selector is a label query over volumes to consider for binding.
array

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec .selector .matchExpressions

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

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec .selector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec .selector .matchExpressions[] .operator

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

.spec .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.
object

.spec .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.
string

.spec .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
string

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec .volumeAttributesClassName

volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it’s not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
string

.spec .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.
string

.spec .volumes[] .ephemeral .volumeClaimTemplate .spec .volumeName

volumeName is the binding reference to the PersistentVolume backing this claim.
object

.spec .volumes[] .fc

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
string

.spec .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.
integer

.spec .volumes[] .fc .lun

lun is Optional: FC target lun number
boolean

.spec .volumes[] .fc .readOnly

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
array

.spec .volumes[] .fc .targetWWNs

targetWWNs is Optional: FC target worldwide names (WWNs)
array

.spec .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.
object

.spec .volumes[] .flexVolume

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
string required

.spec .volumes[] .flexVolume .driver

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

.spec .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.
object

.spec .volumes[] .flexVolume .options

options is Optional: this field holds extra command options if any.
boolean

.spec .volumes[] .flexVolume .readOnly

readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
object

.spec .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.
string

.spec .volumes[] .flexVolume .secretRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
object

.spec .volumes[] .flocker

flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
string

.spec .volumes[] .flocker .datasetName

datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
string

.spec .volumes[] .flocker .datasetUUID

datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
object

.spec .volumes[] .gcePersistentDisk

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
string

.spec .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
integer

.spec .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
string required

.spec .volumes[] .gcePersistentDisk .pdName

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
boolean

.spec .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
object

.spec .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.
string

.spec .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.
string required

.spec .volumes[] .gitRepo .repository

repository is the URL
string

.spec .volumes[] .gitRepo .revision

revision is the commit hash for the specified revision.
object

.spec .volumes[] .glusterfs

glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md
string required

.spec .volumes[] .glusterfs .endpoints

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

.spec .volumes[] .glusterfs .path

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

.spec .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
object

.spec .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
string required

.spec .volumes[] .hostPath .path

path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
string

.spec .volumes[] .hostPath .type

type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
object

.spec .volumes[] .image
image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet’s host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:
- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn’t present.
- IfNotPresent: the kubelet pulls if the reference isn’t already present on disk. Container creation will fail if the reference isn’t present and the pull fails.
The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[].volumeMounts.subpath). The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
string

.spec .volumes[] .image .pullPolicy

Policy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn’t present. IfNotPresent: the kubelet pulls if the reference isn’t already present on disk. Container creation will fail if the reference isn’t present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
string

.spec .volumes[] .image .reference

Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. 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.
object

.spec .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
boolean

.spec .volumes[] .iscsi .chapAuthDiscovery

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
boolean

.spec .volumes[] .iscsi .chapAuthSession

chapAuthSession defines whether support iSCSI Session CHAP authentication
string

.spec .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
string

.spec .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.
string required

.spec .volumes[] .iscsi .iqn

iqn is the target iSCSI Qualified Name.
string

.spec .volumes[] .iscsi .iscsiInterface

iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp).
integer required

.spec .volumes[] .iscsi .lun

lun represents iSCSI Target Lun number.
array

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

.spec .volumes[] .iscsi .readOnly

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
object

.spec .volumes[] .iscsi .secretRef

secretRef is the CHAP Secret for iSCSI target and initiator authentication
string

.spec .volumes[] .iscsi .secretRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
string required

.spec .volumes[] .iscsi .targetPortal

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

.spec .volumes[] .name

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
object

.spec .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
string required

.spec .volumes[] .nfs .path

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

.spec .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
string required

.spec .volumes[] .nfs .server

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

.spec .volumes[] .persistentVolumeClaim

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
string required

.spec .volumes[] .persistentVolumeClaim .claimName

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
boolean

.spec .volumes[] .persistentVolumeClaim .readOnly

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
object

.spec .volumes[] .photonPersistentDisk

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
string

.spec .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.
string required

.spec .volumes[] .photonPersistentDisk .pdID

pdID is the ID that identifies Photon Controller persistent disk
object

.spec .volumes[] .portworxVolume

portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.
string

.spec .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.
boolean

.spec .volumes[] .portworxVolume .readOnly

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
string required

.spec .volumes[] .portworxVolume .volumeID

volumeID uniquely identifies a Portworx volume
object

.spec .volumes[] .projected

projected items for all in one resources secrets, configmaps, and downward API
integer

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

.spec .volumes[] .projected .sources

sources is the list of volume projections. Each entry in this list handles one source.
object

.spec .volumes[] .projected .sources[] .clusterTrustBundle

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
object

.spec .volumes[] .projected .sources[] .clusterTrustBundle .labelSelector

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as “match nothing”. If set but empty, interpreted as “match everything”.
array

.spec .volumes[] .projected .sources[] .clusterTrustBundle .labelSelector .matchExpressions

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

.spec .volumes[] .projected .sources[] .clusterTrustBundle .labelSelector .matchExpressions[] .key

key is the label key that the selector applies to.
string required

.spec .volumes[] .projected .sources[] .clusterTrustBundle .labelSelector .matchExpressions[] .operator

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

.spec .volumes[] .projected .sources[] .clusterTrustBundle .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.
object

.spec .volumes[] .projected .sources[] .clusterTrustBundle .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.
string

.spec .volumes[] .projected .sources[] .clusterTrustBundle .name

Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
boolean

.spec .volumes[] .projected .sources[] .clusterTrustBundle .optional

If true, don’t block pod startup if the referenced ClusterTrustBundle(s) aren’t available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.
string required

.spec .volumes[] .projected .sources[] .clusterTrustBundle .path

Relative path from the volume root to write the bundle.
string

.spec .volumes[] .projected .sources[] .clusterTrustBundle .signerName

Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.
object

.spec .volumes[] .projected .sources[] .configMap

configMap information about the configMap data to project
array

.spec .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 ‘..’.
string required

.spec .volumes[] .projected .sources[] .configMap .items[] .key

key is the key to project.
integer

.spec .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.
string required

.spec .volumes[] .projected .sources[] .configMap .items[] .path

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

.spec .volumes[] .projected .sources[] .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .volumes[] .projected .sources[] .configMap .optional

optional specify whether the ConfigMap or its keys must be defined
object

.spec .volumes[] .projected .sources[] .downwardAPI

downwardAPI information about the downwardAPI data to project
array

.spec .volumes[] .projected .sources[] .downwardAPI .items

Items is a list of DownwardAPIVolume file
object

.spec .volumes[] .projected .sources[] .downwardAPI .items[] .fieldRef

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
string

.spec .volumes[] .projected .sources[] .downwardAPI .items[] .fieldRef .apiVersion

Version of the schema the FieldPath is written in terms of, defaults to “v1”.
string required

.spec .volumes[] .projected .sources[] .downwardAPI .items[] .fieldRef .fieldPath

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

.spec .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.
string required

.spec .volumes[] .projected .sources[] .downwardAPI .items[] .path

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ‘..’ path. Must be utf-8 encoded. The first item of the relative path must not start with ‘..’
object

.spec .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.
string

.spec .volumes[] .projected .sources[] .downwardAPI .items[] .resourceFieldRef .containerName

Container name: required for volumes, optional for env vars
integer | string

.spec .volumes[] .projected .sources[] .downwardAPI .items[] .resourceFieldRef .divisor

Specifies the output format of the exposed resources, defaults to “1”
string required

.spec .volumes[] .projected .sources[] .downwardAPI .items[] .resourceFieldRef .resource

Required: resource to select
object

.spec .volumes[] .projected .sources[] .secret

secret information about the secret data to project
array

.spec .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 ‘..’.
string required

.spec .volumes[] .projected .sources[] .secret .items[] .key

key is the key to project.
integer

.spec .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.
string required

.spec .volumes[] .projected .sources[] .secret .items[] .path

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

.spec .volumes[] .projected .sources[] .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .volumes[] .projected .sources[] .secret .optional

optional field specify whether the Secret or its key must be defined
object

.spec .volumes[] .projected .sources[] .serviceAccountToken

serviceAccountToken is information about the serviceAccountToken data to project
string

.spec .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.
integer

.spec .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.
string required

.spec .volumes[] .projected .sources[] .serviceAccountToken .path

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

.spec .volumes[] .quobyte

quobyte represents a Quobyte mount on the host that shares a pod’s lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
string

.spec .volumes[] .quobyte .group

group to map volume access to Default is no group
boolean

.spec .volumes[] .quobyte .readOnly

readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
string required

.spec .volumes[] .quobyte .registry

registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
string

.spec .volumes[] .quobyte .tenant

tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
string

.spec .volumes[] .quobyte .user

user to map volume access to Defaults to serivceaccount user
string required

.spec .volumes[] .quobyte .volume

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

.spec .volumes[] .rbd

rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md
string

.spec .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
string required

.spec .volumes[] .rbd .image

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

.spec .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 required

.spec .volumes[] .rbd .monitors

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

.spec .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
boolean

.spec .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
object

.spec .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
string

.spec .volumes[] .rbd .secretRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
string

.spec .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
object

.spec .volumes[] .scaleIO

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
string

.spec .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”.
string required

.spec .volumes[] .scaleIO .gateway

gateway is the host address of the ScaleIO API Gateway.
string

.spec .volumes[] .scaleIO .protectionDomain

protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
boolean

.spec .volumes[] .scaleIO .readOnly

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
object required

.spec .volumes[] .scaleIO .secretRef

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
string

.spec .volumes[] .scaleIO .secretRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .volumes[] .scaleIO .sslEnabled

sslEnabled Flag enable/disable SSL communication with Gateway, default false
string

.spec .volumes[] .scaleIO .storageMode

storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
string

.spec .volumes[] .scaleIO .storagePool

storagePool is the ScaleIO Storage Pool associated with the protection domain.
string required

.spec .volumes[] .scaleIO .system

system is the name of the storage system as configured in ScaleIO.
string

.spec .volumes[] .scaleIO .volumeName

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

.spec .volumes[] .secret

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
integer

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

.spec .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 ‘..’.
string required

.spec .volumes[] .secret .items[] .key

key is the key to project.
integer

.spec .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.
string required

.spec .volumes[] .secret .items[] .path

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

.spec .volumes[] .secret .optional

optional field specify whether the Secret or its keys must be defined
string

.spec .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
object

.spec .volumes[] .storageos

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
string

.spec .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.
boolean

.spec .volumes[] .storageos .readOnly

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
object

.spec .volumes[] .storageos .secretRef

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
string

.spec .volumes[] .storageos .secretRef .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
string

.spec .volumes[] .storageos .volumeName

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

.spec .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.
object

.spec .volumes[] .vsphereVolume

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.
string

.spec .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.
string

.spec .volumes[] .vsphereVolume .storagePolicyID

storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
string

.spec .volumes[] .vsphereVolume .storagePolicyName

storagePolicyName is the storage Policy Based Management (SPBM) profile name.
string required

.spec .volumes[] .vsphereVolume .volumePath

volumePath is the path that identifies vSphere volume vmdk
object

.spec .web

Defines the web command line flags when starting Alertmanager.
integer

.spec .web .getConcurrency

Maximum number of GET requests processed concurrently. This corresponds to the Alertmanager’s --web.get-concurrency flag.
object

.spec .web .httpConfig

Defines HTTP parameters for web server.
object

.spec .web .httpConfig .headers

List of headers that can be added to HTTP responses.
string

.spec .web .httpConfig .headers .contentSecurityPolicy

Set the Content-Security-Policy header to HTTP responses. Unset if blank.
string

.spec .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
string

.spec .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
string

.spec .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
string

.spec .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
boolean

.spec .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.
integer

.spec .web .timeout

Timeout for HTTP requests. This corresponds to the Alertmanager’s --web.timeout flag.
object

.spec .web .tlsConfig

Defines the TLS parameters for HTTPS.
object

.spec .web .tlsConfig .cert

Secret or ConfigMap containing the TLS certificate for the web server.

Either keySecret or keyFile must be defined.

It is mutually exclusive with certFile.
object

.spec .web .tlsConfig .cert .configMap

ConfigMap containing data to use for the targets.
string required

.spec .web .tlsConfig .cert .configMap .key

The key to select.
string

.spec .web .tlsConfig .cert .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .web .tlsConfig .cert .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .web .tlsConfig .cert .secret

Secret containing data to use for the targets.
string required

.spec .web .tlsConfig .cert .secret .key

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

.spec .web .tlsConfig .cert .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .web .tlsConfig .cert .secret .optional

Specify whether the Secret or its key must be defined
string

.spec .web .tlsConfig .certFile

Path to the TLS certificate file in the container for the web server.

Either keySecret or keyFile must be defined.

It is mutually exclusive with cert.
array

.spec .web .tlsConfig .cipherSuites

List of supported cipher suites for TLS versions up to TLS 1.2.

If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants
object

.spec .web .tlsConfig .client_ca

Secret or ConfigMap containing the CA certificate for client certificate authentication to the server.

It is mutually exclusive with clientCAFile.
object

.spec .web .tlsConfig .client_ca .configMap

ConfigMap containing data to use for the targets.
string required

.spec .web .tlsConfig .client_ca .configMap .key

The key to select.
string

.spec .web .tlsConfig .client_ca .configMap .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .web .tlsConfig .client_ca .configMap .optional

Specify whether the ConfigMap or its key must be defined
object

.spec .web .tlsConfig .client_ca .secret

Secret containing data to use for the targets.
string required

.spec .web .tlsConfig .client_ca .secret .key

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

.spec .web .tlsConfig .client_ca .secret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .web .tlsConfig .client_ca .secret .optional

Specify whether the Secret or its key must be defined
string

.spec .web .tlsConfig .clientAuthType

The server policy for client TLS authentication.

For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType
string

.spec .web .tlsConfig .clientCAFile

Path to the CA certificate file for client certificate authentication to the server.

It is mutually exclusive with client_ca.
array

.spec .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
string

.spec .web .tlsConfig .keyFile

Path to the TLS private key file in the container for the web server.

If defined, either cert or certFile must be defined.

It is mutually exclusive with keySecret.
object

.spec .web .tlsConfig .keySecret

Secret containing the TLS private key for the web server.

Either cert or certFile must be defined.

It is mutually exclusive with keyFile.
string required

.spec .web .tlsConfig .keySecret .key

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

.spec .web .tlsConfig .keySecret .name

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
boolean

.spec .web .tlsConfig .keySecret .optional

Specify whether the Secret or its key must be defined
string

.spec .web .tlsConfig .maxVersion

Maximum TLS version that is acceptable.
string

.spec .web .tlsConfig .minVersion

Minimum TLS version that is acceptable.
boolean

.spec .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.
object

.status

Most recent observed status of the Alertmanager cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
integer required

.status .availableReplicas

Total number of available pods (ready for at least minReadySeconds) targeted by this Alertmanager cluster.
array

.status .conditions

The current state of the Alertmanager object.
string required

.status .conditions[] .lastTransitionTime

lastTransitionTime is the time of the last update to the current status property.
string

.status .conditions[] .message

Human-readable message indicating details for the condition’s last transition.
integer

.status .conditions[] .observedGeneration

ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
string

.status .conditions[] .reason

Reason for the condition’s last transition.
string required

.status .conditions[] .status

Status of the condition.
string required

.status .conditions[] .type

Type of the condition being reported.
boolean required

.status .paused

Represents whether any actions on the underlying managed objects are being performed. Only delete actions will be performed.
integer required

.status .replicas

Total number of non-terminated pods targeted by this Alertmanager object (their labels match the selector).
string

.status .selector

The selector used to match the pods targeted by this Alertmanager object.
integer required

.status .unavailableReplicas

Total number of unavailable pods targeted by this Alertmanager object.
integer required

.status .updatedReplicas

Total number of non-terminated pods targeted by this Alertmanager object that have the desired version spec.