Monitoring APIs


OpenShift Container Platform 4.21

Reference guide for monitoring APIs

Red Hat OpenShift Documentation Team

Abstract

This document describes the OpenShift Container Platform monitoring API objects and their detailed specifications.

Chapter 1. Monitoring APIs

1.1. Alertmanager [monitoring.coreos.com/v1]

Description

The Alertmanager custom resource definition (CRD) defines a desired [Alertmanager](https://prometheus.io/docs/alerting) setup to run in a Kubernetes cluster. It allows to specify many options such as the number of replicas, persistent storage and many more.

For each Alertmanager resource, the Operator deploys a StatefulSet in the same namespace. When there are two or more configured replicas, the Operator runs the Alertmanager instances in high-availability mode.

The resource defines via label and namespace selectors which AlertmanagerConfig objects should be associated to the deployed Alertmanager instances.

Type
object
Description

The AlertmanagerConfig custom resource definition (CRD) defines how Alertmanager objects process Prometheus alerts. It allows to specify alert grouping and routing, notification receivers and inhibition rules.

Alertmanager objects select AlertmanagerConfig objects using label and namespace selectors.

Type
object
Description

AlertRelabelConfig defines a set of relabel configs for alerts.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
object

1.4. AlertingRule [monitoring.openshift.io/v1]

Description

AlertingRule represents a set of user-defined Prometheus rule groups containing alerting rules. This resource is the supported method for cluster admins to create alerts based on metrics recorded by the platform monitoring stack in OpenShift, i.e. the Prometheus instance deployed to the openshift-monitoring namespace. You might use this to create custom alerting rules not shipped with OpenShift based on metrics from components such as the node_exporter, which provides machine-level metrics such as CPU usage, or kube-state-metrics, which provides metrics on Kubernetes usage.

The API is mostly compatible with the upstream PrometheusRule type from the prometheus-operator. The primary difference being that recording rules are not allowed here — only alerting rules. For each AlertingRule resource created, a corresponding PrometheusRule will be created in the openshift-monitoring namespace. OpenShift requires admins to use the AlertingRule resource rather than the upstream type in order to allow better OpenShift specific defaulting and validation, while not modifying the upstream APIs directly.

You can find upstream API documentation for PrometheusRule resources here:

https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
object

1.5. DataGather [insights.openshift.io/v1alpha2]

Description

DataGather provides data gather configuration options and status for the particular Insights data gathering.

Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.

Type
object

1.6. PodMonitor [monitoring.coreos.com/v1]

Description

The PodMonitor custom resource definition (CRD) defines how Prometheus and PrometheusAgent can scrape metrics from a group of pods. Among other things, it allows to specify: * The pods to scrape via label selectors. * The container ports to scrape. * Authentication credentials to use. * Target and metric relabeling.

Prometheus and PrometheusAgent objects select PodMonitor objects using label and namespace selectors.

Type
object

1.7. Probe [monitoring.coreos.com/v1]

Description

The Probe custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).

The Probe resource needs 2 pieces of information: * The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects. * The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, …​) as Prometheus metrics.

Prometheus and PrometheusAgent objects select Probe objects using label and namespace selectors.

Type
object

1.8. Prometheus [monitoring.coreos.com/v1]

Description

The Prometheus custom resource definition (CRD) defines a desired [Prometheus](https://prometheus.io/docs/prometheus) setup to run in a Kubernetes cluster. It allows to specify many options such as the number of replicas, persistent storage, and Alertmanagers where firing alerts should be sent and many more.

For each Prometheus resource, the Operator deploys one or several StatefulSet objects in the same namespace. The number of StatefulSets is equal to the number of shards which is 1 by default.

The resource defines via label and namespace selectors which ServiceMonitor, PodMonitor, Probe and PrometheusRule objects should be associated to the deployed Prometheus instances.

The Operator continuously reconciles the scrape and rules configuration and a sidecar container running in the Prometheus pods triggers a reload of the configuration when needed.

Type
object

1.9. PrometheusRule [monitoring.coreos.com/v1]

Description

The PrometheusRule custom resource definition (CRD) defines [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) and [recording](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/) rules to be evaluated by Prometheus or ThanosRuler objects.

Prometheus and ThanosRuler objects select PrometheusRule objects using label and namespace selectors.

Type
object

1.10. ServiceMonitor [monitoring.coreos.com/v1]

Description

The ServiceMonitor custom resource definition (CRD) defines how Prometheus and PrometheusAgent can scrape metrics from a group of services. Among other things, it allows to specify: * The services to scrape via label selectors. * The container ports to scrape. * Authentication credentials to use. * Target and metric relabeling.

Prometheus and PrometheusAgent objects select ServiceMonitor objects using label and namespace selectors.

Type
object

1.11. ThanosRuler [monitoring.coreos.com/v1]

Description

The ThanosRuler custom resource definition (CRD) defines a desired [Thanos Ruler](https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md) setup to run in a Kubernetes cluster.

A ThanosRuler instance requires at least one compatible Prometheus API endpoint (either Thanos Querier or Prometheus services).

The resource defines via label and namespace selectors which PrometheusRule objects should be associated to the deployed Thanos Ruler instances.

Type
object

1.12. NodeMetrics [metrics.k8s.io/v1beta1]

Description
NodeMetrics sets resource usage metrics of a node.
Type
object

1.13. PodMetrics [metrics.k8s.io/v1beta1]

Description
PodMetrics sets resource usage metrics of a pod.
Type
object
Description

The Alertmanager custom resource definition (CRD) defines a desired [Alertmanager](https://prometheus.io/docs/alerting) setup to run in a Kubernetes cluster. It allows to specify many options such as the number of replicas, persistent storage and many more.

For each Alertmanager resource, the Operator deploys a StatefulSet in the same namespace. When there are two or more configured replicas, the Operator runs the Alertmanager instances in high-availability mode.

The resource defines via label and namespace selectors which AlertmanagerConfig objects should be associated to the deployed Alertmanager instances.

Type
object
Required
  • spec

2.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

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

kind

string

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

metadata

ObjectMeta

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

spec

object

spec defines the 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

status

object

status defines the 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

2.1.1. .spec

Description
spec defines the 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
Type
object
Expand
PropertyTypeDescription

additionalArgs

array

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.

additionalArgs[]

object

Argument as part of the AdditionalArgs list.

additionalPeers

array (string)

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

affinity

object

affinity defines the pod’s scheduling constraints.

alertmanagerConfigMatcherStrategy

object

alertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects process incoming alerts.

alertmanagerConfigNamespaceSelector

object

alertmanagerConfigNamespaceSelector defines the namespaces to be selected for AlertmanagerConfig discovery. If nil, only check own namespace.

alertmanagerConfigSelector

object

alertmanagerConfigSelector defines the selector to be used for to merge and configure Alertmanager with.

alertmanagerConfiguration

object

alertmanagerConfiguration defines 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.

automountServiceAccountToken

boolean

automountServiceAccountToken defines 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.

baseImage

string

baseImage that is used to deploy pods, without tag. Deprecated: use 'image' instead.

clusterAdvertiseAddress

string

clusterAdvertiseAddress defines 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

clusterGossipInterval

string

clusterGossipInterval defines the interval between gossip attempts.

clusterLabel

string

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.

clusterPeerTimeout

string

clusterPeerTimeout defines the timeout for cluster peering.

clusterPushpullInterval

string

clusterPushpullInterval defines the interval between pushpull attempts.

clusterTLS

object

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

It requires Alertmanager >= 0.24.0.

configMaps

array (string)

configMaps defines 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.

configSecret

string

configSecret defines 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).

containers

array

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.

containers[]

object

A single application container that you want to run within a pod.

dnsConfig

object

dnsConfig defines the DNS configuration for the pods.

dnsPolicy

string

dnsPolicy defines the DNS policy for the pods.

enableFeatures

array (string)

enableFeatures defines the Alertmanager’s 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.

enableServiceLinks

boolean

enableServiceLinks defines whether information about services should be injected into pod’s environment variables

externalUrl

string

externalUrl defines the URL used to access the Alertmanager web service. This is necessary to generate correct URLs. This is necessary if Alertmanager is not served from root of a DNS name.

forceEnableClusterMode

boolean

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.

hostAliases

array

hostAliases Pods configuration

hostAliases[]

object

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.

hostUsers

boolean

hostUsers supports the user space in Kubernetes.

More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/

The feature requires at least Kubernetes 1.28 with the UserNamespacesSupport feature gate enabled. Starting Kubernetes 1.33, the feature is enabled by default.

image

string

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.

imagePullPolicy

string

imagePullPolicy for the 'alertmanager', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.

imagePullSecrets

array

imagePullSecrets An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/

imagePullSecrets[]

object

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

initContainers

array

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.

initContainers[]

object

A single application container that you want to run within a pod.

limits

object

limits defines the limits command line flags when starting Alertmanager.

listenLocal

boolean

listenLocal defines 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.

logFormat

string

logFormat for Alertmanager to be configured with.

logLevel

string

logLevel for Alertmanager to be configured with.

minReadySeconds

integer

minReadySeconds defines the 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.

If unset, pods will be considered available as soon as they are ready.

nodeSelector

object (string)

nodeSelector defines which Nodes the Pods are scheduled on.

paused

boolean

paused if set to true all actions on the underlying managed objects are not going to be performed, except for delete actions.

persistentVolumeClaimRetentionPolicy

object

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

podMetadata

object

podMetadata defines 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".

portName

string

portName defines the port’s name for the pods and governing service. Defaults to web.

priorityClassName

string

priorityClassName assigned to the Pods

replicas

integer

replicas defines the expected size of the alertmanager cluster. The controller will eventually make the size of the running cluster equal to the expected size.

resources

object

resources defines the resource requests and limits of the Pods.

retention

string

retention defines the 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).

routePrefix

string

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

secrets

array (string)

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.

securityContext

object

securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.

serviceAccountName

string

serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.

serviceName

string

serviceName defines 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 Alertmanager 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.

sha

string

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.

storage

object

storage defines the definition of how storage will be used by the Alertmanager instances.

tag

string

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.

terminationGracePeriodSeconds

integer

terminationGracePeriodSeconds defines the 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.

tolerations

array

tolerations defines the pod’s tolerations.

tolerations[]

object

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

topologySpreadConstraints

array

topologySpreadConstraints defines the Pod’s topology spread constraints.

topologySpreadConstraints[]

object

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

version

string

version the cluster should be on.

volumeMounts

array

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.

volumeMounts[]

object

VolumeMount describes a mounting of a Volume within a container.

volumes

array

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.

volumes[]

object

Volume represents a named volume in a pod that may be accessed by any container in the pod.

web

object

web defines the web command line flags when starting Alertmanager.

2.1.2. .spec.additionalArgs

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

2.1.3. .spec.additionalArgs[]

Description
Argument as part of the AdditionalArgs list.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name of the argument, e.g. "scrape.discovery-reload-interval".

value

string

value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)

2.1.4. .spec.affinity

Description
affinity defines the pod’s scheduling constraints.
Type
object
Expand
PropertyTypeDescription

nodeAffinity

object

Describes node affinity scheduling rules for the pod.

podAffinity

object

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

podAntiAffinity

object

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

2.1.5. .spec.affinity.nodeAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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.

preferredDuringSchedulingIgnoredDuringExecution[]

object

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

requiredDuringSchedulingIgnoredDuringExecution

object

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.

Description
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
Type
array
Description
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Type
object
Required
  • preference
  • weight
Expand
PropertyTypeDescription

preference

object

A node selector term, associated with the corresponding weight.

weight

integer

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

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

matchExpressions

array

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

matchExpressions[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchFields

array

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

matchFields[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Description
A list of node selector requirements by node’s labels.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

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

values

array (string)

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.

Description
A list of node selector requirements by node’s fields.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

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

values

array (string)

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.

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

nodeSelectorTerms

array

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

nodeSelectorTerms[]

object

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Description
Required. A list of node selector terms. The terms are ORed.
Type
array
Description
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchFields

array

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

matchFields[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Description
A list of node selector requirements by node’s labels.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

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

values

array (string)

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.

Description
A list of node selector requirements by node’s fields.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

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

values

array (string)

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.

2.1.20. .spec.affinity.podAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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.

preferredDuringSchedulingIgnoredDuringExecution[]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

requiredDuringSchedulingIgnoredDuringExecution

array

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.

requiredDuringSchedulingIgnoredDuringExecution[]

object

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

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

podAffinityTerm

object

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

weight

integer

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

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

labelSelector

object

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

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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

topologyKey

string

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.

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

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

Description
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Type
array
Description
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
Type
object
Required
  • topologyKey
Expand
PropertyTypeDescription

labelSelector

object

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

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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

topologyKey

string

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.

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

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

2.1.38. .spec.affinity.podAntiAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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 subtracting "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

preferredDuringSchedulingIgnoredDuringExecution[]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

requiredDuringSchedulingIgnoredDuringExecution

array

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.

requiredDuringSchedulingIgnoredDuringExecution[]

object

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

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

podAffinityTerm

object

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

weight

integer

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

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

labelSelector

object

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

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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

topologyKey

string

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.

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

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

Description
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Type
array
Description
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
Type
object
Required
  • topologyKey
Expand
PropertyTypeDescription

labelSelector

object

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

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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

topologyKey

string

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.

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

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

2.1.56. .spec.alertmanagerConfigMatcherStrategy

Description
alertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects process incoming alerts.
Type
object
Expand
PropertyTypeDescription

type

string

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

The default value is OnNamespace.

2.1.57. .spec.alertmanagerConfigNamespaceSelector

Description
alertmanagerConfigNamespaceSelector defines the namespaces to be selected for AlertmanagerConfig discovery. If nil, only check own namespace.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

2.1.60. .spec.alertmanagerConfigSelector

Description
alertmanagerConfigSelector defines the selector to be used for to merge and configure Alertmanager with.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

2.1.63. .spec.alertmanagerConfiguration

Description

alertmanagerConfiguration defines 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.

Type
object
Expand
PropertyTypeDescription

global

object

global defines the global parameters of the Alertmanager configuration.

name

string

name defines the name of the AlertmanagerConfig custom 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.

templates

array

templates defines the custom notification templates.

templates[]

object

SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive.

2.1.64. .spec.alertmanagerConfiguration.global

Description
global defines the global parameters of the Alertmanager configuration.
Type
object
Expand
PropertyTypeDescription

httpConfig

object

httpConfig defines the default HTTP configuration.

jira

object

jira defines the default configuration for Jira.

opsGenieApiKey

object

opsGenieApiKey defines the default OpsGenie API Key.

opsGenieApiUrl

object

opsGenieApiUrl defines the default OpsGenie API URL.

pagerdutyUrl

string

pagerdutyUrl defines the default Pagerduty URL.

resolveTimeout

string

resolveTimeout defines 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.

rocketChat

object

rocketChat defines the default configuration for Rocket Chat.

slackApiUrl

object

slackApiUrl defines the default Slack API URL.

smtp

object

smtp defines global SMTP parameters.

telegram

object

telegram defines the default Telegram config

victorops

object

victorops defines the default configuration for VictorOps.

webex

object

webex defines the default configuration for Jira.

wechat

object

wechat defines the default WeChat Config

Description
httpConfig defines the default HTTP configuration.
Type
object
Expand
PropertyTypeDescription

authorization

object

authorization configures the Authorization header credentials used by the client.

Cannot be set at the same time as basicAuth, bearerTokenSecret or oauth2.

basicAuth

object

basicAuth defines the Basic Authentication credentials used by the client.

Cannot be set at the same time as authorization, bearerTokenSecret or oauth2.

bearerTokenSecret

object

bearerTokenSecret defines a key of a Secret containing the bearer token used by the client for authentication. The secret needs to be in the same namespace as the custom resource and readable by the Prometheus Operator.

Cannot be set at the same time as authorization, basicAuth or oauth2.

Deprecated: use authorization instead.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether the client should follow HTTP 3xx redirects.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 settings used by the client.

It requires Prometheus >= 2.27.0.

Cannot be set at the same time as authorization, basicAuth or bearerTokenSecret.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration used by the client.

Description

authorization configures the Authorization header credentials used by the client.

Cannot be set at the same time as basicAuth, bearerTokenSecret or oauth2.

Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

basicAuth defines the Basic Authentication credentials used by the client.

Cannot be set at the same time as authorization, bearerTokenSecret or oauth2.

Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

bearerTokenSecret defines a key of a Secret containing the bearer token used by the client for authentication. The secret needs to be in the same namespace as the custom resource and readable by the Prometheus Operator.

Cannot be set at the same time as authorization, basicAuth or oauth2.

Deprecated: use authorization instead.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

oauth2 defines the OAuth2 settings used by the client.

It requires Prometheus >= 2.27.0.

Cannot be set at the same time as authorization, basicAuth or bearerTokenSecret.

Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration used by the client.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
jira defines the default configuration for Jira.
Type
object
Expand
PropertyTypeDescription

apiURL

string

apiURL defines the default Jira API URL.

It requires Alertmanager >= v0.28.0.

Description
opsGenieApiKey defines the default OpsGenie API Key.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
opsGenieApiUrl defines the default OpsGenie API URL.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
rocketChat defines the default configuration for Rocket Chat.
Type
object
Expand
PropertyTypeDescription

apiURL

string

apiURL defines the default Rocket Chat API URL.

It requires Alertmanager >= v0.28.0.

token

object

token defines the default Rocket Chat token.

It requires Alertmanager >= v0.28.0.

tokenID

object

tokenID defines the default Rocket Chat Token ID.

It requires Alertmanager >= v0.28.0.

Description

token defines the default Rocket Chat token.

It requires Alertmanager >= v0.28.0.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

tokenID defines the default Rocket Chat Token ID.

It requires Alertmanager >= v0.28.0.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
slackApiUrl defines the default Slack API URL.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
smtp defines global SMTP parameters.
Type
object
Expand
PropertyTypeDescription

authIdentity

string

authIdentity represents SMTP Auth using PLAIN

authPassword

object

authPassword represents SMTP Auth using LOGIN and PLAIN.

authSecret

object

authSecret represents SMTP Auth using CRAM-MD5.

authUsername

string

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

from

string

from defines the default SMTP From header field.

hello

string

hello defines the default hostname to identify to the SMTP server.

requireTLS

boolean

requireTLS defines the default SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.

smartHost

object

smartHost defines the default SMTP smarthost used for sending emails.

tlsConfig

object

tlsConfig defines the default TLS configuration for SMTP receivers

Description
authPassword represents SMTP Auth using LOGIN and PLAIN.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
authSecret represents SMTP Auth using CRAM-MD5.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
smartHost defines the default SMTP smarthost used for sending emails.
Type
object
Required
  • host
  • port
Expand
PropertyTypeDescription

host

string

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

port

string

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

Description
tlsConfig defines the default TLS configuration for SMTP receivers
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
telegram defines the default Telegram config
Type
object
Expand
PropertyTypeDescription

apiURL

string

apiURL defines he default Telegram API URL.

It requires Alertmanager >= v0.24.0.

Description
victorops defines the default configuration for VictorOps.
Type
object
Expand
PropertyTypeDescription

apiKey

object

apiKey defines the default VictorOps API Key.

apiURL

string

apiURL defines the default VictorOps API URL.

Description
apiKey defines the default VictorOps API Key.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
webex defines the default configuration for Jira.
Type
object
Expand
PropertyTypeDescription

apiURL

string

apiURL defines the is the default Webex API URL.

It requires Alertmanager >= v0.25.0.

Description
wechat defines the default WeChat Config
Type
object
Expand
PropertyTypeDescription

apiCorpID

string

apiCorpID defines the default WeChat API Corporate ID.

apiSecret

object

apiSecret defines the default WeChat API Secret.

apiURL

string

apiURL defines he default WeChat API URL. The default value is "https://qyapi.weixin.qq.com/cgi-bin/"

Description
apiSecret defines the default WeChat API Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.124. .spec.alertmanagerConfiguration.templates

Description
templates defines the custom notification templates.
Type
array
Description
SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.128. .spec.clusterTLS

Description

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

It requires Alertmanager >= 0.24.0.

Type
object
Required
  • client
  • server
Expand
PropertyTypeDescription

client

object

client defines the client-side configuration for mutual TLS.

server

object

server defines the server-side configuration for mutual TLS.

2.1.129. .spec.clusterTLS.client

Description
client defines the client-side configuration for mutual TLS.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

2.1.130. .spec.clusterTLS.client.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

2.1.131. .spec.clusterTLS.client.ca.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

2.1.132. .spec.clusterTLS.client.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.133. .spec.clusterTLS.client.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

2.1.134. .spec.clusterTLS.client.cert.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

2.1.135. .spec.clusterTLS.client.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.136. .spec.clusterTLS.client.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.137. .spec.clusterTLS.server

Description
server defines the server-side configuration for mutual TLS.
Type
object
Expand
PropertyTypeDescription

cert

object

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

Either keySecret or keyFile must be defined.

It is mutually exclusive with certFile.

certFile

string

certFile defines the 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.

cipherSuites

array (string)

cipherSuites defines the 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

clientAuthType

string

clientAuthType defines the server policy for client TLS authentication.

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

clientCAFile

string

clientCAFile defines the path to the CA certificate file for client certificate authentication to the server.

It is mutually exclusive with client_ca.

client_ca

object

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

It is mutually exclusive with clientCAFile.

curvePreferences

array (string)

curvePreferences defines 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

keyFile

string

keyFile defines the 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.

keySecret

object

keySecret defines the secret containing the TLS private key for the web server.

Either cert or certFile must be defined.

It is mutually exclusive with keyFile.

maxVersion

string

maxVersion defines the Maximum TLS version that is acceptable.

minVersion

string

minVersion defines the minimum TLS version that is acceptable.

preferServerCipherSuites

boolean

preferServerCipherSuites defines 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.

2.1.138. .spec.clusterTLS.server.cert

Description

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

Either keySecret or keyFile must be defined.

It is mutually exclusive with certFile.

Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

2.1.139. .spec.clusterTLS.server.cert.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

2.1.140. .spec.clusterTLS.server.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.141. .spec.clusterTLS.server.client_ca

Description

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

It is mutually exclusive with clientCAFile.

Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

2.1.143. .spec.clusterTLS.server.client_ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.144. .spec.clusterTLS.server.keySecret

Description

keySecret defines the secret containing the TLS private key for the web server.

Either cert or certFile must be defined.

It is mutually exclusive with keyFile.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.145. .spec.containers

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

2.1.146. .spec.containers[]

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

args

array (string)

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

command

array (string)

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

env

array

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

env[]

object

EnvVar represents an environment variable present in a Container.

envFrom

array

List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. 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.

envFrom[]

object

EnvFromSource represents the source of a set of ConfigMaps or Secrets

image

string

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.

imagePullPolicy

string

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

object

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

livenessProbe

object

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

name

string

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

ports

array

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.

ports[]

object

ContainerPort represents a network port in a single container.

readinessProbe

object

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

resizePolicy

array

Resources resize policy for the container.

resizePolicy[]

object

ContainerResizePolicy represents resource resize policy for the container.

resources

object

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

restartPolicy

string

RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Additionally, 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.

restartPolicyRules

array

Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.

restartPolicyRules[]

object

ContainerRestartRule describes how a container exit is handled.

securityContext

object

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

startupProbe

object

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

stdin

boolean

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.

stdinOnce

boolean

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

terminationMessagePath

string

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.

terminationMessagePolicy

string

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.

tty

boolean

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

volumeDevices

array

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

volumeDevices[]

object

volumeDevice describes a mapping of a raw block device within a container.

volumeMounts

array

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

volumeMounts[]

object

VolumeMount describes a mounting of a Volume within a container.

workingDir

string

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.

2.1.147. .spec.containers[].env

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

2.1.148. .spec.containers[].env[]

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

name

string

Name of the environment variable. May consist of any printable ASCII characters except '='.

value

string

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

valueFrom

object

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

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

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

configMapKeyRef

object

Selects a key of a ConfigMap.

fieldRef

object

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.

fileKeyRef

object

FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.

resourceFieldRef

object

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.

secretKeyRef

object

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

Description
Selects a key of a ConfigMap.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

apiVersion

string

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

fieldPath

string

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

Description
FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
Type
object
Required
  • key
  • path
  • volumeName
Expand
PropertyTypeDescription

key

string

The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

optional

boolean

Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod’s containers.

If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.

path

string

The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.

volumeName

string

The name of the volume mount containing the env file.

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

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

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

resource

string

Required: resource to select

Description
Selects a key of a secret in the pod’s namespace
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.155. .spec.containers[].envFrom

Description
List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
Type
array

2.1.156. .spec.containers[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps or Secrets
Type
object
Expand
PropertyTypeDescription

configMapRef

object

The ConfigMap to select from

prefix

string

Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.

secretRef

object

The Secret to select from

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

Description
The ConfigMap to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the ConfigMap must be defined

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

Description
The Secret to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the Secret must be defined

2.1.159. .spec.containers[].lifecycle

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

postStart

object

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

preStop

object

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

stopSignal

string

StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name

2.1.160. .spec.containers[].lifecycle.postStart

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

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

httpHeaders

array

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

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

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

scheme

string

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

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

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

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

port

integer-or-string

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.

2.1.167. .spec.containers[].lifecycle.preStop

Description
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

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

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

httpHeaders

array

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

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

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

scheme

string

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

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

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

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

port

integer-or-string

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.

2.1.174. .spec.containers[].livenessProbe

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

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

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

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

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

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

2.1.175. .spec.containers[].livenessProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

2.1.176. .spec.containers[].livenessProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

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

service

string

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.

2.1.177. .spec.containers[].livenessProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

httpHeaders

array

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

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

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

scheme

string

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

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

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

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

port

integer-or-string

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.

2.1.181. .spec.containers[].ports

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

2.1.182. .spec.containers[].ports[]

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

containerPort

integer

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

hostIP

string

What host IP to bind the external port to.

hostPort

integer

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.

name

string

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

protocol

string

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

2.1.183. .spec.containers[].readinessProbe

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

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

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

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

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

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

2.1.184. .spec.containers[].readinessProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

2.1.185. .spec.containers[].readinessProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

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

service

string

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.

2.1.186. .spec.containers[].readinessProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

httpHeaders

array

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

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

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

scheme

string

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

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

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

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

port

integer-or-string

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.

2.1.190. .spec.containers[].resizePolicy

Description
Resources resize policy for the container.
Type
array

2.1.191. .spec.containers[].resizePolicy[]

Description
ContainerResizePolicy represents resource resize policy for the container.
Type
object
Required
  • resourceName
  • restartPolicy
Expand
PropertyTypeDescription

resourceName

string

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

restartPolicy

string

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

2.1.192. .spec.containers[].resources

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

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

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

requests

integer-or-string

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/

2.1.193. .spec.containers[].resources.claims

Description

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Type
array

2.1.194. .spec.containers[].resources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

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.

request

string

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.

2.1.195. .spec.containers[].restartPolicyRules

Description
Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.
Type
array

2.1.196. .spec.containers[].restartPolicyRules[]

Description
ContainerRestartRule describes how a container exit is handled.
Type
object
Required
  • action
Expand
PropertyTypeDescription

action

string

Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container.

exitCodes

object

Represents the exit codes to check on container exits.

Description
Represents the exit codes to check on container exits.
Type
object
Required
  • operator
Expand
PropertyTypeDescription

operator

string

Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values. - NotIn: the requirement is satisfied if the container exit code is not in the set of specified values.

values

array (integer)

Specifies the set of values to check for container exit codes. At most 255 elements are allowed.

2.1.198. .spec.containers[].securityContext

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

allowPrivilegeEscalation

boolean

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.

appArmorProfile

object

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.

capabilities

object

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.

privileged

boolean

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.

procMount

string

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.

readOnlyRootFilesystem

boolean

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.

runAsGroup

integer

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.

runAsNonRoot

boolean

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.

runAsUser

integer

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.

seLinuxOptions

object

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.

seccompProfile

object

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.

windowsOptions

object

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.

Description
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.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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

type

string

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.

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

add

array (string)

Added capabilities

drop

array (string)

Removed capabilities

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Type
object
Expand
PropertyTypeDescription

level

string

Level is SELinux level label that applies to the container.

role

string

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

type

string

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

user

string

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

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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.

type

string

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.

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
Expand
PropertyTypeDescription

gmsaCredentialSpec

string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName

string

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

hostProcess

boolean

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.

runAsUserName

string

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.

2.1.204. .spec.containers[].startupProbe

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

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

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

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

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

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

2.1.205. .spec.containers[].startupProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

2.1.206. .spec.containers[].startupProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

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

service

string

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.

2.1.207. .spec.containers[].startupProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

httpHeaders

array

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

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

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

scheme

string

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

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

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

value

string

The header field value

2.1.210. .spec.containers[].startupProbe.tcpSocket

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

port

integer-or-string

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.

2.1.211. .spec.containers[].volumeDevices

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

2.1.212. .spec.containers[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
  • devicePath
  • name
Expand
PropertyTypeDescription

devicePath

string

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

name

string

name must match the name of a persistentVolumeClaim in the pod

2.1.213. .spec.containers[].volumeMounts

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

2.1.214. .spec.containers[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
  • mountPath
  • name
Expand
PropertyTypeDescription

mountPath

string

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

mountPropagation

string

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

name

string

This must match the Name of a Volume.

readOnly

boolean

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

recursiveReadOnly

string

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.

subPath

string

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

subPathExpr

string

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.

2.1.215. .spec.dnsConfig

Description
dnsConfig defines the DNS configuration for the pods.
Type
object
Expand
PropertyTypeDescription

nameservers

array (string)

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

options

array

options defines the 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.

options[]

object

PodDNSConfigOption defines DNS resolver options of a pod.

searches

array (string)

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

2.1.216. .spec.dnsConfig.options

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

2.1.217. .spec.dnsConfig.options[]

Description
PodDNSConfigOption defines DNS resolver options of a pod.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name is required and must be unique.

value

string

value is optional.

2.1.218. .spec.hostAliases

Description
hostAliases Pods configuration
Type
array

2.1.219. .spec.hostAliases[]

Description
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
Type
object
Required
  • hostnames
  • ip
Expand
PropertyTypeDescription

hostnames

array (string)

hostnames defines hostnames for the above IP address.

ip

string

ip defines the IP address of the host file entry.

2.1.220. .spec.imagePullSecrets

Description
imagePullSecrets An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
Type
array

2.1.221. .spec.imagePullSecrets[]

Description
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Type
object
Expand
PropertyTypeDescription

name

string

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

2.1.222. .spec.initContainers

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

2.1.223. .spec.initContainers[]

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

args

array (string)

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

command

array (string)

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

env

array

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

env[]

object

EnvVar represents an environment variable present in a Container.

envFrom

array

List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. 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.

envFrom[]

object

EnvFromSource represents the source of a set of ConfigMaps or Secrets

image

string

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.

imagePullPolicy

string

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

object

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

livenessProbe

object

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

name

string

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

ports

array

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.

ports[]

object

ContainerPort represents a network port in a single container.

readinessProbe

object

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

resizePolicy

array

Resources resize policy for the container.

resizePolicy[]

object

ContainerResizePolicy represents resource resize policy for the container.

resources

object

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

restartPolicy

string

RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Additionally, 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.

restartPolicyRules

array

Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.

restartPolicyRules[]

object

ContainerRestartRule describes how a container exit is handled.

securityContext

object

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

startupProbe

object

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

stdin

boolean

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.

stdinOnce

boolean

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

terminationMessagePath

string

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.

terminationMessagePolicy

string

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.

tty

boolean

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

volumeDevices

array

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

volumeDevices[]

object

volumeDevice describes a mapping of a raw block device within a container.

volumeMounts

array

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

volumeMounts[]

object

VolumeMount describes a mounting of a Volume within a container.

workingDir

string

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.

2.1.224. .spec.initContainers[].env

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

2.1.225. .spec.initContainers[].env[]

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

name

string

Name of the environment variable. May consist of any printable ASCII characters except '='.

value

string

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

valueFrom

object

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

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

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

configMapKeyRef

object

Selects a key of a ConfigMap.

fieldRef

object

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.

fileKeyRef

object

FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.

resourceFieldRef

object

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.

secretKeyRef

object

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

Description
Selects a key of a ConfigMap.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

apiVersion

string

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

fieldPath

string

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

Description
FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
Type
object
Required
  • key
  • path
  • volumeName
Expand
PropertyTypeDescription

key

string

The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

optional

boolean

Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod’s containers.

If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.

path

string

The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.

volumeName

string

The name of the volume mount containing the env file.

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

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

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

resource

string

Required: resource to select

Description
Selects a key of a secret in the pod’s namespace
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.232. .spec.initContainers[].envFrom

Description
List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
Type
array

2.1.233. .spec.initContainers[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps or Secrets
Type
object
Expand
PropertyTypeDescription

configMapRef

object

The ConfigMap to select from

prefix

string

Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.

secretRef

object

The Secret to select from

Description
The ConfigMap to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the ConfigMap must be defined

Description
The Secret to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the Secret must be defined

2.1.236. .spec.initContainers[].lifecycle

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

postStart

object

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

preStop

object

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

stopSignal

string

StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name

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

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

httpHeaders

array

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

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

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

scheme

string

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

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

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

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

port

integer-or-string

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.

2.1.244. .spec.initContainers[].lifecycle.preStop

Description
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

httpHeaders

array

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

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

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

scheme

string

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

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

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

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

port

integer-or-string

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.

2.1.251. .spec.initContainers[].livenessProbe

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

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

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

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

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

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

2.1.252. .spec.initContainers[].livenessProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

2.1.253. .spec.initContainers[].livenessProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

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

service

string

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

httpHeaders

array

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

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

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

scheme

string

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

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

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

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

port

integer-or-string

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.

2.1.258. .spec.initContainers[].ports

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

2.1.259. .spec.initContainers[].ports[]

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

containerPort

integer

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

hostIP

string

What host IP to bind the external port to.

hostPort

integer

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.

name

string

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

protocol

string

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

2.1.260. .spec.initContainers[].readinessProbe

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

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

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

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

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

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

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

service

string

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

httpHeaders

array

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

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

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

scheme

string

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

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

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

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

port

integer-or-string

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.

2.1.267. .spec.initContainers[].resizePolicy

Description
Resources resize policy for the container.
Type
array

2.1.268. .spec.initContainers[].resizePolicy[]

Description
ContainerResizePolicy represents resource resize policy for the container.
Type
object
Required
  • resourceName
  • restartPolicy
Expand
PropertyTypeDescription

resourceName

string

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

restartPolicy

string

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

2.1.269. .spec.initContainers[].resources

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

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

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

requests

integer-or-string

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/

2.1.270. .spec.initContainers[].resources.claims

Description

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Type
array

2.1.271. .spec.initContainers[].resources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

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.

request

string

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.

2.1.272. .spec.initContainers[].restartPolicyRules

Description
Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.
Type
array
Description
ContainerRestartRule describes how a container exit is handled.
Type
object
Required
  • action
Expand
PropertyTypeDescription

action

string

Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container.

exitCodes

object

Represents the exit codes to check on container exits.

Description
Represents the exit codes to check on container exits.
Type
object
Required
  • operator
Expand
PropertyTypeDescription

operator

string

Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values. - NotIn: the requirement is satisfied if the container exit code is not in the set of specified values.

values

array (integer)

Specifies the set of values to check for container exit codes. At most 255 elements are allowed.

2.1.275. .spec.initContainers[].securityContext

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

allowPrivilegeEscalation

boolean

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.

appArmorProfile

object

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.

capabilities

object

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.

privileged

boolean

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.

procMount

string

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.

readOnlyRootFilesystem

boolean

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.

runAsGroup

integer

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.

runAsNonRoot

boolean

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.

runAsUser

integer

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.

seLinuxOptions

object

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.

seccompProfile

object

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.

windowsOptions

object

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.

Description
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.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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

type

string

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.

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

add

array (string)

Added capabilities

drop

array (string)

Removed capabilities

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Type
object
Expand
PropertyTypeDescription

level

string

Level is SELinux level label that applies to the container.

role

string

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

type

string

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

user

string

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

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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.

type

string

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.

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
Expand
PropertyTypeDescription

gmsaCredentialSpec

string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName

string

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

hostProcess

boolean

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.

runAsUserName

string

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.

2.1.281. .spec.initContainers[].startupProbe

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

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

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

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

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

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

2.1.282. .spec.initContainers[].startupProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

2.1.283. .spec.initContainers[].startupProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

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

service

string

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

httpHeaders

array

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

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

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

scheme

string

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

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

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

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

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

port

integer-or-string

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.

2.1.288. .spec.initContainers[].volumeDevices

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

2.1.289. .spec.initContainers[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
  • devicePath
  • name
Expand
PropertyTypeDescription

devicePath

string

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

name

string

name must match the name of a persistentVolumeClaim in the pod

2.1.290. .spec.initContainers[].volumeMounts

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

2.1.291. .spec.initContainers[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
  • mountPath
  • name
Expand
PropertyTypeDescription

mountPath

string

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

mountPropagation

string

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

name

string

This must match the Name of a Volume.

readOnly

boolean

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

recursiveReadOnly

string

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.

subPath

string

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

subPathExpr

string

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.

2.1.292. .spec.limits

Description
limits defines the limits command line flags when starting Alertmanager.
Type
object
Expand
PropertyTypeDescription

maxPerSilenceBytes

string

maxPerSilenceBytes defines 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.

maxSilences

integer

maxSilences defines the maximum number active and pending silences. This corresponds to the Alertmanager’s --silences.max-silences flag. It requires Alertmanager >= v0.28.0.

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

whenDeleted

string

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.

whenScaled

string

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.

2.1.294. .spec.podMetadata

Description

podMetadata defines 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".

Type
object
Expand
PropertyTypeDescription

annotations

object (string)

annotations defines 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

labels

object (string)

labels define the 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

name

string

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

2.1.295. .spec.resources

Description
resources defines the resource requests and limits of the Pods.
Type
object
Expand
PropertyTypeDescription

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

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

requests

integer-or-string

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/

2.1.296. .spec.resources.claims

Description

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Type
array

2.1.297. .spec.resources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

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.

request

string

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.

2.1.298. .spec.securityContext

Description
securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
Type
object
Expand
PropertyTypeDescription

appArmorProfile

object

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.

fsGroup

integer

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.

fsGroupChangePolicy

string

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.

runAsGroup

integer

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.

runAsNonRoot

boolean

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.

runAsUser

integer

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.

seLinuxChangePolicy

string

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.

seLinuxOptions

object

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.

seccompProfile

object

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

supplementalGroups

array (integer)

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.

supplementalGroupsPolicy

string

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.

sysctls

array

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.

sysctls[]

object

Sysctl defines a kernel parameter to be set

windowsOptions

object

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.

2.1.299. .spec.securityContext.appArmorProfile

Description
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.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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

type

string

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.

2.1.300. .spec.securityContext.seLinuxOptions

Description
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
Type
object
Expand
PropertyTypeDescription

level

string

Level is SELinux level label that applies to the container.

role

string

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

type

string

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

user

string

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

2.1.301. .spec.securityContext.seccompProfile

Description
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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.

type

string

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.

2.1.302. .spec.securityContext.sysctls

Description
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
Type
array

2.1.303. .spec.securityContext.sysctls[]

Description
Sysctl defines a kernel parameter to be set
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

Name of a property to set

value

string

Value of a property to set

2.1.304. .spec.securityContext.windowsOptions

Description
The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
Expand
PropertyTypeDescription

gmsaCredentialSpec

string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName

string

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

hostProcess

boolean

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.

runAsUserName

string

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.

2.1.305. .spec.storage

Description
storage defines the definition of how storage will be used by the Alertmanager instances.
Type
object
Expand
PropertyTypeDescription

disableMountSubPath

boolean

disableMountSubPath deprecated: subPath usage will be removed in a future release.

emptyDir

object

emptyDir 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

ephemeral

object

ephemeral 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

volumeClaimTemplate

object

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.

2.1.306. .spec.storage.emptyDir

Description
emptyDir 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
Type
object
Expand
PropertyTypeDescription

medium

string

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

sizeLimit

integer-or-string

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

2.1.307. .spec.storage.ephemeral

Description
ephemeral 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
Type
object
Expand
PropertyTypeDescription

volumeClaimTemplate

object

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.

Description

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Type
object
Required
  • spec
Expand
PropertyTypeDescription

metadata

object

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.

spec

object

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.

Description
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
Type
object
Description
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

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.

dataSourceRef

object

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.

resources

object

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

selector

object

selector is a label query over volumes to consider for binding.

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

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 or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

namespace

string

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.

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

limits

integer-or-string

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

requests

integer-or-string

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/

Description
selector is a label query over volumes to consider for binding.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

2.1.317. .spec.storage.volumeClaimTemplate

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

apiVersion

string

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

kind

string

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

metadata

object

metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.

spec

object

spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

status

object

status is deprecated: this field is never set.

Description
metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
Type
object
Expand
PropertyTypeDescription

annotations

object (string)

annotations defines 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

labels

object (string)

labels define the 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

name

string

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

2.1.319. .spec.storage.volumeClaimTemplate.spec

Description
spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

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.

dataSourceRef

object

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.

resources

object

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

selector

object

selector is a label query over volumes to consider for binding.

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

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 or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

namespace

string

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.

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

limits

integer-or-string

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

requests

integer-or-string

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/

Description
selector is a label query over volumes to consider for binding.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

2.1.326. .spec.storage.volumeClaimTemplate.status

Description
status is deprecated: this field is never set.
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

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

allocatedResourceStatuses

object (string)

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.

allocatedResources

integer-or-string

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.

capacity

integer-or-string

capacity represents the actual resources of the underlying volume.

conditions

array

conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.

conditions[]

object

PersistentVolumeClaimCondition contains details about state of pvc

currentVolumeAttributesClassName

string

currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim

modifyVolumeStatus

object

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.

phase

string

phase represents the current phase of PersistentVolumeClaim.

Description
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
Type
array
Description
PersistentVolumeClaimCondition contains details about state of pvc
Type
object
Required
  • status
  • type
Expand
PropertyTypeDescription

lastProbeTime

string

lastProbeTime is the time we probed the condition.

lastTransitionTime

string

lastTransitionTime is the time the condition transitioned from one status to another.

message

string

message is the human-readable message indicating details about last transition.

reason

string

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.

status

string

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

type

string

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

Description
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.
Type
object
Required
  • status
Expand
PropertyTypeDescription

status

string

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.

targetVolumeAttributesClassName

string

targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled

2.1.330. .spec.tolerations

Description
tolerations defines the pod’s tolerations.
Type
array

2.1.331. .spec.tolerations[]

Description
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
Type
object
Expand
PropertyTypeDescription

effect

string

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

key

string

Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

operator

string

Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

tolerationSeconds

integer

TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

value

string

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

2.1.332. .spec.topologySpreadConstraints

Description
topologySpreadConstraints defines the Pod’s topology spread constraints.
Type
array

2.1.333. .spec.topologySpreadConstraints[]

Description
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
Type
object
Required
  • maxSkew
  • topologyKey
  • whenUnsatisfiable
Expand
PropertyTypeDescription

labelSelector

object

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.

matchLabelKeys

array (string)

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

maxSkew

integer

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.

minDomains

integer

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.

nodeAffinityPolicy

string

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.

nodeTaintsPolicy

string

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.

topologyKey

string

TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It’s a required field.

whenUnsatisfiable

string

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.

Description
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

2.1.337. .spec.volumeMounts

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

2.1.338. .spec.volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
  • mountPath
  • name
Expand
PropertyTypeDescription

mountPath

string

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

mountPropagation

string

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

name

string

This must match the Name of a Volume.

readOnly

boolean

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

recursiveReadOnly

string

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.

subPath

string

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

subPathExpr

string

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.

2.1.339. .spec.volumes

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

2.1.340. .spec.volumes[]

Description
Volume represents a named volume in a pod that may be accessed by any container in the pod.
Type
object
Required
  • name
Expand
PropertyTypeDescription

awsElasticBlockStore

object

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

azureDisk

object

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.

azureFile

object

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.

cephfs

object

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.

cinder

object

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

configMap

object

configMap represents a configMap that should populate this volume

csi

object

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.

downwardAPI

object

downwardAPI represents downward API about the pod that should populate this volume

emptyDir

object

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

ephemeral

object

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.

fc

object

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

flexVolume

object

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.

flocker

object

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.

gcePersistentDisk

object

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

gitRepo

object

gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.

glusterfs

object

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.

hostPath

object

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

image

object

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) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.

iscsi

object

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi

name

string

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

nfs

object

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

persistentVolumeClaim

object

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

photonPersistentDisk

object

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.

portworxVolume

object

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.

projected

object

projected items for all in one resources secrets, configmaps, and downward API

quobyte

object

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.

rbd

object

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.

scaleIO

object

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.

secret

object

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

storageos

object

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.

vsphereVolume

object

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.

2.1.341. .spec.volumes[].awsElasticBlockStore

Description
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. 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
Type
object
Required
  • volumeID
Expand
PropertyTypeDescription

fsType

string

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

partition

integer

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

readOnly

boolean

readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

string

volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

2.1.342. .spec.volumes[].azureDisk

Description
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.
Type
object
Required
  • diskName
  • diskURI
Expand
PropertyTypeDescription

cachingMode

string

cachingMode is the Host Caching mode: None, Read Only, Read Write.

diskName

string

diskName is the Name of the data disk in the blob storage

diskURI

string

diskURI is the URI of data disk in the blob storage

fsType

string

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.

kind

string

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

readOnly

boolean

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

2.1.343. .spec.volumes[].azureFile

Description
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.
Type
object
Required
  • secretName
  • shareName
Expand
PropertyTypeDescription

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretName

string

secretName is the name of secret that contains Azure Storage Account Name and Key

shareName

string

shareName is the azure share Name

2.1.344. .spec.volumes[].cephfs

Description
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.
Type
object
Required
  • monitors
Expand
PropertyTypeDescription

monitors

array (string)

monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

string

path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /

readOnly

boolean

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

secretFile

string

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

secretRef

object

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

user

string

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

2.1.345. .spec.volumes[].cephfs.secretRef

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

name

string

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

2.1.346. .spec.volumes[].cinder

Description
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
Type
object
Required
  • volumeID
Expand
PropertyTypeDescription

fsType

string

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

readOnly

boolean

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

secretRef

object

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

volumeID

string

volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

2.1.347. .spec.volumes[].cinder.secretRef

Description
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
Type
object
Expand
PropertyTypeDescription

name

string

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

2.1.348. .spec.volumes[].configMap

Description
configMap represents a configMap that should populate this volume
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

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.

items

array

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

items[]

object

Maps a string key to a path within a volume.

name

string

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

optional

boolean

optional specify whether the ConfigMap or its keys must be defined

2.1.349. .spec.volumes[].configMap.items

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

2.1.350. .spec.volumes[].configMap.items[]

Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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

2.1.351. .spec.volumes[].csi

Description
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
Type
object
Required
  • driver
Expand
PropertyTypeDescription

driver

string

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.

fsType

string

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.

nodePublishSecretRef

object

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.

readOnly

boolean

readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

volumeAttributes

object (string)

volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.

2.1.352. .spec.volumes[].csi.nodePublishSecretRef

Description
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
Type
object
Expand
PropertyTypeDescription

name

string

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

2.1.353. .spec.volumes[].downwardAPI

Description
downwardAPI represents downward API about the pod that should populate this volume
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

items

array

Items is a list of downward API volume file

items[]

object

DownwardAPIVolumeFile represents information to create the file containing the pod field

2.1.354. .spec.volumes[].downwardAPI.items

Description
Items is a list of downward API volume file
Type
array

2.1.355. .spec.volumes[].downwardAPI.items[]

Description
DownwardAPIVolumeFile represents information to create the file containing the pod field
Type
object
Required
  • path
Expand
PropertyTypeDescription

fieldRef

object

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

mode

integer

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.

path

string

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

resourceFieldRef

object

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

Description
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
Type
object
Required
  • fieldPath
Expand
PropertyTypeDescription

apiVersion

string

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

fieldPath

string

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

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

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

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

resource

string

Required: resource to select

2.1.358. .spec.volumes[].emptyDir

Description
emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
Type
object
Expand
PropertyTypeDescription

medium

string

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

sizeLimit

integer-or-string

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

2.1.359. .spec.volumes[].ephemeral

Description

ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Type
object
Expand
PropertyTypeDescription

volumeClaimTemplate

object

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.

Description

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Type
object
Required
  • spec
Expand
PropertyTypeDescription

metadata

object

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.

spec

object

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.

Description
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
Type
object
Description
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

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.

dataSourceRef

object

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.

resources

object

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

selector

object

selector is a label query over volumes to consider for binding.

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

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 or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

namespace

string

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.

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

limits

integer-or-string

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

requests

integer-or-string

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/

Description
selector is a label query over volumes to consider for binding.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

2.1.369. .spec.volumes[].fc

Description
fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
Type
object
Expand
PropertyTypeDescription

fsType

string

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.

lun

integer

lun is Optional: FC target lun number

readOnly

boolean

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

targetWWNs

array (string)

targetWWNs is Optional: FC target worldwide names (WWNs)

wwids

array (string)

wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

2.1.370. .spec.volumes[].flexVolume

Description
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
Type
object
Required
  • driver
Expand
PropertyTypeDescription

driver

string

driver is the name of the driver to use for this volume.

fsType

string

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.

options

object (string)

options is Optional: this field holds extra command options if any.

readOnly

boolean

readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretRef

object

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.

2.1.371. .spec.volumes[].flexVolume.secretRef

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

name

string

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

2.1.372. .spec.volumes[].flocker

Description
flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
Type
object
Expand
PropertyTypeDescription

datasetName

string

datasetName is Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

datasetUUID

string

datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

2.1.373. .spec.volumes[].gcePersistentDisk

Description
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. 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
Type
object
Required
  • pdName
Expand
PropertyTypeDescription

fsType

string

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

partition

integer

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

pdName

string

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

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

2.1.374. .spec.volumes[].gitRepo

Description
gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.
Type
object
Required
  • repository
Expand
PropertyTypeDescription

directory

string

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.

repository

string

repository is the URL

revision

string

revision is the commit hash for the specified revision.

2.1.375. .spec.volumes[].glusterfs

Description
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.
Type
object
Required
  • endpoints
  • path
Expand
PropertyTypeDescription

endpoints

string

endpoints is the endpoint name that details Glusterfs topology.

path

string

path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

boolean

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

2.1.376. .spec.volumes[].hostPath

Description
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
Type
object
Required
  • path
Expand
PropertyTypeDescription

path

string

path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

2.1.377. .spec.volumes[].image

Description

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) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.

Type
object
Expand
PropertyTypeDescription

pullPolicy

string

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.

reference

string

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.

2.1.378. .spec.volumes[].iscsi

Description
iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi
Type
object
Required
  • iqn
  • lun
  • targetPortal
Expand
PropertyTypeDescription

chapAuthDiscovery

boolean

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

chapAuthSession

boolean

chapAuthSession defines whether support iSCSI Session CHAP authentication

fsType

string

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

initiatorName

string

initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.

iqn

string

iqn is the target iSCSI Qualified Name.

iscsiInterface

string

iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).

lun

integer

lun represents iSCSI Target Lun number.

portals

array (string)

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

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

secretRef

object

secretRef is the CHAP Secret for iSCSI target and initiator authentication

targetPortal

string

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

2.1.379. .spec.volumes[].iscsi.secretRef

Description
secretRef is the CHAP Secret for iSCSI target and initiator authentication
Type
object
Expand
PropertyTypeDescription

name

string

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

2.1.380. .spec.volumes[].nfs

Description
nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
Type
object
Required
  • path
  • server
Expand
PropertyTypeDescription

path

string

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

boolean

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

string

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

2.1.381. .spec.volumes[].persistentVolumeClaim

Description
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
Type
object
Required
  • claimName
Expand
PropertyTypeDescription

claimName

string

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

readOnly

boolean

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

2.1.382. .spec.volumes[].photonPersistentDisk

Description
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.
Type
object
Required
  • pdID
Expand
PropertyTypeDescription

fsType

string

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.

pdID

string

pdID is the ID that identifies Photon Controller persistent disk

2.1.383. .spec.volumes[].portworxVolume

Description
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.
Type
object
Required
  • volumeID
Expand
PropertyTypeDescription

fsType

string

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.

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

volumeID

string

volumeID uniquely identifies a Portworx volume

2.1.384. .spec.volumes[].projected

Description
projected items for all in one resources secrets, configmaps, and downward API
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

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.

sources

array

sources is the list of volume projections. Each entry in this list handles one source.

sources[]

object

Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.

2.1.385. .spec.volumes[].projected.sources

Description
sources is the list of volume projections. Each entry in this list handles one source.
Type
array

2.1.386. .spec.volumes[].projected.sources[]

Description
Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
Type
object
Expand
PropertyTypeDescription

clusterTrustBundle

object

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.

configMap

object

configMap information about the configMap data to project

downwardAPI

object

downwardAPI information about the downwardAPI data to project

podCertificate

object

Projects an auto-rotating credential bundle (private key and certificate chain) that the pod can use either as a TLS client or server.

Kubelet generates a private key and uses it to send a PodCertificateRequest to the named signer. Once the signer approves the request and issues a certificate chain, Kubelet writes the key and certificate chain to the pod filesystem. The pod does not start until certificates have been issued for each podCertificate projected volume source in its spec.

Kubelet will begin trying to rotate the certificate at the time indicated by the signer using the PodCertificateRequest.Status.BeginRefreshAt timestamp.

Kubelet can write a single file, indicated by the credentialBundlePath field, or separate files, indicated by the keyPath and certificateChainPath fields.

The credential bundle is a single file in PEM format. The first PEM entry is the private key (in PKCS#8 format), and the remaining PEM entries are the certificate chain issued by the signer (typically, signers will return their certificate chain in leaf-to-root order).

Prefer using the credential bundle format, since your application code can read it atomically. If you use keyPath and certificateChainPath, your application must make two separate file reads. If these coincide with a certificate rotation, it is possible that the private key and leaf certificate you read may not correspond to each other. Your application will need to check for this condition, and re-read until they are consistent.

The named signer controls chooses the format of the certificate it issues; consult the signer implementation’s documentation to learn how to use the certificates it issues.

secret

object

secret information about the secret data to project

serviceAccountToken

object

serviceAccountToken is information about the serviceAccountToken data to project

Description

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.

Type
object
Required
  • path
Expand
PropertyTypeDescription

labelSelector

object

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

name

string

Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.

optional

boolean

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.

path

string

Relative path from the volume root to write the bundle.

signerName

string

Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

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

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

Description
configMap information about the configMap data to project
Type
object
Expand
PropertyTypeDescription

items

array

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

items[]

object

Maps a string key to a path within a volume.

name

string

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

optional

boolean

optional specify whether the ConfigMap or its keys must be defined

Description
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 '..'.
Type
array
Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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

Description
downwardAPI information about the downwardAPI data to project
Type
object
Expand
PropertyTypeDescription

items

array

Items is a list of DownwardAPIVolume file

items[]

object

DownwardAPIVolumeFile represents information to create the file containing the pod field

Description
Items is a list of DownwardAPIVolume file
Type
array
Description
DownwardAPIVolumeFile represents information to create the file containing the pod field
Type
object
Required
  • path
Expand
PropertyTypeDescription

fieldRef

object

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

mode

integer

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.

path

string

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

resourceFieldRef

object

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

Description
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
Type
object
Required
  • fieldPath
Expand
PropertyTypeDescription

apiVersion

string

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

fieldPath

string

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

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

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

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

resource

string

Required: resource to select

Description

Projects an auto-rotating credential bundle (private key and certificate chain) that the pod can use either as a TLS client or server.

Kubelet generates a private key and uses it to send a PodCertificateRequest to the named signer. Once the signer approves the request and issues a certificate chain, Kubelet writes the key and certificate chain to the pod filesystem. The pod does not start until certificates have been issued for each podCertificate projected volume source in its spec.

Kubelet will begin trying to rotate the certificate at the time indicated by the signer using the PodCertificateRequest.Status.BeginRefreshAt timestamp.

Kubelet can write a single file, indicated by the credentialBundlePath field, or separate files, indicated by the keyPath and certificateChainPath fields.

The credential bundle is a single file in PEM format. The first PEM entry is the private key (in PKCS#8 format), and the remaining PEM entries are the certificate chain issued by the signer (typically, signers will return their certificate chain in leaf-to-root order).

Prefer using the credential bundle format, since your application code can read it atomically. If you use keyPath and certificateChainPath, your application must make two separate file reads. If these coincide with a certificate rotation, it is possible that the private key and leaf certificate you read may not correspond to each other. Your application will need to check for this condition, and re-read until they are consistent.

The named signer controls chooses the format of the certificate it issues; consult the signer implementation’s documentation to learn how to use the certificates it issues.

Type
object
Required
  • keyType
  • signerName
Expand
PropertyTypeDescription

certificateChainPath

string

Write the certificate chain at this path in the projected volume.

Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.

credentialBundlePath

string

Write the credential bundle at this path in the projected volume.

The credential bundle is a single file that contains multiple PEM blocks. The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private key.

The remaining blocks are CERTIFICATE blocks, containing the issued certificate chain from the signer (leaf and any intermediates).

Using credentialBundlePath lets your Pod’s application code make a single atomic read that retrieves a consistent key and certificate chain. If you project them to separate files, your application code will need to additionally check that the leaf certificate was issued to the key.

keyPath

string

Write the key at this path in the projected volume.

Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.

keyType

string

The type of keypair Kubelet will generate for the pod.

Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521", and "ED25519".

maxExpirationSeconds

integer

maxExpirationSeconds is the maximum lifetime permitted for the certificate.

Kubelet copies this value verbatim into the PodCertificateRequests it generates for this projection.

If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver will reject values shorter than 3600 (1 hour). The maximum allowable value is 7862400 (91 days).

The signer implementation is then free to issue a certificate with any lifetime shorter than MaxExpirationSeconds, but no shorter than 3600 seconds (1 hour). This constraint is enforced by kube-apiserver. kubernetes.io signers will never issue certificates with a lifetime longer than 24 hours.

signerName

string

Kubelet’s generated CSRs will be addressed to this signer.

Description
secret information about the secret data to project
Type
object
Expand
PropertyTypeDescription

items

array

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

items[]

object

Maps a string key to a path within a volume.

name

string

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

optional

boolean

optional field specify whether the Secret or its key must be defined

Description
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 '..'.
Type
array
Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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

Description
serviceAccountToken is information about the serviceAccountToken data to project
Type
object
Required
  • path
Expand
PropertyTypeDescription

audience

string

audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.

expirationSeconds

integer

expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

path

string

path is the path relative to the mount point of the file to project the token into.

2.1.404. .spec.volumes[].quobyte

Description
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.
Type
object
Required
  • registry
  • volume
Expand
PropertyTypeDescription

group

string

group to map volume access to Default is no group

readOnly

boolean

readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

registry

string

registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

tenant

string

tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

user

string

user to map volume access to Defaults to serivceaccount user

volume

string

volume is a string that references an already created Quobyte volume by name.

2.1.405. .spec.volumes[].rbd

Description
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.
Type
object
Required
  • image
  • monitors
Expand
PropertyTypeDescription

fsType

string

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

image

string

image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

string

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

monitors

array (string)

monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

string

pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

object

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

user

string

user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

2.1.406. .spec.volumes[].rbd.secretRef

Description
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
Type
object
Expand
PropertyTypeDescription

name

string

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

2.1.407. .spec.volumes[].scaleIO

Description
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.
Type
object
Required
  • gateway
  • secretRef
  • system
Expand
PropertyTypeDescription

fsType

string

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

gateway

string

gateway is the host address of the ScaleIO API Gateway.

protectionDomain

string

protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

readOnly

boolean

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretRef

object

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

sslEnabled

boolean

sslEnabled Flag enable/disable SSL communication with Gateway, default false

storageMode

string

storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

storagePool

string

storagePool is the ScaleIO Storage Pool associated with the protection domain.

system

string

system is the name of the storage system as configured in ScaleIO.

volumeName

string

volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

2.1.408. .spec.volumes[].scaleIO.secretRef

Description
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
Type
object
Expand
PropertyTypeDescription

name

string

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

2.1.409. .spec.volumes[].secret

Description
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

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.

items

array

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

items[]

object

Maps a string key to a path within a volume.

optional

boolean

optional field specify whether the Secret or its keys must be defined

secretName

string

secretName is the name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

2.1.410. .spec.volumes[].secret.items

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

2.1.411. .spec.volumes[].secret.items[]

Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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

2.1.412. .spec.volumes[].storageos

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

fsType

string

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.

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretRef

object

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

volumeName

string

volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

volumeNamespace

string

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.

2.1.413. .spec.volumes[].storageos.secretRef

Description
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
Type
object
Expand
PropertyTypeDescription

name

string

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

2.1.414. .spec.volumes[].vsphereVolume

Description
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.
Type
object
Required
  • volumePath
Expand
PropertyTypeDescription

fsType

string

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.

storagePolicyID

string

storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

storagePolicyName

string

storagePolicyName is the storage Policy Based Management (SPBM) profile name.

volumePath

string

volumePath is the path that identifies vSphere volume vmdk

2.1.415. .spec.web

Description
web defines the web command line flags when starting Alertmanager.
Type
object
Expand
PropertyTypeDescription

getConcurrency

integer

getConcurrency defines the maximum number of GET requests processed concurrently. This corresponds to the Alertmanager’s --web.get-concurrency flag.

httpConfig

object

httpConfig defines HTTP parameters for web server.

timeout

integer

timeout for HTTP requests. This corresponds to the Alertmanager’s --web.timeout flag.

tlsConfig

object

tlsConfig defines the TLS parameters for HTTPS.

2.1.416. .spec.web.httpConfig

Description
httpConfig defines HTTP parameters for web server.
Type
object
Expand
PropertyTypeDescription

headers

object

headers defines a list of headers that can be added to HTTP responses.

http2

boolean

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.

2.1.417. .spec.web.httpConfig.headers

Description
headers defines a list of headers that can be added to HTTP responses.
Type
object
Expand
PropertyTypeDescription

contentSecurityPolicy

string

contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank.

strictTransportSecurity

string

strictTransportSecurity defines 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

xContentTypeOptions

string

xContentTypeOptions defines 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

xFrameOptions

string

xFrameOptions defines 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

xXSSProtection

string

xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection

2.1.418. .spec.web.tlsConfig

Description
tlsConfig defines the TLS parameters for HTTPS.
Type
object
Expand
PropertyTypeDescription

cert

object

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

Either keySecret or keyFile must be defined.

It is mutually exclusive with certFile.

certFile

string

certFile defines the 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.

cipherSuites

array (string)

cipherSuites defines the 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

clientAuthType

string

clientAuthType defines the server policy for client TLS authentication.

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

clientCAFile

string

clientCAFile defines the path to the CA certificate file for client certificate authentication to the server.

It is mutually exclusive with client_ca.

client_ca

object

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

It is mutually exclusive with clientCAFile.

curvePreferences

array (string)

curvePreferences defines 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

keyFile

string

keyFile defines the 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.

keySecret

object

keySecret defines the secret containing the TLS private key for the web server.

Either cert or certFile must be defined.

It is mutually exclusive with keyFile.

maxVersion

string

maxVersion defines the Maximum TLS version that is acceptable.

minVersion

string

minVersion defines the minimum TLS version that is acceptable.

preferServerCipherSuites

boolean

preferServerCipherSuites defines 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.

2.1.419. .spec.web.tlsConfig.cert

Description

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

Either keySecret or keyFile must be defined.

It is mutually exclusive with certFile.

Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

2.1.420. .spec.web.tlsConfig.cert.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

2.1.421. .spec.web.tlsConfig.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.422. .spec.web.tlsConfig.client_ca

Description

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

It is mutually exclusive with clientCAFile.

Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

2.1.423. .spec.web.tlsConfig.client_ca.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

2.1.424. .spec.web.tlsConfig.client_ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.425. .spec.web.tlsConfig.keySecret

Description

keySecret defines the secret containing the TLS private key for the web server.

Either cert or certFile must be defined.

It is mutually exclusive with keyFile.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

2.1.426. .status

Description
status defines the 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
Type
object
Expand
PropertyTypeDescription

availableReplicas

integer

availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this Alertmanager cluster.

conditions

array

conditions defines the current state of the Alertmanager object.

conditions[]

object

Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource.

paused

boolean

paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed.

replicas

integer

replicas defines the total number of non-terminated pods targeted by this Alertmanager object (their labels match the selector).

selector

string

selector used to match the pods targeted by this Alertmanager object.

unavailableReplicas

integer

unavailableReplicas defines the total number of unavailable pods targeted by this Alertmanager object.

updatedReplicas

integer

updatedReplicas defines the total number of non-terminated pods targeted by this Alertmanager object that have the desired version spec.

2.1.427. .status.conditions

Description
conditions defines the current state of the Alertmanager object.
Type
array

2.1.428. .status.conditions[]

Description
Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource.
Type
object
Required
  • lastTransitionTime
  • status
  • type
Expand
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime is the time of the last update to the current status property.

message

string

message defines human-readable message indicating details for the condition’s last transition.

observedGeneration

integer

observedGeneration defines 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.

reason

string

reason for the condition’s last transition.

status

string

status of the condition.

type

string

type of the condition being reported.

2.2. API endpoints

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1/alertmanagers

    • GET: list objects of kind Alertmanager
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers

    • DELETE: delete collection of Alertmanager
    • GET: list objects of kind Alertmanager
    • POST: create an Alertmanager
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers/{name}

    • DELETE: delete an Alertmanager
    • GET: read the specified Alertmanager
    • PATCH: partially update the specified Alertmanager
    • PUT: replace the specified Alertmanager
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers/{name}/scale

    • GET: read scale of the specified Alertmanager
    • PATCH: partially update scale of the specified Alertmanager
    • PUT: replace scale of the specified Alertmanager
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers/{name}/status

    • GET: read status of the specified Alertmanager
    • PATCH: partially update status of the specified Alertmanager
    • PUT: replace status of the specified Alertmanager
HTTP method
GET
Description
list objects of kind Alertmanager
Expand
Table 2.1. HTTP responses
HTTP codeReponse body

200 - OK

AlertmanagerList schema

401 - Unauthorized

Empty

HTTP method
DELETE
Description
delete collection of Alertmanager
Expand
Table 2.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind Alertmanager
Expand
Table 2.3. HTTP responses
HTTP codeReponse body

200 - OK

AlertmanagerList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create an Alertmanager
Expand
Table 2.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 2.5. Body parameters
ParameterTypeDescription

body

Alertmanager schema

 
Expand
Table 2.6. HTTP responses
HTTP codeReponse body

200 - OK

Alertmanager schema

201 - Created

Alertmanager schema

202 - Accepted

Alertmanager schema

401 - Unauthorized

Empty

Expand
Table 2.7. Global path parameters
ParameterTypeDescription

name

string

name of the Alertmanager

HTTP method
DELETE
Description
delete an Alertmanager
Expand
Table 2.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 2.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified Alertmanager
Expand
Table 2.10. HTTP responses
HTTP codeReponse body

200 - OK

Alertmanager schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified Alertmanager
Expand
Table 2.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 2.12. HTTP responses
HTTP codeReponse body

200 - OK

Alertmanager schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified Alertmanager
Expand
Table 2.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 2.14. Body parameters
ParameterTypeDescription

body

Alertmanager schema

 
Expand
Table 2.15. HTTP responses
HTTP codeReponse body

200 - OK

Alertmanager schema

201 - Created

Alertmanager schema

401 - Unauthorized

Empty

Expand
Table 2.16. Global path parameters
ParameterTypeDescription

name

string

name of the Alertmanager

HTTP method
GET
Description
read scale of the specified Alertmanager
Expand
Table 2.17. HTTP responses
HTTP codeReponse body

200 - OK

Scale schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update scale of the specified Alertmanager
Expand
Table 2.18. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 2.19. HTTP responses
HTTP codeReponse body

200 - OK

Scale schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace scale of the specified Alertmanager
Expand
Table 2.20. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 2.21. Body parameters
ParameterTypeDescription

body

Scale schema

 
Expand
Table 2.22. HTTP responses
HTTP codeReponse body

200 - OK

Scale schema

201 - Created

Scale schema

401 - Unauthorized

Empty

Expand
Table 2.23. Global path parameters
ParameterTypeDescription

name

string

name of the Alertmanager

HTTP method
GET
Description
read status of the specified Alertmanager
Expand
Table 2.24. HTTP responses
HTTP codeReponse body

200 - OK

Alertmanager schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified Alertmanager
Expand
Table 2.25. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 2.26. HTTP responses
HTTP codeReponse body

200 - OK

Alertmanager schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified Alertmanager
Expand
Table 2.27. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 2.28. Body parameters
ParameterTypeDescription

body

Alertmanager schema

 
Expand
Table 2.29. HTTP responses
HTTP codeReponse body

200 - OK

Alertmanager schema

201 - Created

Alertmanager schema

401 - Unauthorized

Empty

Description

The AlertmanagerConfig custom resource definition (CRD) defines how Alertmanager objects process Prometheus alerts. It allows to specify alert grouping and routing, notification receivers and inhibition rules.

Alertmanager objects select AlertmanagerConfig objects using label and namespace selectors.

Type
object
Required
  • spec

3.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

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

kind

string

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

metadata

ObjectMeta

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

spec

object

spec defines the specification of AlertmanagerConfigSpec

3.1.1. .spec

Description
spec defines the specification of AlertmanagerConfigSpec
Type
object
Expand
PropertyTypeDescription

inhibitRules

array

inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.

inhibitRules[]

object

InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule

receivers

array

receivers defines the list of receivers.

receivers[]

object

Receiver defines one or more notification integrations.

route

object

route defines the Alertmanager route definition for alerts matching the resource’s namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route.

timeIntervals

array

timeIntervals defines the list of timeIntervals specifying when the routes should be muted.

timeIntervals[]

object

TimeInterval specifies the periods in time when notifications will be muted or active.

3.1.2. .spec.inhibitRules

Description
inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.
Type
array

3.1.3. .spec.inhibitRules[]

Description
InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule
Type
object
Expand
PropertyTypeDescription

equal

array (string)

equal defines labels that must have an equal value in the source and target alert for the inhibition to take effect. This ensures related alerts are properly grouped.

sourceMatch

array

sourceMatch defines matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace. These are the "trigger" alerts that cause other alerts to be inhibited.

sourceMatch[]

object

Matcher defines how to match on alert’s labels.

targetMatch

array

targetMatch defines matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace. When these conditions are met, matching alerts will be inhibited (silenced).

targetMatch[]

object

Matcher defines how to match on alert’s labels.

3.1.4. .spec.inhibitRules[].sourceMatch

Description
sourceMatch defines matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace. These are the "trigger" alerts that cause other alerts to be inhibited.
Type
array

3.1.5. .spec.inhibitRules[].sourceMatch[]

Description
Matcher defines how to match on alert’s labels.
Type
object
Required
  • name
Expand
PropertyTypeDescription

matchType

string

matchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match).

name

string

name defines the label to match. This specifies which alert label should be evaluated.

value

string

value defines the label value to match. This is the expected value for the specified label.

3.1.6. .spec.inhibitRules[].targetMatch

Description
targetMatch defines matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace. When these conditions are met, matching alerts will be inhibited (silenced).
Type
array

3.1.7. .spec.inhibitRules[].targetMatch[]

Description
Matcher defines how to match on alert’s labels.
Type
object
Required
  • name
Expand
PropertyTypeDescription

matchType

string

matchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match).

name

string

name defines the label to match. This specifies which alert label should be evaluated.

value

string

value defines the label value to match. This is the expected value for the specified label.

3.1.8. .spec.receivers

Description
receivers defines the list of receivers.
Type
array

3.1.9. .spec.receivers[]

Description
Receiver defines one or more notification integrations.
Type
object
Required
  • name
Expand
PropertyTypeDescription

discordConfigs

array

discordConfigs defines the list of Slack configurations.

discordConfigs[]

object

DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config

emailConfigs

array

emailConfigs defines the list of Email configurations.

emailConfigs[]

object

EmailConfig configures notifications via Email.

msteamsConfigs

array

msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0.

msteamsConfigs[]

object

MSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0.

msteamsv2Configs

array

msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0.

msteamsv2Configs[]

object

MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config It requires Alertmanager >= 0.28.0.

name

string

name defines the name of the receiver. Must be unique across all items from the list.

opsgenieConfigs

array

opsgenieConfigs defines the list of OpsGenie configurations.

opsgenieConfigs[]

object

OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config

pagerdutyConfigs

array

pagerdutyConfigs defines the List of PagerDuty configurations.

pagerdutyConfigs[]

object

PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config

pushoverConfigs

array

pushoverConfigs defines the list of Pushover configurations.

pushoverConfigs[]

object

PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config

rocketchatConfigs

array

rocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0.

rocketchatConfigs[]

object

RocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0.

slackConfigs

array

slackConfigs defines the list of Slack configurations.

slackConfigs[]

object

SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config

snsConfigs

array

snsConfigs defines the list of SNS configurations

snsConfigs[]

object

SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs

telegramConfigs

array

telegramConfigs defines the list of Telegram configurations.

telegramConfigs[]

object

TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config

victoropsConfigs

array

victoropsConfigs defines the list of VictorOps configurations.

victoropsConfigs[]

object

VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config

webexConfigs

array

webexConfigs defines the list of Webex configurations.

webexConfigs[]

object

WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config

webhookConfigs

array

webhookConfigs defines the List of webhook configurations.

webhookConfigs[]

object

WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config

wechatConfigs

array

wechatConfigs defines the list of WeChat configurations.

wechatConfigs[]

object

WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config

3.1.10. .spec.receivers[].discordConfigs

Description
discordConfigs defines the list of Slack configurations.
Type
array

3.1.11. .spec.receivers[].discordConfigs[]

Description
DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config
Type
object
Required
  • apiURL
Expand
PropertyTypeDescription

apiURL

object

apiURL defines the secret’s key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

avatarURL

string

avatarURL defines the avatar url of the message sender.

content

string

content defines the template of the content’s body.

httpConfig

object

httpConfig defines HTTP client configuration.

message

string

message defines the template of the message’s body.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

title

string

title defines the template of the message’s title.

username

string

username defines the username of the message sender.

3.1.12. .spec.receivers[].discordConfigs[].apiURL

Description
apiURL defines the secret’s key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
httpConfig defines HTTP client configuration.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.47. .spec.receivers[].emailConfigs

Description
emailConfigs defines the list of Email configurations.
Type
array

3.1.48. .spec.receivers[].emailConfigs[]

Description
EmailConfig configures notifications via Email.
Type
object
Expand
PropertyTypeDescription

authIdentity

string

authIdentity defines the identity to use for SMTP authentication. This is typically used with PLAIN authentication mechanism.

authPassword

object

authPassword defines the secret’s key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

authSecret

object

authSecret defines the secret’s key that contains the CRAM-MD5 secret. This is used for CRAM-MD5 authentication mechanism. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

authUsername

string

authUsername defines the username to use for SMTP authentication. This is used for SMTP AUTH when the server requires authentication.

from

string

from defines the sender address for email notifications. This appears as the "From" field in the email header.

headers

array

headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation.

headers[]

object

KeyValue defines a (key, value) tuple.

hello

string

hello defines the hostname to identify to the SMTP server. This is used in the SMTP HELO/EHLO command during the connection handshake.

html

string

html defines the HTML body of the email notification. This allows for rich formatting in the email content.

requireTLS

boolean

requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

smarthost

string

smarthost defines the SMTP host and port through which emails are sent. Format should be "hostname:port", e.g. "smtp.example.com:587".

text

string

text defines the plain text body of the email notification. This provides a fallback for email clients that don’t support HTML.

tlsConfig

object

tlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options.

to

string

to defines the email address to send notifications to. This is the recipient address for alert notifications.

Description
authPassword defines the secret’s key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
authSecret defines the secret’s key that contains the CRAM-MD5 secret. This is used for CRAM-MD5 authentication mechanism. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

3.1.51. .spec.receivers[].emailConfigs[].headers

Description
headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation.
Type
array

3.1.52. .spec.receivers[].emailConfigs[].headers[]

Description
KeyValue defines a (key, value) tuple.
Type
object
Required
  • key
  • value
Expand
PropertyTypeDescription

key

string

key defines the key of the tuple. This is the identifier or name part of the key-value pair.

value

string

value defines the value of the tuple. This is the data or content associated with the key.

3.1.53. .spec.receivers[].emailConfigs[].tlsConfig

Description
tlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.61. .spec.receivers[].msteamsConfigs

Description
msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0.
Type
array

3.1.62. .spec.receivers[].msteamsConfigs[]

Description
MSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0.
Type
object
Required
  • webhookUrl
Expand
PropertyTypeDescription

httpConfig

object

httpConfig defines the HTTP client configuration for Teams webhook requests.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

summary

string

summary defines the message summary template for Teams notifications. This provides a brief overview that appears in Teams notification previews. It requires Alertmanager >= 0.27.0.

text

string

text defines the message body template for Teams notifications. This contains the detailed content of the Teams message.

title

string

title defines the message title template for Teams notifications. This appears as the main heading of the Teams message card.

webhookUrl

object

webhookUrl defines the MSTeams webhook URL for sending notifications. This is the incoming webhook URL configured in your Teams channel.

Description
httpConfig defines the HTTP client configuration for Teams webhook requests.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
webhookUrl defines the MSTeams webhook URL for sending notifications. This is the incoming webhook URL configured in your Teams channel.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.98. .spec.receivers[].msteamsv2Configs

Description
msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0.
Type
array

3.1.99. .spec.receivers[].msteamsv2Configs[]

Description
MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config It requires Alertmanager >= 0.28.0.
Type
object
Expand
PropertyTypeDescription

httpConfig

object

httpConfig defines the HTTP client configuration for Teams webhook requests.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

text

string

text defines the message body template for adaptive card notifications. This contains the detailed content displayed in the Teams adaptive card format.

title

string

title defines the message title template for adaptive card notifications. This appears as the main heading in the Teams adaptive card.

webhookURL

object

webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. This webhook must support the newer adaptive cards format required by Teams flows.

Description
httpConfig defines the HTTP client configuration for Teams webhook requests.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. This webhook must support the newer adaptive cards format required by Teams flows.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.135. .spec.receivers[].opsgenieConfigs

Description
opsgenieConfigs defines the list of OpsGenie configurations.
Type
array

3.1.136. .spec.receivers[].opsgenieConfigs[]

Description
OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
Type
object
Expand
PropertyTypeDescription

actions

string

actions defines a comma separated list of actions that will be available for the alert. These appear as action buttons in the OpsGenie interface.

apiKey

object

apiKey defines the secret’s key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

apiURL

string

apiURL defines the URL to send OpsGenie API requests to. When not specified, defaults to the standard OpsGenie API endpoint.

description

string

description defines the detailed description of the incident. This provides additional context beyond the message field.

details

array

details defines a set of arbitrary key/value pairs that provide further detail about the incident. These appear as additional fields in the OpsGenie alert.

details[]

object

KeyValue defines a (key, value) tuple.

entity

string

entity defines an optional field that can be used to specify which domain alert is related to. This helps group related alerts together in OpsGenie.

httpConfig

object

httpConfig defines the HTTP client configuration for OpsGenie API requests.

message

string

message defines the alert text limited to 130 characters. This appears as the main alert title in OpsGenie.

note

string

note defines an additional alert note. This provides supplementary information about the alert.

priority

string

priority defines the priority level of alert. Possible values are P1, P2, P3, P4, and P5, where P1 is highest priority.

responders

array

responders defines the list of responders responsible for notifications. These determine who gets notified when the alert is created.

responders[]

object

OpsGenieConfigResponder defines a responder to an incident. One of id, name or username has to be defined.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

source

string

source defines the backlink to the sender of the notification. This helps identify where the alert originated from.

tags

string

tags defines a comma separated list of tags attached to the notifications. These help categorize and filter alerts within OpsGenie.

Description
apiKey defines the secret’s key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
details defines a set of arbitrary key/value pairs that provide further detail about the incident. These appear as additional fields in the OpsGenie alert.
Type
array
Description
KeyValue defines a (key, value) tuple.
Type
object
Required
  • key
  • value
Expand
PropertyTypeDescription

key

string

key defines the key of the tuple. This is the identifier or name part of the key-value pair.

value

string

value defines the value of the tuple. This is the data or content associated with the key.

Description
httpConfig defines the HTTP client configuration for OpsGenie API requests.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
responders defines the list of responders responsible for notifications. These determine who gets notified when the alert is created.
Type
array
Description
OpsGenieConfigResponder defines a responder to an incident. One of id, name or username has to be defined.
Type
object
Required
  • type
Expand
PropertyTypeDescription

id

string

id defines the unique identifier of the responder. This corresponds to the responder’s ID within OpsGenie.

name

string

name defines the display name of the responder. This is used when the responder is identified by name rather than ID.

type

string

type defines the type of responder. Valid values include "user", "team", "schedule", and "escalation". This determines how OpsGenie interprets the other identifier fields.

username

string

username defines the username of the responder. This is typically used for user-type responders when identifying by username.

3.1.176. .spec.receivers[].pagerdutyConfigs

Description
pagerdutyConfigs defines the List of PagerDuty configurations.
Type
array

3.1.177. .spec.receivers[].pagerdutyConfigs[]

Description
PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
Type
object
Expand
PropertyTypeDescription

class

string

class defines the class/type of the event.

client

string

client defines the client identification.

clientURL

string

clientURL defines the backlink to the sender of notification.

component

string

component defines the part or component of the affected system that is broken.

description

string

description of the incident.

details

array

details defines the arbitrary key/value pairs that provide further detail about the incident.

details[]

object

KeyValue defines a (key, value) tuple.

group

string

group defines a cluster or grouping of sources.

httpConfig

object

httpConfig defines the HTTP client configuration.

pagerDutyImageConfigs

array

pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident.

pagerDutyImageConfigs[]

object

PagerDutyImageConfig attaches images to an incident

pagerDutyLinkConfigs

array

pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident.

pagerDutyLinkConfigs[]

object

PagerDutyLinkConfig attaches text links to an incident

routingKey

object

routingKey defines the secret’s key that contains the PagerDuty integration key (when using Events API v2). Either this field or serviceKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

serviceKey

object

serviceKey defines the secret’s key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or routingKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

severity

string

severity of the incident.

source

string

source defines the unique location of the affected system.

url

string

url defines the URL to send requests to.

Description
details defines the arbitrary key/value pairs that provide further detail about the incident.
Type
array
Description
KeyValue defines a (key, value) tuple.
Type
object
Required
  • key
  • value
Expand
PropertyTypeDescription

key

string

key defines the key of the tuple. This is the identifier or name part of the key-value pair.

value

string

value defines the value of the tuple. This is the data or content associated with the key.

Description
httpConfig defines the HTTP client configuration.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident.
Type
array
Description
PagerDutyImageConfig attaches images to an incident
Type
object
Expand
PropertyTypeDescription

alt

string

alt is the optional alternative text for the image.

href

string

href defines the optional URL; makes the image a clickable link.

src

string

src of the image being attached to the incident

Description
pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident.
Type
array
Description
PagerDutyLinkConfig attaches text links to an incident
Type
object
Expand
PropertyTypeDescription

alt

string

alt defines the text that describes the purpose of the link, and can be used as the link’s text.

href

string

href defines the URL of the link to be attached

Description
routingKey defines the secret’s key that contains the PagerDuty integration key (when using Events API v2). Either this field or serviceKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
serviceKey defines the secret’s key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or routingKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

3.1.220. .spec.receivers[].pushoverConfigs

Description
pushoverConfigs defines the list of Pushover configurations.
Type
array

3.1.221. .spec.receivers[].pushoverConfigs[]

Description
PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config
Type
object
Expand
PropertyTypeDescription

device

string

device defines the name of a specific device to send the notification to. If not specified, the notification is sent to all user’s devices.

expire

string

expire defines how long your notification will continue to be retried for, unless the user acknowledges the notification. Only applies to priority 2 notifications.

html

boolean

html defines whether notification message is HTML or plain text. When true, the message can include HTML formatting tags.

httpConfig

object

httpConfig defines the HTTP client configuration for Pushover API requests.

message

string

message defines the notification message content. This is the main body text of the Pushover notification.

monospace

boolean

monospace optional HTML/monospace formatting for the message, see https://pushover.net/api#html html and monospace formatting are mutually exclusive.

priority

string

priority defines the notification priority level. See https://pushover.net/api#priority for valid values and behavior.

retry

string

retry defines how often the Pushover servers will send the same notification to the user. Must be at least 30 seconds. Only applies to priority 2 notifications.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

sound

string

sound defines the name of one of the sounds supported by device clients. This overrides the user’s default sound choice for this notification.

title

string

title defines the notification title displayed in the Pushover message. This appears as the bold header text in the notification.

token

object

token defines the secret’s key that contains the registered application’s API token. See https://pushover.net/apps for application registration. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either token or tokenFile is required.

tokenFile

string

tokenFile defines the token file that contains the registered application’s API token. See https://pushover.net/apps for application registration. Either token or tokenFile is required. It requires Alertmanager >= v0.26.0.

ttl

string

ttl defines the time to live for the alert notification. This determines how long the notification remains active before expiring.

url

string

url defines a supplementary URL shown alongside the message. This creates a clickable link within the Pushover notification.

urlTitle

string

urlTitle defines a title for the supplementary URL. If not specified, the raw URL is shown instead.

userKey

object

userKey defines the secret’s key that contains the recipient user’s user key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either userKey or userKeyFile is required.

userKeyFile

string

userKeyFile defines the user key file that contains the recipient user’s user key. Either userKey or userKeyFile is required. It requires Alertmanager >= v0.26.0.

Description
httpConfig defines the HTTP client configuration for Pushover API requests.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.256. .spec.receivers[].pushoverConfigs[].token

Description
token defines the secret’s key that contains the registered application’s API token. See https://pushover.net/apps for application registration. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either token or tokenFile is required.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
userKey defines the secret’s key that contains the recipient user’s user key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either userKey or userKeyFile is required.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

3.1.258. .spec.receivers[].rocketchatConfigs

Description
rocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0.
Type
array

3.1.259. .spec.receivers[].rocketchatConfigs[]

Description
RocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0.
Type
object
Required
  • token
  • tokenID
Expand
PropertyTypeDescription

actions

array

actions defines interactive actions to include in the message. These appear as buttons that users can click to trigger responses.

actions[]

object

RocketChatActionConfig defines actions for RocketChat messages.

apiURL

string

apiURL defines the API URL for RocketChat. Defaults to https://open.rocket.chat/ if not specified.

channel

string

channel defines the channel to send alerts to. This can be a channel name (e.g., "#alerts") or a direct message recipient.

color

string

color defines the message color displayed in RocketChat. This appears as a colored bar alongside the message.

emoji

string

emoji defines the emoji to be displayed as an avatar. If provided, this emoji will be used instead of the default avatar or iconURL.

fields

array

fields defines additional fields for the message attachment. These appear as structured key-value pairs within the message.

fields[]

object

RocketChatFieldConfig defines a field for RocketChat messages.

httpConfig

object

httpConfig defines the HTTP client configuration for RocketChat API requests.

iconURL

string

iconURL defines the icon URL for the message avatar. This displays a custom image as the message sender’s avatar.

imageURL

string

imageURL defines the image URL to display within the message. This embeds an image directly in the message attachment.

linkNames

boolean

linkNames defines whether to enable automatic linking of usernames and channels. When true, @username and #channel references become clickable links.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

shortFields

boolean

shortFields defines whether to use short fields in the message layout. When true, fields may be displayed side by side to save space.

text

string

text defines the message text to send. This is optional because attachments can be used instead of or alongside text.

thumbURL

string

thumbURL defines the thumbnail URL for the message. This displays a small thumbnail image alongside the message content.

title

string

title defines the message title displayed prominently in the message. This appears as bold text at the top of the message attachment.

titleLink

string

titleLink defines the URL that the title will link to when clicked. This makes the message title clickable in the RocketChat interface.

token

object

token defines the sender token for RocketChat authentication. This is the personal access token or bot token used to authenticate API requests.

tokenID

object

tokenID defines the sender token ID for RocketChat authentication. This is the user ID associated with the token used for API requests.

Description
actions defines interactive actions to include in the message. These appear as buttons that users can click to trigger responses.
Type
array
Description
RocketChatActionConfig defines actions for RocketChat messages.
Type
object
Expand
PropertyTypeDescription

msg

string

msg defines the message to send when the button is clicked. This allows the button to post a predefined message to the channel.

text

string

text defines the button text displayed to users. This is the label that appears on the interactive button.

url

string

url defines the URL the button links to when clicked. This creates a clickable button that opens the specified URL.

Description
fields defines additional fields for the message attachment. These appear as structured key-value pairs within the message.
Type
array
Description
RocketChatFieldConfig defines a field for RocketChat messages.
Type
object
Expand
PropertyTypeDescription

short

boolean

short defines whether this field should be a short field. When true, the field may be displayed inline with other short fields to save space.

title

string

title defines the title of this field. This appears as bold text labeling the field content.

value

string

value defines the value of this field, displayed underneath the title. This contains the actual data or content for the field.

Description
httpConfig defines the HTTP client configuration for RocketChat API requests.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
token defines the sender token for RocketChat authentication. This is the personal access token or bot token used to authenticate API requests.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tokenID defines the sender token ID for RocketChat authentication. This is the user ID associated with the token used for API requests.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.300. .spec.receivers[].slackConfigs

Description
slackConfigs defines the list of Slack configurations.
Type
array

3.1.301. .spec.receivers[].slackConfigs[]

Description
SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config
Type
object
Expand
PropertyTypeDescription

actions

array

actions defines a list of Slack actions that are sent with each notification.

actions[]

object

SlackAction configures a single Slack action that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields and https://api.slack.com/docs/message-buttons for more information.

apiURL

object

apiURL defines the secret’s key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

callbackId

string

callbackId defines an identifier for the message used in interactive components.

channel

string

channel defines the channel or user to send notifications to.

color

string

color defines the color of the left border of the Slack message attachment. Can be a hex color code (e.g., "#ff0000") or a predefined color name.

fallback

string

fallback defines a plain-text summary of the attachment for clients that don’t support attachments.

fields

array

fields defines a list of Slack fields that are sent with each notification.

fields[]

object

SlackField configures a single Slack field that is sent with each notification. Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. See https://api.slack.com/docs/message-attachments#fields for more information.

footer

string

footer defines small text displayed at the bottom of the message attachment.

httpConfig

object

httpConfig defines the HTTP client configuration.

iconEmoji

string

iconEmoji defines the emoji to use as the bot’s avatar (e.g., ":ghost:").

iconURL

string

iconURL defines the URL to an image to use as the bot’s avatar.

imageURL

string

imageURL defines the URL to an image file that will be displayed inside the message attachment.

linkNames

boolean

linkNames enables automatic linking of channel names and usernames in the message. When true, @channel and @username will be converted to clickable links.

mrkdwnIn

array (string)

mrkdwnIn defines which fields should be parsed as Slack markdown. Valid values include "pretext", "text", and "fields".

pretext

string

pretext defines optional text that appears above the message attachment block.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

shortFields

boolean

shortFields determines whether fields are displayed in a compact format. When true, fields are shown side by side when possible.

text

string

text defines the main text content of the Slack message attachment.

thumbURL

string

thumbURL defines the URL to an image file that will be displayed as a thumbnail on the right side of the message attachment.

title

string

title defines the title text displayed in the Slack message attachment.

titleLink

string

titleLink defines the URL that the title will link to when clicked.

username

string

username defines the slack bot user name.

3.1.302. .spec.receivers[].slackConfigs[].actions

Description
actions defines a list of Slack actions that are sent with each notification.
Type
array
Description
SlackAction configures a single Slack action that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields and https://api.slack.com/docs/message-buttons for more information.
Type
object
Required
  • text
  • type
Expand
PropertyTypeDescription

confirm

object

confirm defines an optional confirmation dialog that appears before the action is executed. When set, users must confirm their intent before the action proceeds.

name

string

name defines a unique identifier for the action within the message. This value is sent back to your application when the action is triggered.

style

string

style defines the visual appearance of the action element. Valid values include "default", "primary" (green), and "danger" (red).

text

string

text defines the user-visible label displayed on the action element. For buttons, this is the button text. For select menus, this is the placeholder text.

type

string

type defines the type of interactive component. Common values include "button" for clickable buttons and "select" for dropdown menus.

url

string

url defines the URL to open when the action is triggered. Only applicable for button-type actions. When set, clicking the button opens this URL.

value

string

value defines the payload sent when the action is triggered. This data is included in the callback sent to your application.

Description
confirm defines an optional confirmation dialog that appears before the action is executed. When set, users must confirm their intent before the action proceeds.
Type
object
Required
  • text
Expand
PropertyTypeDescription

dismissText

string

dismissText defines the label for the cancel button in the dialog. When not specified, defaults to "Cancel". This button cancels the action.

okText

string

okText defines the label for the confirmation button in the dialog. When not specified, defaults to "Okay". This button proceeds with the action.

text

string

text defines the main message displayed in the confirmation dialog. This should be a clear question or statement asking the user to confirm their action.

title

string

title defines the title text displayed at the top of the confirmation dialog. When not specified, a default title will be used.

3.1.305. .spec.receivers[].slackConfigs[].apiURL

Description
apiURL defines the secret’s key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

3.1.306. .spec.receivers[].slackConfigs[].fields

Description
fields defines a list of Slack fields that are sent with each notification.
Type
array

3.1.307. .spec.receivers[].slackConfigs[].fields[]

Description
SlackField configures a single Slack field that is sent with each notification. Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. See https://api.slack.com/docs/message-attachments#fields for more information.
Type
object
Required
  • title
  • value
Expand
PropertyTypeDescription

short

boolean

short determines whether this field can be displayed alongside other short fields. When true, Slack may display this field side by side with other short fields. When false or not specified, the field takes the full width of the message.

title

string

title defines the label or header text displayed for this field. This appears as bold text above the field value in the Slack message.

value

string

value defines the content or data displayed for this field. This appears below the title and can contain plain text or Slack markdown.

Description
httpConfig defines the HTTP client configuration.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.342. .spec.receivers[].snsConfigs

Description
snsConfigs defines the list of SNS configurations
Type
array

3.1.343. .spec.receivers[].snsConfigs[]

Description
SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
Type
object
Expand
PropertyTypeDescription

apiURL

string

apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used.

attributes

object (string)

attributes defines SNS message attributes as key-value pairs. These provide additional metadata that can be used for message filtering and routing.

httpConfig

object

httpConfig defines the HTTP client configuration for SNS API requests.

message

string

message defines the message content of the SNS notification. This is the actual notification text that will be sent to subscribers.

phoneNumber

string

phoneNumber defines the phone number if message is delivered via SMS in E.164 format. If you don’t specify this value, you must specify a value for the TopicARN or TargetARN.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

sigv4

object

sigv4 configures AWS’s Signature Verification 4 signing process to sign requests. This includes AWS credentials and region configuration for authentication.

subject

string

subject defines the subject line when the message is delivered to email endpoints. This field is only used when sending to email subscribers of an SNS topic.

targetARN

string

targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications. If you don’t specify this value, you must specify a value for the TopicARN or PhoneNumber.

topicARN

string

topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic. If you don’t specify this value, you must specify a value for the PhoneNumber or TargetARN.

3.1.344. .spec.receivers[].snsConfigs[].httpConfig

Description
httpConfig defines the HTTP client configuration for SNS API requests.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.378. .spec.receivers[].snsConfigs[].sigv4

Description
sigv4 configures AWS’s Signature Verification 4 signing process to sign requests. This includes AWS credentials and region configuration for authentication.
Type
object
Expand
PropertyTypeDescription

accessKey

object

accessKey defines the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID is used.

profile

string

profile defines the named AWS profile used to authenticate.

region

string

region defines the AWS region. If blank, the region from the default credentials chain used.

roleArn

string

roleArn defines the named AWS profile used to authenticate.

secretKey

object

secretKey defines the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY is used.

useFIPSSTSEndpoint

boolean

useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. It requires Prometheus >= v2.54.0.

Description
accessKey defines the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID is used.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
secretKey defines the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY is used.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.381. .spec.receivers[].telegramConfigs

Description
telegramConfigs defines the list of Telegram configurations.
Type
array

3.1.382. .spec.receivers[].telegramConfigs[]

Description
TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config
Type
object
Required
  • chatID
Expand
PropertyTypeDescription

apiURL

string

apiURL defines the Telegram API URL, e.g. https://api.telegram.org. If not specified, the default Telegram API URL will be used.

botToken

object

botToken defines the Telegram bot token. It is mutually exclusive with botTokenFile. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either botToken or botTokenFile is required.

botTokenFile

string

botTokenFile defines the file to read the Telegram bot token from. It is mutually exclusive with botToken. Either botToken or botTokenFile is required. It requires Alertmanager >= v0.26.0.

chatID

integer

chatID defines the Telegram chat ID where messages will be sent. This can be a user ID, group ID, or channel ID (with @ prefix for public channels).

disableNotifications

boolean

disableNotifications controls whether Telegram notifications are sent silently. When true, users will receive the message without notification sounds.

httpConfig

object

httpConfig defines the HTTP client configuration for Telegram API requests.

message

string

message defines the message template for the Telegram notification. This is the content that will be sent to the specified chat.

messageThreadID

integer

messageThreadID defines the Telegram Group Topic ID for threaded messages. This allows sending messages to specific topics within Telegram groups. It requires Alertmanager >= 0.26.0.

parseMode

string

parseMode defines the parse mode for telegram message formatting. Valid values are "MarkdownV2", "Markdown", and "HTML". This determines how text formatting is interpreted in the message.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

Description
botToken defines the Telegram bot token. It is mutually exclusive with botTokenFile. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either botToken or botTokenFile is required.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
httpConfig defines the HTTP client configuration for Telegram API requests.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.418. .spec.receivers[].victoropsConfigs

Description
victoropsConfigs defines the list of VictorOps configurations.
Type
array

3.1.419. .spec.receivers[].victoropsConfigs[]

Description
VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config
Type
object
Expand
PropertyTypeDescription

apiKey

object

apiKey defines the secret’s key that contains the API key to use when talking to the VictorOps API. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

apiUrl

string

apiUrl defines the VictorOps API URL. When not specified, defaults to the standard VictorOps API endpoint.

customFields

array

customFields defines additional custom fields for notification. These provide extra metadata that will be included with the VictorOps incident.

customFields[]

object

KeyValue defines a (key, value) tuple.

entityDisplayName

string

entityDisplayName contains a summary of the alerted problem. This appears as the main title or identifier for the incident.

httpConfig

object

httpConfig defines the HTTP client’s configuration for VictorOps API requests.

messageType

string

messageType describes the behavior of the alert. Valid values are "CRITICAL", "WARNING", and "INFO".

monitoringTool

string

monitoringTool defines the monitoring tool the state message is from. This helps identify the source system that generated the alert.

routingKey

string

routingKey defines a key used to map the alert to a team. This determines which VictorOps team will receive the alert notification.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

stateMessage

string

stateMessage contains a long explanation of the alerted problem. This provides detailed context about the incident.

Description
apiKey defines the secret’s key that contains the API key to use when talking to the VictorOps API. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
customFields defines additional custom fields for notification. These provide extra metadata that will be included with the VictorOps incident.
Type
array
Description
KeyValue defines a (key, value) tuple.
Type
object
Required
  • key
  • value
Expand
PropertyTypeDescription

key

string

key defines the key of the tuple. This is the identifier or name part of the key-value pair.

value

string

value defines the value of the tuple. This is the data or content associated with the key.

Description
httpConfig defines the HTTP client’s configuration for VictorOps API requests.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.457. .spec.receivers[].webexConfigs

Description
webexConfigs defines the list of Webex configurations.
Type
array

3.1.458. .spec.receivers[].webexConfigs[]

Description
WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config
Type
object
Required
  • roomID
Expand
PropertyTypeDescription

apiURL

string

apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages

httpConfig

object

httpConfig defines the HTTP client’s configuration. You must use this configuration to supply the bot token as part of the HTTP Authorization header.

message

string

message defines the message template

roomID

string

roomID defines the ID of the Webex Teams room where to send the messages.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

Description
httpConfig defines the HTTP client’s configuration. You must use this configuration to supply the bot token as part of the HTTP Authorization header.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.493. .spec.receivers[].webhookConfigs

Description
webhookConfigs defines the List of webhook configurations.
Type
array

3.1.494. .spec.receivers[].webhookConfigs[]

Description
WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
Type
object
Expand
PropertyTypeDescription

httpConfig

object

httpConfig defines the HTTP client configuration for webhook requests.

maxAlerts

integer

maxAlerts defines the maximum number of alerts to be sent per webhook message. When 0, all alerts are included in the webhook payload.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

timeout

string

timeout defines the maximum time to wait for a webhook request to complete, before failing the request and allowing it to be retried. It requires Alertmanager >= v0.28.0.

url

string

url defines the URL to send HTTP POST requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined.

urlSecret

object

urlSecret defines the secret’s key that contains the webhook URL to send HTTP requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Description
httpConfig defines the HTTP client configuration for webhook requests.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
urlSecret defines the secret’s key that contains the webhook URL to send HTTP requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

3.1.530. .spec.receivers[].wechatConfigs

Description
wechatConfigs defines the list of WeChat configurations.
Type
array

3.1.531. .spec.receivers[].wechatConfigs[]

Description
WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config
Type
object
Expand
PropertyTypeDescription

agentID

string

agentID defines the application agent ID within WeChat Work. This identifies which WeChat Work application will send the notifications.

apiSecret

object

apiSecret defines the secret’s key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

apiURL

string

apiURL defines the WeChat API URL. When not specified, defaults to the standard WeChat Work API endpoint.

corpID

string

corpID defines the corp id for authentication. This is the unique identifier for your WeChat Work organization.

httpConfig

object

httpConfig defines the HTTP client configuration for WeChat API requests.

message

string

message defines the API request data as defined by the WeChat API. This contains the actual notification content to be sent.

messageType

string

messageType defines the type of message to send. Valid values include "text", "markdown", and other WeChat Work supported message types.

sendResolved

boolean

sendResolved defines whether or not to notify about resolved alerts.

toParty

string

toParty defines the target department(s) to receive the notification. Can be a single department ID or multiple department IDs separated by '|'.

toTag

string

toTag defines the target tag(s) to receive the notification. Can be a single tag ID or multiple tag IDs separated by '|'.

toUser

string

toUser defines the target user(s) to receive the notification. Can be a single user ID or multiple user IDs separated by '|'.

Description
apiSecret defines the secret’s key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
httpConfig defines the HTTP client configuration for WeChat API requests.
Type
object
Expand
PropertyTypeDescription

authorization

object

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

basicAuth

object

basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyURL

string

proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
bearerTokenSecret defines 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 AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
object
Required
  • key
  • name
Expand
PropertyTypeDescription

key

string

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

name

string

name defines the name of the secret in the object’s namespace to select from.

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

3.1.567. .spec.route

Description
route defines the Alertmanager route definition for alerts matching the resource’s namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route.
Type
object
Expand
PropertyTypeDescription

activeTimeIntervals

array (string)

activeTimeIntervals is a list of TimeInterval names when this route should be active.

continue

boolean

continue defines the boolean indicating whether an alert should continue matching subsequent sibling nodes. It will always be overridden to true for the first-level route by the Prometheus operator.

groupBy

array (string)

groupBy defines the list of labels to group by. Labels must not be repeated (unique list). Special label "…​" (aggregate by all possible labels), if provided, must be the only element in the list.

groupInterval

string

groupInterval defines how long to wait before sending an updated notification. Must match the regular expression`^(()y)?(([0-9])w)?(()d)?(([0-9])h)?(()m)?(([0-9])s)?(([0-9]+)ms)?$` Example: "5m"

groupWait

string

groupWait defines how long to wait before sending the initial notification. Must match the regular expression`^(()y)?(([0-9])w)?(()d)?(([0-9])h)?(()m)?(([0-9])s)?(([0-9]+)ms)?$` Example: "30s"

matchers

array

matchers defines the list of matchers that the alert’s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher.

matchers[]

object

Matcher defines how to match on alert’s labels.

muteTimeIntervals

array (string)

muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,

receiver

string

receiver defines the name of the receiver for this route. If not empty, it should be listed in the receivers field.

repeatInterval

string

repeatInterval defines how long to wait before repeating the last notification. Must match the regular expression`^(()y)?(([0-9])w)?(()d)?(([0-9])h)?(()m)?(([0-9])s)?(([0-9]+)ms)?$` Example: "4h"

routes

array (undefined)

routes defines the child routes.

3.1.568. .spec.route.matchers

Description
matchers defines the list of matchers that the alert’s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher.
Type
array

3.1.569. .spec.route.matchers[]

Description
Matcher defines how to match on alert’s labels.
Type
object
Required
  • name
Expand
PropertyTypeDescription

matchType

string

matchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match).

name

string

name defines the label to match. This specifies which alert label should be evaluated.

value

string

value defines the label value to match. This is the expected value for the specified label.

3.1.570. .spec.timeIntervals

Description
timeIntervals defines the list of timeIntervals specifying when the routes should be muted.
Type
array

3.1.571. .spec.timeIntervals[]

Description
TimeInterval specifies the periods in time when notifications will be muted or active.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name of the time interval.

timeIntervals

array

timeIntervals defines a list of TimePeriod.

timeIntervals[]

object

TimePeriod describes periods of time.

3.1.572. .spec.timeIntervals[].timeIntervals

Description
timeIntervals defines a list of TimePeriod.
Type
array

3.1.573. .spec.timeIntervals[].timeIntervals[]

Description
TimePeriod describes periods of time.
Type
object
Expand
PropertyTypeDescription

daysOfMonth

array

daysOfMonth defines a list of DayOfMonthRange

daysOfMonth[]

object

DayOfMonthRange is an inclusive range of days of the month beginning at 1

months

array (string)

months defines a list of MonthRange

times

array

times defines a list of TimeRange

times[]

object

TimeRange defines a start and end time in 24hr format

weekdays

array (string)

weekdays defines a list of WeekdayRange

years

array (string)

years defines a list of YearRange

Description
daysOfMonth defines a list of DayOfMonthRange
Type
array
Description
DayOfMonthRange is an inclusive range of days of the month beginning at 1
Type
object
Expand
PropertyTypeDescription

end

integer

end of the inclusive range

start

integer

start of the inclusive range

Description
times defines a list of TimeRange
Type
array
Description
TimeRange defines a start and end time in 24hr format
Type
object
Expand
PropertyTypeDescription

endTime

string

endTime defines the end time in 24hr format.

startTime

string

startTime defines the start time in 24hr format.

3.2. API endpoints

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1beta1/alertmanagerconfigs

    • GET: list objects of kind AlertmanagerConfig
  • /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs

    • DELETE: delete collection of AlertmanagerConfig
    • GET: list objects of kind AlertmanagerConfig
    • POST: create an AlertmanagerConfig
  • /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs/{name}

    • DELETE: delete an AlertmanagerConfig
    • GET: read the specified AlertmanagerConfig
    • PATCH: partially update the specified AlertmanagerConfig
    • PUT: replace the specified AlertmanagerConfig
HTTP method
GET
Description
list objects of kind AlertmanagerConfig
Expand
Table 3.1. HTTP responses
HTTP codeReponse body

200 - OK

AlertmanagerConfigList schema

401 - Unauthorized

Empty

HTTP method
DELETE
Description
delete collection of AlertmanagerConfig
Expand
Table 3.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind AlertmanagerConfig
Expand
Table 3.3. HTTP responses
HTTP codeReponse body

200 - OK

AlertmanagerConfigList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create an AlertmanagerConfig
Expand
Table 3.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 3.5. Body parameters
ParameterTypeDescription

body

AlertmanagerConfig schema

 
Expand
Table 3.6. HTTP responses
HTTP codeReponse body

200 - OK

AlertmanagerConfig schema

201 - Created

AlertmanagerConfig schema

202 - Accepted

AlertmanagerConfig schema

401 - Unauthorized

Empty

Expand
Table 3.7. Global path parameters
ParameterTypeDescription

name

string

name of the AlertmanagerConfig

HTTP method
DELETE
Description
delete an AlertmanagerConfig
Expand
Table 3.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 3.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified AlertmanagerConfig
Expand
Table 3.10. HTTP responses
HTTP codeReponse body

200 - OK

AlertmanagerConfig schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified AlertmanagerConfig
Expand
Table 3.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 3.12. HTTP responses
HTTP codeReponse body

200 - OK

AlertmanagerConfig schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified AlertmanagerConfig
Expand
Table 3.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 3.14. Body parameters
ParameterTypeDescription

body

AlertmanagerConfig schema

 
Expand
Table 3.15. HTTP responses
HTTP codeReponse body

200 - OK

AlertmanagerConfig schema

201 - Created

AlertmanagerConfig schema

401 - Unauthorized

Empty

Description

AlertRelabelConfig defines a set of relabel configs for alerts.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
object
Required
  • spec

4.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

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

kind

string

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

metadata

ObjectMeta

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

spec

object

spec describes the desired state of this AlertRelabelConfig object.

status

object

status describes the current state of this AlertRelabelConfig object.

4.1.1. .spec

Description
spec describes the desired state of this AlertRelabelConfig object.
Type
object
Required
  • configs
Expand
PropertyTypeDescription

configs

array

configs is a list of sequentially evaluated alert relabel configs.

configs[]

object

RelabelConfig allows dynamic rewriting of label sets for alerts. See Prometheus documentation: - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

4.1.2. .spec.configs

Description
configs is a list of sequentially evaluated alert relabel configs.
Type
array

4.1.3. .spec.configs[]

Description
RelabelConfig allows dynamic rewriting of label sets for alerts. See Prometheus documentation: - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on regex matching. Must be one of: 'Replace', 'Keep', 'Drop', 'HashMod', 'LabelMap', 'LabelDrop', or 'LabelKeep'. Default is: 'Replace'

modulus

integer

modulus to take of the hash of the source label values. This can be combined with the 'HashMod' action to set 'target_label' to the 'modulus' of a hash of the concatenated 'source_labels'. This is only valid if sourceLabels is not empty and action is not 'LabelKeep' or 'LabelDrop'.

regex

string

regex against which the extracted value is matched. Default is: '(.*)' regex is required for all actions except 'HashMod'

replacement

string

replacement value against which a regex replace is performed if the regular expression matches. This is required if the action is 'Replace' or 'LabelMap' and forbidden for actions 'LabelKeep' and 'LabelDrop'. Regex capture groups are available. Default is: '$1'

separator

string

separator placed between concatenated source label values. When omitted, Prometheus will use its default value of ';'.

sourceLabels

array (string)

sourceLabels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the 'Replace', 'Keep', and 'Drop' actions. Not allowed for actions 'LabelKeep' and 'LabelDrop'.

targetLabel

string

targetLabel to which the resulting value is written in a 'Replace' action. It is required for 'Replace' and 'HashMod' actions and forbidden for actions 'LabelKeep' and 'LabelDrop'. Regex capture groups are available.

4.1.4. .status

Description
status describes the current state of this AlertRelabelConfig object.
Type
object
Expand
PropertyTypeDescription

conditions

array

conditions contains details on the state of the AlertRelabelConfig, may be empty.

conditions[]

object

Condition contains details for one aspect of the current state of this API Resource.

4.1.5. .status.conditions

Description
conditions contains details on the state of the AlertRelabelConfig, may be empty.
Type
array

4.1.6. .status.conditions[]

Description
Condition contains details for one aspect of the current state of this API Resource.
Type
object
Required
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message

string

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration

integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason

string

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status

string

status of the condition, one of True, False, Unknown.

type

string

type of condition in CamelCase or in foo.example.com/CamelCase.

4.2. API endpoints

The following API endpoints are available:

  • /apis/monitoring.openshift.io/v1/alertrelabelconfigs

    • GET: list objects of kind AlertRelabelConfig
  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs

    • DELETE: delete collection of AlertRelabelConfig
    • GET: list objects of kind AlertRelabelConfig
    • POST: create an AlertRelabelConfig
  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name}

    • DELETE: delete an AlertRelabelConfig
    • GET: read the specified AlertRelabelConfig
    • PATCH: partially update the specified AlertRelabelConfig
    • PUT: replace the specified AlertRelabelConfig
  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name}/status

    • GET: read status of the specified AlertRelabelConfig
    • PATCH: partially update status of the specified AlertRelabelConfig
    • PUT: replace status of the specified AlertRelabelConfig
HTTP method
GET
Description
list objects of kind AlertRelabelConfig
Expand
Table 4.1. HTTP responses
HTTP codeReponse body

200 - OK

AlertRelabelConfigList schema

401 - Unauthorized

Empty

HTTP method
DELETE
Description
delete collection of AlertRelabelConfig
Expand
Table 4.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind AlertRelabelConfig
Expand
Table 4.3. HTTP responses
HTTP codeReponse body

200 - OK

AlertRelabelConfigList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create an AlertRelabelConfig
Expand
Table 4.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 4.5. Body parameters
ParameterTypeDescription

body

AlertRelabelConfig schema

 
Expand
Table 4.6. HTTP responses
HTTP codeReponse body

200 - OK

AlertRelabelConfig schema

201 - Created

AlertRelabelConfig schema

202 - Accepted

AlertRelabelConfig schema

401 - Unauthorized

Empty

Expand
Table 4.7. Global path parameters
ParameterTypeDescription

name

string

name of the AlertRelabelConfig

HTTP method
DELETE
Description
delete an AlertRelabelConfig
Expand
Table 4.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 4.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified AlertRelabelConfig
Expand
Table 4.10. HTTP responses
HTTP codeReponse body

200 - OK

AlertRelabelConfig schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified AlertRelabelConfig
Expand
Table 4.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 4.12. HTTP responses
HTTP codeReponse body

200 - OK

AlertRelabelConfig schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified AlertRelabelConfig
Expand
Table 4.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 4.14. Body parameters
ParameterTypeDescription

body

AlertRelabelConfig schema

 
Expand
Table 4.15. HTTP responses
HTTP codeReponse body

200 - OK

AlertRelabelConfig schema

201 - Created

AlertRelabelConfig schema

401 - Unauthorized

Empty

Expand
Table 4.16. Global path parameters
ParameterTypeDescription

name

string

name of the AlertRelabelConfig

HTTP method
GET
Description
read status of the specified AlertRelabelConfig
Expand
Table 4.17. HTTP responses
HTTP codeReponse body

200 - OK

AlertRelabelConfig schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified AlertRelabelConfig
Expand
Table 4.18. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 4.19. HTTP responses
HTTP codeReponse body

200 - OK

AlertRelabelConfig schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified AlertRelabelConfig
Expand
Table 4.20. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 4.21. Body parameters
ParameterTypeDescription

body

AlertRelabelConfig schema

 
Expand
Table 4.22. HTTP responses
HTTP codeReponse body

200 - OK

AlertRelabelConfig schema

201 - Created

AlertRelabelConfig schema

401 - Unauthorized

Empty

Description

AlertingRule represents a set of user-defined Prometheus rule groups containing alerting rules. This resource is the supported method for cluster admins to create alerts based on metrics recorded by the platform monitoring stack in OpenShift, i.e. the Prometheus instance deployed to the openshift-monitoring namespace. You might use this to create custom alerting rules not shipped with OpenShift based on metrics from components such as the node_exporter, which provides machine-level metrics such as CPU usage, or kube-state-metrics, which provides metrics on Kubernetes usage.

The API is mostly compatible with the upstream PrometheusRule type from the prometheus-operator. The primary difference being that recording rules are not allowed here — only alerting rules. For each AlertingRule resource created, a corresponding PrometheusRule will be created in the openshift-monitoring namespace. OpenShift requires admins to use the AlertingRule resource rather than the upstream type in order to allow better OpenShift specific defaulting and validation, while not modifying the upstream APIs directly.

You can find upstream API documentation for PrometheusRule resources here:

https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
object
Required
  • spec

5.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

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

kind

string

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

metadata

ObjectMeta

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

spec

object

spec describes the desired state of this AlertingRule object.

status

object

status describes the current state of this AlertOverrides object.

5.1.1. .spec

Description
spec describes the desired state of this AlertingRule object.
Type
object
Required
  • groups
Expand
PropertyTypeDescription

groups

array

groups is a list of grouped alerting rules. Rule groups are the unit at which Prometheus parallelizes rule processing. All rules in a single group share a configured evaluation interval. All rules in the group will be processed together on this interval, sequentially, and all rules will be processed.

It’s common to group related alerting rules into a single AlertingRule resources, and within that resource, closely related alerts, or simply alerts with the same interval, into individual groups. You are also free to create AlertingRule resources with only a single rule group, but be aware that this can have a performance impact on Prometheus if the group is extremely large or has very complex query expressions to evaluate. Spreading very complex rules across multiple groups to allow them to be processed in parallel is also a common use-case.

groups[]

object

RuleGroup is a list of sequentially evaluated alerting rules.

5.1.2. .spec.groups

Description

groups is a list of grouped alerting rules. Rule groups are the unit at which Prometheus parallelizes rule processing. All rules in a single group share a configured evaluation interval. All rules in the group will be processed together on this interval, sequentially, and all rules will be processed.

It’s common to group related alerting rules into a single AlertingRule resources, and within that resource, closely related alerts, or simply alerts with the same interval, into individual groups. You are also free to create AlertingRule resources with only a single rule group, but be aware that this can have a performance impact on Prometheus if the group is extremely large or has very complex query expressions to evaluate. Spreading very complex rules across multiple groups to allow them to be processed in parallel is also a common use-case.

Type
array

5.1.3. .spec.groups[]

Description
RuleGroup is a list of sequentially evaluated alerting rules.
Type
object
Required
  • name
  • rules
Expand
PropertyTypeDescription

interval

string

interval is how often rules in the group are evaluated. If not specified, it defaults to the global.evaluation_interval configured in Prometheus, which itself defaults to 30 seconds. You can check if this value has been modified from the default on your cluster by inspecting the platform Prometheus configuration: The relevant field in that resource is: spec.evaluationInterval

name

string

name is the name of the group.

rules

array

rules is a list of sequentially evaluated alerting rules. Prometheus may process rule groups in parallel, but rules within a single group are always processed sequentially, and all rules are processed.

rules[]

object

Rule describes an alerting rule. See Prometheus documentation: - https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules

5.1.4. .spec.groups[].rules

Description
rules is a list of sequentially evaluated alerting rules. Prometheus may process rule groups in parallel, but rules within a single group are always processed sequentially, and all rules are processed.
Type
array

5.1.5. .spec.groups[].rules[]

Description
Rule describes an alerting rule. See Prometheus documentation: - https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules
Type
object
Required
  • alert
  • expr
Expand
PropertyTypeDescription

alert

string

alert is the name of the alert. Must be a valid label value, i.e. may contain any Unicode character.

annotations

object (string)

annotations to add to each alert. These are values that can be used to store longer additional information that you won’t query on, such as alert descriptions or runbook links.

expr

integer-or-string

expr is the PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending or firing alerts. This is most often a string representing a PromQL expression, e.g.: mapi_current_pending_csr > mapi_max_pending_csr In rare cases this could be a simple integer, e.g. a simple "1" if the intent is to create an alert that is always firing. This is sometimes used to create an always-firing "Watchdog" alert in order to ensure the alerting pipeline is functional.

for

string

for is the time period after which alerts are considered firing after first returning results. Alerts which have not yet fired for long enough are considered pending.

labels

object (string)

labels to add or overwrite for each alert. The results of the PromQL expression for the alert will result in an existing set of labels for the alert, after evaluating the expression, for any label specified here with the same name as a label in that set, the label here wins and overwrites the previous value. These should typically be short identifying values that may be useful to query against. A common example is the alert severity, where one sets severity: warning under the labels key:

5.1.6. .status

Description
status describes the current state of this AlertOverrides object.
Type
object
Expand
PropertyTypeDescription

observedGeneration

integer

observedGeneration is the last generation change you’ve dealt with.

prometheusRule

object

prometheusRule is the generated PrometheusRule for this AlertingRule. Each AlertingRule instance results in a generated PrometheusRule object in the same namespace, which is always the openshift-monitoring namespace.

5.1.7. .status.prometheusRule

Description
prometheusRule is the generated PrometheusRule for this AlertingRule. Each AlertingRule instance results in a generated PrometheusRule object in the same namespace, which is always the openshift-monitoring namespace.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name of the referenced PrometheusRule.

5.2. API endpoints

The following API endpoints are available:

  • /apis/monitoring.openshift.io/v1/alertingrules

    • GET: list objects of kind AlertingRule
  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules

    • DELETE: delete collection of AlertingRule
    • GET: list objects of kind AlertingRule
    • POST: create an AlertingRule
  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules/{name}

    • DELETE: delete an AlertingRule
    • GET: read the specified AlertingRule
    • PATCH: partially update the specified AlertingRule
    • PUT: replace the specified AlertingRule
  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules/{name}/status

    • GET: read status of the specified AlertingRule
    • PATCH: partially update status of the specified AlertingRule
    • PUT: replace status of the specified AlertingRule
HTTP method
GET
Description
list objects of kind AlertingRule
Expand
Table 5.1. HTTP responses
HTTP codeReponse body

200 - OK

AlertingRuleList schema

401 - Unauthorized

Empty

HTTP method
DELETE
Description
delete collection of AlertingRule
Expand
Table 5.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind AlertingRule
Expand
Table 5.3. HTTP responses
HTTP codeReponse body

200 - OK

AlertingRuleList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create an AlertingRule
Expand
Table 5.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 5.5. Body parameters
ParameterTypeDescription

body

AlertingRule schema

 
Expand
Table 5.6. HTTP responses
HTTP codeReponse body

200 - OK

AlertingRule schema

201 - Created

AlertingRule schema

202 - Accepted

AlertingRule schema

401 - Unauthorized

Empty

Expand
Table 5.7. Global path parameters
ParameterTypeDescription

name

string

name of the AlertingRule

HTTP method
DELETE
Description
delete an AlertingRule
Expand
Table 5.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 5.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified AlertingRule
Expand
Table 5.10. HTTP responses
HTTP codeReponse body

200 - OK

AlertingRule schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified AlertingRule
Expand
Table 5.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 5.12. HTTP responses
HTTP codeReponse body

200 - OK

AlertingRule schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified AlertingRule
Expand
Table 5.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 5.14. Body parameters
ParameterTypeDescription

body

AlertingRule schema

 
Expand
Table 5.15. HTTP responses
HTTP codeReponse body

200 - OK

AlertingRule schema

201 - Created

AlertingRule schema

401 - Unauthorized

Empty

Expand
Table 5.16. Global path parameters
ParameterTypeDescription

name

string

name of the AlertingRule

HTTP method
GET
Description
read status of the specified AlertingRule
Expand
Table 5.17. HTTP responses
HTTP codeReponse body

200 - OK

AlertingRule schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified AlertingRule
Expand
Table 5.18. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 5.19. HTTP responses
HTTP codeReponse body

200 - OK

AlertingRule schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified AlertingRule
Expand
Table 5.20. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 5.21. Body parameters
ParameterTypeDescription

body

AlertingRule schema

 
Expand
Table 5.22. HTTP responses
HTTP codeReponse body

200 - OK

AlertingRule schema

201 - Created

AlertingRule schema

401 - Unauthorized

Empty

Description

DataGather provides data gather configuration options and status for the particular Insights data gathering.

Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.

Type
object
Required
  • spec

6.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

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

kind

string

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

metadata

ObjectMeta

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

spec

object

spec holds user settable values for configuration

status

object

status holds observed values from the cluster. They may not be overridden.

6.1.1. .spec

Description
spec holds user settable values for configuration
Type
object
Expand
PropertyTypeDescription

dataPolicy

array (string)

dataPolicy is an optional list of DataPolicyOptions that allows user to enable additional obfuscation of the Insights archive data. It may not exceed 2 items and must not contain duplicates. Valid values are ObfuscateNetworking and WorkloadNames. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When set to WorkloadNames, the gathered data about cluster resources will not contain the workload names for your deployments. Resources UIDs will be used instead. When omitted no obfuscation is applied.

gatherers

object

gatherers is an optional field that specifies the configuration of the gatherers. If omitted, all gatherers will be run.

storage

object

storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive. If omitted, the gathering job will use ephemeral storage.

6.1.2. .spec.gatherers

Description
gatherers is an optional field that specifies the configuration of the gatherers. If omitted, all gatherers will be run.
Type
object
Required
  • mode
Expand
PropertyTypeDescription

custom

object

custom provides gathering configuration. It is required when mode is Custom, and forbidden otherwise. Custom configuration allows user to disable only a subset of gatherers. Gatherers that are not explicitly disabled in custom configuration will run.

mode

string

mode is a required field that specifies the mode for gatherers. Allowed values are All and Custom. When set to All, all gatherers wil run and gather data. When set to Custom, the custom configuration from the custom field will be applied.

6.1.3. .spec.gatherers.custom

Description
custom provides gathering configuration. It is required when mode is Custom, and forbidden otherwise. Custom configuration allows user to disable only a subset of gatherers. Gatherers that are not explicitly disabled in custom configuration will run.
Type
object
Required
  • configs
Expand
PropertyTypeDescription

configs

array

configs is a required list of gatherers configurations that can be used to enable or disable specific gatherers. It may not exceed 100 items and each gatherer can be present only once. It is possible to disable an entire set of gatherers while allowing a specific function within that set. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: "oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'"

configs[]

object

gathererConfig allows to configure specific gatherers

6.1.4. .spec.gatherers.custom.configs

Description
configs is a required list of gatherers configurations that can be used to enable or disable specific gatherers. It may not exceed 100 items and each gatherer can be present only once. It is possible to disable an entire set of gatherers while allowing a specific function within that set. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: "oc get insightsoperators.operator.openshift.io cluster -o json \| jq '.status.gatherStatus.gatherers[].name'"
Type
array

6.1.5. .spec.gatherers.custom.configs[]

Description
gathererConfig allows to configure specific gatherers
Type
object
Required
  • name
  • state
Expand
PropertyTypeDescription

name

string

name is the required name of a specific gatherer It may not exceed 256 characters. The format for a gatherer name is: {gatherer}/{function} where the function is optional. Gatherer consists of a lowercase letters only that may include underscores (). Function consists of a lowercase letters only that may include underscores () and is separated from the gatherer by a forward slash (/). The particular gatherers can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: "oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'"

state

string

state is a required field that allows you to configure specific gatherer. Valid values are "Enabled" and "Disabled". When set to Enabled the gatherer will run. When set to Disabled the gatherer will not run.

6.1.6. .spec.storage

Description
storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive. If omitted, the gathering job will use ephemeral storage.
Type
object
Required
  • type
Expand
PropertyTypeDescription

persistentVolume

object

persistentVolume is an optional field that specifies the PersistentVolume that will be used to store the Insights data archive. The PersistentVolume must be created in the openshift-insights namespace.

type

string

type is a required field that specifies the type of storage that will be used to store the Insights data archive. Valid values are "PersistentVolume" and "Ephemeral". When set to Ephemeral, the Insights data archive is stored in the ephemeral storage of the gathering job. When set to PersistentVolume, the Insights data archive is stored in the PersistentVolume that is defined by the PersistentVolume field.

6.1.7. .spec.storage.persistentVolume

Description
persistentVolume is an optional field that specifies the PersistentVolume that will be used to store the Insights data archive. The PersistentVolume must be created in the openshift-insights namespace.
Type
object
Required
  • claim
Expand
PropertyTypeDescription

claim

object

claim is a required field that specifies the configuration of the PersistentVolumeClaim that will be used to store the Insights data archive. The PersistentVolumeClaim must be created in the openshift-insights namespace.

mountPath

string

mountPath is an optional field specifying the directory where the PVC will be mounted inside the Insights data gathering Pod. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default mount path is /var/lib/insights-operator The path may not exceed 1024 characters and must not contain a colon.

6.1.8. .spec.storage.persistentVolume.claim

Description
claim is a required field that specifies the configuration of the PersistentVolumeClaim that will be used to store the Insights data archive. The PersistentVolumeClaim must be created in the openshift-insights namespace.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name is a string that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start and end with an alphanumeric character.

6.1.9. .status

Description
status holds observed values from the cluster. They may not be overridden.
Type
object
Expand
PropertyTypeDescription

conditions

array

conditions is an optional field that provides details on the status of the gatherer job. It may not exceed 100 items and must not contain duplicates.

The current condition types are DataUploaded, DataRecorded, DataProcessed, RemoteConfigurationNotAvailable, RemoteConfigurationInvalid

The DataUploaded condition is used to represent whether or not the archive was successfully uploaded for further processing. When it has a status of True and a reason of Succeeded, the archive was successfully uploaded. When it has a status of Unknown and a reason of NoUploadYet, the upload has not occurred, or there was no data to upload. When it has a status of False and a reason Failed, the upload failed. The accompanying message will include the specific error encountered.

The DataRecorded condition is used to represent whether or not the archive was successfully recorded. When it has a status of True and a reason of Succeeded, the archive was recorded successfully. When it has a status of Unknown and a reason of NoDataGatheringYet, the data gathering process has not started yet. When it has a status of False and a reason of RecordingFailed, the recording failed and a message will include the specific error encountered.

The DataProcessed condition is used to represent whether or not the archive was processed by the processing service. When it has a status of True and a reason of Processed, the data was processed successfully. When it has a status of Unknown and a reason of NothingToProcessYet, there is no data to process at the moment. When it has a status of False and a reason of Failure, processing failed and a message will include the specific error encountered.

The RemoteConfigurationAvailable condition is used to represent whether the remote configuration is available. When it has a status of Unknown and a reason of Unknown or RemoteConfigNotRequestedYet, the state of the remote configuration is unknown—typically at startup. When it has a status of True and a reason of Succeeded, the configuration is available. When it has a status of False and a reason of NoToken, the configuration was disabled by removing the cloud.openshift.com field from the pull secret. When it has a status of False and a reason of DisabledByConfiguration, the configuration was disabled in insightsdatagather.config.openshift.io.

The RemoteConfigurationValid condition is used to represent whether the remote configuration is valid. When it has a status of Unknown and a reason of Unknown or NoValidationYet, the validity of the remote configuration is unknown—typically at startup. When it has a status of True and a reason of Succeeded, the configuration is valid. When it has a status of False and a reason of Invalid, the configuration is invalid.

The Progressing condition is used to represent the phase of gathering When it has a status of False and the reason is DataGatherPending, the gathering has not started yet. When it has a status of True and reason is Gathering, the gathering is running. When it has a status of False and reason is GatheringSucceeded, the gathering succesfully finished. When it has a status of False and reason is GatheringFailed, the gathering failed.

conditions[]

object

Condition contains details for one aspect of the current state of this API Resource.

finishTime

string

finishTime is the time when Insights data gathering finished.

gatherers

array

gatherers is a list of active gatherers (and their statuses) in the last gathering.

gatherers[]

object

gathererStatus represents information about a particular data gatherer.

insightsReport

object

insightsReport provides general Insights analysis results. When omitted, this means no data gathering has taken place yet or the corresponding Insights analysis (identified by "insightsRequestID") is not available.

insightsRequestID

string

insightsRequestID is an optional Insights request ID to track the status of the Insights analysis (in console.redhat.com processing pipeline) for the corresponding Insights data archive. It may not exceed 256 characters and is immutable once set.

relatedObjects

array

relatedObjects is an optional list of resources which are useful when debugging or inspecting the data gathering Pod It may not exceed 100 items and must not contain duplicates.

relatedObjects[]

object

ObjectReference contains enough information to let you inspect or modify the referred object.

startTime

string

startTime is the time when Insights data gathering started.

6.1.10. .status.conditions

Description

conditions is an optional field that provides details on the status of the gatherer job. It may not exceed 100 items and must not contain duplicates.

The current condition types are DataUploaded, DataRecorded, DataProcessed, RemoteConfigurationNotAvailable, RemoteConfigurationInvalid

The DataUploaded condition is used to represent whether or not the archive was successfully uploaded for further processing. When it has a status of True and a reason of Succeeded, the archive was successfully uploaded. When it has a status of Unknown and a reason of NoUploadYet, the upload has not occurred, or there was no data to upload. When it has a status of False and a reason Failed, the upload failed. The accompanying message will include the specific error encountered.

The DataRecorded condition is used to represent whether or not the archive was successfully recorded. When it has a status of True and a reason of Succeeded, the archive was recorded successfully. When it has a status of Unknown and a reason of NoDataGatheringYet, the data gathering process has not started yet. When it has a status of False and a reason of RecordingFailed, the recording failed and a message will include the specific error encountered.

The DataProcessed condition is used to represent whether or not the archive was processed by the processing service. When it has a status of True and a reason of Processed, the data was processed successfully. When it has a status of Unknown and a reason of NothingToProcessYet, there is no data to process at the moment. When it has a status of False and a reason of Failure, processing failed and a message will include the specific error encountered.

The RemoteConfigurationAvailable condition is used to represent whether the remote configuration is available. When it has a status of Unknown and a reason of Unknown or RemoteConfigNotRequestedYet, the state of the remote configuration is unknown—typically at startup. When it has a status of True and a reason of Succeeded, the configuration is available. When it has a status of False and a reason of NoToken, the configuration was disabled by removing the cloud.openshift.com field from the pull secret. When it has a status of False and a reason of DisabledByConfiguration, the configuration was disabled in insightsdatagather.config.openshift.io.

The RemoteConfigurationValid condition is used to represent whether the remote configuration is valid. When it has a status of Unknown and a reason of Unknown or NoValidationYet, the validity of the remote configuration is unknown—typically at startup. When it has a status of True and a reason of Succeeded, the configuration is valid. When it has a status of False and a reason of Invalid, the configuration is invalid.

The Progressing condition is used to represent the phase of gathering When it has a status of False and the reason is DataGatherPending, the gathering has not started yet. When it has a status of True and reason is Gathering, the gathering is running. When it has a status of False and reason is GatheringSucceeded, the gathering succesfully finished. When it has a status of False and reason is GatheringFailed, the gathering failed.

Type
array

6.1.11. .status.conditions[]

Description
Condition contains details for one aspect of the current state of this API Resource.
Type
object
Required
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message

string

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration

integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason

string

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status

string

status of the condition, one of True, False, Unknown.

type

string

type of condition in CamelCase or in foo.example.com/CamelCase.

6.1.12. .status.gatherers

Description
gatherers is a list of active gatherers (and their statuses) in the last gathering.
Type
array

6.1.13. .status.gatherers[]

Description
gathererStatus represents information about a particular data gatherer.
Type
object
Required
  • lastGatherSeconds
  • name
Expand
PropertyTypeDescription

conditions

array

conditions provide details on the status of each gatherer.

The current condition type is DataGathered

The DataGathered condition is used to represent whether or not the data was gathered by a gatherer specified by name. When it has a status of True and a reason of GatheredOK, the data has been successfully gathered as expected. When it has a status of False and a reason of NoData, no data was gathered—for example, when the resource is not present in the cluster. When it has a status of False and a reason of GatherError, an error occurred and no data was gathered. When it has a status of False and a reason of GatherPanic, a panic occurred during gathering and no data was collected. When it has a status of False and a reason of GatherWithErrorReason, data was partially gathered or gathered with an error message.

conditions[]

object

Condition contains details for one aspect of the current state of this API Resource.

lastGatherSeconds

integer

lastGatherSeconds is required field that represents the time spent gathering in seconds

name

string

name is the required name of the gatherer. It must contain at least 5 characters and may not exceed 256 characters.

6.1.14. .status.gatherers[].conditions

Description

conditions provide details on the status of each gatherer.

The current condition type is DataGathered

The DataGathered condition is used to represent whether or not the data was gathered by a gatherer specified by name. When it has a status of True and a reason of GatheredOK, the data has been successfully gathered as expected. When it has a status of False and a reason of NoData, no data was gathered—for example, when the resource is not present in the cluster. When it has a status of False and a reason of GatherError, an error occurred and no data was gathered. When it has a status of False and a reason of GatherPanic, a panic occurred during gathering and no data was collected. When it has a status of False and a reason of GatherWithErrorReason, data was partially gathered or gathered with an error message.

Type
array

6.1.15. .status.gatherers[].conditions[]

Description
Condition contains details for one aspect of the current state of this API Resource.
Type
object
Required
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message

string

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration

integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason

string

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status

string

status of the condition, one of True, False, Unknown.

type

string

type of condition in CamelCase or in foo.example.com/CamelCase.

6.1.16. .status.insightsReport

Description
insightsReport provides general Insights analysis results. When omitted, this means no data gathering has taken place yet or the corresponding Insights analysis (identified by "insightsRequestID") is not available.
Type
object
Expand
PropertyTypeDescription

downloadedTime

string

downloadedTime is an optional time when the last Insights report was downloaded. An empty value means that there has not been any Insights report downloaded yet and it usually appears in disconnected clusters (or clusters when the Insights data gathering is disabled).

healthChecks

array

healthChecks provides basic information about active Insights health checks in a cluster.

healthChecks[]

object

healthCheck represents an Insights health check attributes.

uri

string

uri is optional field that provides the URL link from which the report was downloaded. The link must be a valid HTTPS URL and the maximum length is 2048 characters.

6.1.17. .status.insightsReport.healthChecks

Description
healthChecks provides basic information about active Insights health checks in a cluster.
Type
array

6.1.18. .status.insightsReport.healthChecks[]

Description
healthCheck represents an Insights health check attributes.
Type
object
Required
  • advisorURI
  • description
  • totalRisk
Expand
PropertyTypeDescription

advisorURI

string

advisorURI is required field that provides the URL link to the Insights Advisor. The link must be a valid HTTPS URL and the maximum length is 2048 characters.

description

string

description is required field that provides basic description of the healtcheck. It must contain at least 10 characters and may not exceed 2048 characters.

totalRisk

string

totalRisk is the required field of the healthcheck. It is indicator of the total risk posed by the detected issue; combination of impact and likelihood. Allowed values are Low, Medium, Important and Critical. The value represents the severity of the issue.

6.1.19. .status.relatedObjects

Description
relatedObjects is an optional list of resources which are useful when debugging or inspecting the data gathering Pod It may not exceed 100 items and must not contain duplicates.
Type
array

6.1.20. .status.relatedObjects[]

Description
ObjectReference contains enough information to let you inspect or modify the referred object.
Type
object
Required
  • group
  • name
  • namespace
  • resource
Expand
PropertyTypeDescription

group

string

group is required field that specifies the API Group of the Resource. Enter empty string for the core group. This value is empty or it should follow the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start with an alphabetic character and end with an alphanumeric character. Example: "", "apps", "build.openshift.io", etc.

name

string

name is required field that specifies the referent that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start with an alphabetic character and end with an alphanumeric character..

namespace

string

namespace if required field of the referent that follows the DNS1123 labels format. It must be at most 63 characters in length, and must must consist of only lowercase alphanumeric characters and hyphens, and must start with an alphabetic character and end with an alphanumeric character.

resource

string

resource is required field of the type that is being referenced and follows the DNS1035 format. It is normally the plural form of the resource kind in lowercase. It must be at most 63 characters in length, and must must consist of only lowercase alphanumeric characters and hyphens, and must start with an alphabetic character and end with an alphanumeric character. Example: "deployments", "deploymentconfigs", "pods", etc.

6.2. API endpoints

The following API endpoints are available:

  • /apis/insights.openshift.io/v1alpha2/datagathers

    • DELETE: delete collection of DataGather
    • GET: list objects of kind DataGather
    • POST: create a DataGather
  • /apis/insights.openshift.io/v1alpha2/datagathers/{name}

    • DELETE: delete a DataGather
    • GET: read the specified DataGather
    • PATCH: partially update the specified DataGather
    • PUT: replace the specified DataGather
  • /apis/insights.openshift.io/v1alpha2/datagathers/{name}/status

    • GET: read status of the specified DataGather
    • PATCH: partially update status of the specified DataGather
    • PUT: replace status of the specified DataGather
HTTP method
DELETE
Description
delete collection of DataGather
Expand
Table 6.1. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind DataGather
Expand
Table 6.2. HTTP responses
HTTP codeReponse body

200 - OK

DataGatherList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a DataGather
Expand
Table 6.3. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 6.4. Body parameters
ParameterTypeDescription

body

DataGather schema

 
Expand
Table 6.5. HTTP responses
HTTP codeReponse body

200 - OK

DataGather schema

201 - Created

DataGather schema

202 - Accepted

DataGather schema

401 - Unauthorized

Empty

Expand
Table 6.6. Global path parameters
ParameterTypeDescription

name

string

name of the DataGather

HTTP method
DELETE
Description
delete a DataGather
Expand
Table 6.7. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 6.8. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified DataGather
Expand
Table 6.9. HTTP responses
HTTP codeReponse body

200 - OK

DataGather schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified DataGather
Expand
Table 6.10. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 6.11. HTTP responses
HTTP codeReponse body

200 - OK

DataGather schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified DataGather
Expand
Table 6.12. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 6.13. Body parameters
ParameterTypeDescription

body

DataGather schema

 
Expand
Table 6.14. HTTP responses
HTTP codeReponse body

200 - OK

DataGather schema

201 - Created

DataGather schema

401 - Unauthorized

Empty

Expand
Table 6.15. Global path parameters
ParameterTypeDescription

name

string

name of the DataGather

HTTP method
GET
Description
read status of the specified DataGather
Expand
Table 6.16. HTTP responses
HTTP codeReponse body

200 - OK

DataGather schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified DataGather
Expand
Table 6.17. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 6.18. HTTP responses
HTTP codeReponse body

200 - OK

DataGather schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified DataGather
Expand
Table 6.19. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 6.20. Body parameters
ParameterTypeDescription

body

DataGather schema

 
Expand
Table 6.21. HTTP responses
HTTP codeReponse body

200 - OK

DataGather schema

201 - Created

DataGather schema

401 - Unauthorized

Empty

Chapter 7. PodMonitor [monitoring.coreos.com/v1]

Description

The PodMonitor custom resource definition (CRD) defines how Prometheus and PrometheusAgent can scrape metrics from a group of pods. Among other things, it allows to specify: * The pods to scrape via label selectors. * The container ports to scrape. * Authentication credentials to use. * Target and metric relabeling.

Prometheus and PrometheusAgent objects select PodMonitor objects using label and namespace selectors.

Type
object
Required
  • spec

7.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

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

kind

string

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

metadata

ObjectMeta

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

spec

object

spec defines the specification of desired Pod selection for target discovery by Prometheus.

status

object

status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.

Most recent observed status of the PodMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

7.1.1. .spec

Description
spec defines the specification of desired Pod selection for target discovery by Prometheus.
Type
object
Required
  • selector
Expand
PropertyTypeDescription

attachMetadata

object

attachMetadata defines additional metadata which is added to the discovered targets.

It requires Prometheus >= v2.35.0.

bodySizeLimit

string

bodySizeLimit when defined specifies a job level limit on the size of uncompressed response body that will be accepted by Prometheus.

It requires Prometheus >= v2.28.0.

convertClassicHistogramsToNHCB

boolean

convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.

fallbackScrapeProtocol

string

fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.

It requires Prometheus >= v3.0.0.

jobLabel

string

jobLabel defines the label to use to retrieve the job name from. jobLabel selects the label from the associated Kubernetes Pod object which will be used as the job label for all metrics.

For example if jobLabel is set to foo and the Kubernetes Pod object is labeled with foo: bar, then Prometheus adds the job="bar" label to all ingested metrics.

If the value of this field is empty, the job label of the metrics defaults to the namespace and name of the PodMonitor object (e.g. <namespace>/<name>).

keepDroppedTargets

integer

keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.

It requires Prometheus >= v2.47.0.

labelLimit

integer

labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample.

It requires Prometheus >= v2.27.0.

labelNameLengthLimit

integer

labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample.

It requires Prometheus >= v2.27.0.

labelValueLengthLimit

integer

labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample.

It requires Prometheus >= v2.27.0.

namespaceSelector

object

namespaceSelector defines in which namespace(s) Prometheus should discover the pods. By default, the pods are discovered in the same namespace as the PodMonitor object but it is possible to select pods across different/all namespaces.

nativeHistogramBucketLimit

integer

nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0.

nativeHistogramMinBucketFactor

integer-or-string

nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0.

podMetricsEndpoints

array

podMetricsEndpoints defines how to scrape metrics from the selected pods.

podMetricsEndpoints[]

object

PodMetricsEndpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.

podTargetLabels

array (string)

podTargetLabels defines the labels which are transferred from the associated Kubernetes Pod object onto the ingested metrics.

sampleLimit

integer

sampleLimit defines a per-scrape limit on the number of scraped samples that will be accepted.

scrapeClass

string

scrapeClass defines the scrape class to apply.

scrapeClassicHistograms

boolean

scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.

Notice: scrapeClassicHistograms corresponds to the always_scrape_classic_histograms field in the Prometheus configuration.

scrapeProtocols

array (string)

scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred).

If unset, Prometheus uses its default value.

It requires Prometheus >= v2.49.0.

selector

object

selector defines the label selector to select the Kubernetes Pod objects to scrape metrics from.

selectorMechanism

string

selectorMechanism defines the mechanism used to select the endpoints to scrape. By default, the selection process relies on relabel configurations to filter the discovered targets. Alternatively, you can opt in for role selectors, which may offer better efficiency in large clusters. Which strategy is best for your use case needs to be carefully evaluated.

It requires Prometheus >= v2.17.0.

targetLimit

integer

targetLimit defines a limit on the number of scraped targets that will be accepted.

7.1.2. .spec.attachMetadata

Description

attachMetadata defines additional metadata which is added to the discovered targets.

It requires Prometheus >= v2.35.0.

Type
object
Expand
PropertyTypeDescription

node

boolean

node when set to true, Prometheus attaches node metadata to the discovered targets.

The Prometheus service account must have the list and watch permissions on the Nodes objects.

7.1.3. .spec.namespaceSelector

Description
namespaceSelector defines in which namespace(s) Prometheus should discover the pods. By default, the pods are discovered in the same namespace as the PodMonitor object but it is possible to select pods across different/all namespaces.
Type
object
Expand
PropertyTypeDescription

any

boolean

any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them.

matchNames

array (string)

matchNames defines the list of namespace names to select from.

7.1.4. .spec.podMetricsEndpoints

Description
podMetricsEndpoints defines how to scrape metrics from the selected pods.
Type
array

7.1.5. .spec.podMetricsEndpoints[]

Description
PodMetricsEndpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.
Type
object
Expand
PropertyTypeDescription

authorization

object

authorization configures the Authorization header credentials used by the client.

Cannot be set at the same time as basicAuth, bearerTokenSecret or oauth2.

basicAuth

object

basicAuth defines the Basic Authentication credentials used by the client.

Cannot be set at the same time as authorization, bearerTokenSecret or oauth2.

bearerTokenSecret

object

bearerTokenSecret defines a key of a Secret containing the bearer token used by the client for authentication. The secret needs to be in the same namespace as the custom resource and readable by the Prometheus Operator.

Cannot be set at the same time as authorization, basicAuth or oauth2.

Deprecated: use authorization instead.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2.

filterRunning

boolean

filterRunning when true, the pods which are not running (e.g. either in Failed or Succeeded state) are dropped during the target discovery.

If unset, the filtering is enabled.

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase

followRedirects

boolean

followRedirects defines whether the client should follow HTTP 3xx redirects.

honorLabels

boolean

honorLabels when true preserves the metric’s labels when they collide with the target’s labels.

honorTimestamps

boolean

honorTimestamps defines whether Prometheus preserves the timestamps when exposed by the target.

interval

string

interval at which Prometheus scrapes the metrics from the target.

If empty, Prometheus uses the global scrape interval.

metricRelabelings

array

metricRelabelings defines the relabeling rules to apply to the samples before ingestion.

metricRelabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 settings used by the client.

It requires Prometheus >= 2.27.0.

Cannot be set at the same time as authorization, basicAuth or bearerTokenSecret.

params

object

params define optional HTTP URL parameters.

params{}

array (string)

 

path

string

path defines the HTTP path from which to scrape for metrics.

If empty, Prometheus uses the default value (e.g. /metrics).

port

string

port defines the Pod port name which exposes the endpoint.

If the pod doesn’t expose a port with the same name, it will result in no targets being discovered.

If a Pod has multiple Port values with the same name (which is not recommended), one target instance per unique port number will be generated.

It takes precedence over the portNumber and targetPort fields.

portNumber

integer

portNumber defines the Pod port number which exposes the endpoint.

The Pod must declare the specified Port in its spec or the target will be dropped by Prometheus.

This cannot be used to enable scraping of an undeclared port. To scrape targets on a port which isn’t exposed, you need to use relabeling to override the address label (but beware of duplicate targets if the Pod has other declared ports).

In practice Prometheus will select targets for which the matches the target’s __meta_kubernetes_pod_container_port_number.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

relabelings

array

relabelings defines the relabeling rules to apply the target’s metadata labels.

The Operator automatically adds relabelings for a few standard Kubernetes fields.

The original scrape job’s name is available via the \__tmp_prometheus_job_name label.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

scheme

string

scheme defines the HTTP scheme to use for scraping.

scrapeTimeout

string

scrapeTimeout defines the timeout after which Prometheus considers the scrape to be failed.

If empty, Prometheus uses the global scrape timeout unless it is less than the target’s scrape interval value in which the latter is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.

targetPort

integer-or-string

targetPort defines the name or number of the target port of the Pod object behind the Service, the port must be specified with container port property.

Deprecated: use 'port' or 'portNumber' instead.

tlsConfig

object

tlsConfig defines the TLS configuration used by the client.

trackTimestampsStaleness

boolean

trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if honorTimestamps is false.

It requires Prometheus >= v2.48.0.

7.1.6. .spec.podMetricsEndpoints[].authorization

Description

authorization configures the Authorization header credentials used by the client.

Cannot be set at the same time as basicAuth, bearerTokenSecret or oauth2.

Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

7.1.8. .spec.podMetricsEndpoints[].basicAuth

Description

basicAuth defines the Basic Authentication credentials used by the client.

Cannot be set at the same time as authorization, bearerTokenSecret or oauth2.

Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

bearerTokenSecret defines a key of a Secret containing the bearer token used by the client for authentication. The secret needs to be in the same namespace as the custom resource and readable by the Prometheus Operator.

Cannot be set at the same time as authorization, basicAuth or oauth2.

Deprecated: use authorization instead.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
metricRelabelings defines the relabeling rules to apply to the samples before ingestion.
Type
array
Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

7.1.14. .spec.podMetricsEndpoints[].oauth2

Description

oauth2 defines the OAuth2 settings used by the client.

It requires Prometheus >= 2.27.0.

Cannot be set at the same time as authorization, basicAuth or bearerTokenSecret.

Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

7.1.30. .spec.podMetricsEndpoints[].params

Description
params define optional HTTP URL parameters.
Type
object
Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

7.1.34. .spec.podMetricsEndpoints[].relabelings

Description

relabelings defines the relabeling rules to apply the target’s metadata labels.

The Operator automatically adds relabelings for a few standard Kubernetes fields.

The original scrape job’s name is available via the \__tmp_prometheus_job_name label.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
array

7.1.35. .spec.podMetricsEndpoints[].relabelings[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

7.1.36. .spec.podMetricsEndpoints[].tlsConfig

Description
tlsConfig defines the TLS configuration used by the client.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

7.1.37. .spec.podMetricsEndpoints[].tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

7.1.40. .spec.podMetricsEndpoints[].tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

7.1.44. .spec.selector

Description
selector defines the label selector to select the Kubernetes Pod objects to scrape metrics from.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

7.1.45. .spec.selector.matchExpressions

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

7.1.46. .spec.selector.matchExpressions[]

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

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

7.1.47. .status

Description

status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.

Most recent observed status of the PodMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Type
object
Expand
PropertyTypeDescription

bindings

array

bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.

bindings[]

object

WorkloadBinding is a link between a configuration resource and a workload resource.

7.1.48. .status.bindings

Description
bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
Type
array

7.1.49. .status.bindings[]

Description
WorkloadBinding is a link between a configuration resource and a workload resource.
Type
object
Required
  • group
  • name
  • namespace
  • resource
Expand
PropertyTypeDescription

conditions

array

conditions defines the current state of the configuration resource when bound to the referenced Workload object.

conditions[]

object

ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.

group

string

group defines the group of the referenced resource.

name

string

name defines the name of the referenced object.

namespace

string

namespace defines the namespace of the referenced object.

resource

string

resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).

7.1.50. .status.bindings[].conditions

Description
conditions defines the current state of the configuration resource when bound to the referenced Workload object.
Type
array

7.1.51. .status.bindings[].conditions[]

Description
ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
Type
object
Required
  • lastTransitionTime
  • status
  • type
Expand
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime defines the time of the last update to the current status property.

message

string

message defines the human-readable message indicating details for the condition’s last transition.

observedGeneration

integer

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

reason

string

reason for the condition’s last transition.

status

string

status of the condition.

type

string

type of the condition being reported. Currently, only "Accepted" is supported.

7.2. API endpoints

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1/podmonitors

    • GET: list objects of kind PodMonitor
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors

    • DELETE: delete collection of PodMonitor
    • GET: list objects of kind PodMonitor
    • POST: create a PodMonitor
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors/{name}

    • DELETE: delete a PodMonitor
    • GET: read the specified PodMonitor
    • PATCH: partially update the specified PodMonitor
    • PUT: replace the specified PodMonitor
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors/{name}/status

    • GET: read status of the specified PodMonitor
    • PATCH: partially update status of the specified PodMonitor
    • PUT: replace status of the specified PodMonitor

7.2.1. /apis/monitoring.coreos.com/v1/podmonitors

HTTP method
GET
Description
list objects of kind PodMonitor
Expand
Table 7.1. HTTP responses
HTTP codeReponse body

200 - OK

PodMonitorList schema

401 - Unauthorized

Empty

HTTP method
DELETE
Description
delete collection of PodMonitor
Expand
Table 7.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind PodMonitor
Expand
Table 7.3. HTTP responses
HTTP codeReponse body

200 - OK

PodMonitorList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a PodMonitor
Expand
Table 7.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 7.5. Body parameters
ParameterTypeDescription

body

PodMonitor schema

 
Expand
Table 7.6. HTTP responses
HTTP codeReponse body

200 - OK

PodMonitor schema

201 - Created

PodMonitor schema

202 - Accepted

PodMonitor schema

401 - Unauthorized

Empty

Expand
Table 7.7. Global path parameters
ParameterTypeDescription

name

string

name of the PodMonitor

HTTP method
DELETE
Description
delete a PodMonitor
Expand
Table 7.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 7.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified PodMonitor
Expand
Table 7.10. HTTP responses
HTTP codeReponse body

200 - OK

PodMonitor schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified PodMonitor
Expand
Table 7.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 7.12. HTTP responses
HTTP codeReponse body

200 - OK

PodMonitor schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified PodMonitor
Expand
Table 7.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 7.14. Body parameters
ParameterTypeDescription

body

PodMonitor schema

 
Expand
Table 7.15. HTTP responses
HTTP codeReponse body

200 - OK

PodMonitor schema

201 - Created

PodMonitor schema

401 - Unauthorized

Empty

Expand
Table 7.16. Global path parameters
ParameterTypeDescription

name

string

name of the PodMonitor

HTTP method
GET
Description
read status of the specified PodMonitor
Expand
Table 7.17. HTTP responses
HTTP codeReponse body

200 - OK

PodMonitor schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified PodMonitor
Expand
Table 7.18. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 7.19. HTTP responses
HTTP codeReponse body

200 - OK

PodMonitor schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified PodMonitor
Expand
Table 7.20. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 7.21. Body parameters
ParameterTypeDescription

body

PodMonitor schema

 
Expand
Table 7.22. HTTP responses
HTTP codeReponse body

200 - OK

PodMonitor schema

201 - Created

PodMonitor schema

401 - Unauthorized

Empty

Chapter 8. Probe [monitoring.coreos.com/v1]

Description

The Probe custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).

The Probe resource needs 2 pieces of information: * The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects. * The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, …​) as Prometheus metrics.

Prometheus and PrometheusAgent objects select Probe objects using label and namespace selectors.

Type
object
Required
  • spec

8.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

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

kind

string

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

metadata

ObjectMeta

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

spec

object

spec defines the specification of desired Ingress selection for target discovery by Prometheus.

status

object

status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.

Most recent observed status of the Probe. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

8.1.1. .spec

Description
spec defines the specification of desired Ingress selection for target discovery by Prometheus.
Type
object
Expand
PropertyTypeDescription

authorization

object

authorization section for this endpoint

basicAuth

object

basicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint

bearerTokenSecret

object

bearerTokenSecret defines the secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the probe and accessible by the Prometheus Operator.

convertClassicHistogramsToNHCB

boolean

convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.

fallbackScrapeProtocol

string

fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.

It requires Prometheus >= v3.0.0.

interval

string

interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used.

jobName

string

jobName assigned to scraped metrics by default.

keepDroppedTargets

integer

keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.

It requires Prometheus >= v2.47.0.

labelLimit

integer

labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.

labelNameLengthLimit

integer

labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.

labelValueLengthLimit

integer

labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.

metricRelabelings

array

metricRelabelings defines the RelabelConfig to apply to samples before ingestion.

metricRelabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

module

string

module to use for probing specifying how to probe the target. Example module configuring in the blackbox exporter: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml

nativeHistogramBucketLimit

integer

nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0.

nativeHistogramMinBucketFactor

integer-or-string

nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0.

oauth2

object

oauth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.

params

array

params defines the list of HTTP query parameters for the scrape. Please note that the .spec.module field takes precedence over the module parameter from this list when both are defined. The module name must be added using Module under ProbeSpec.

params[]

object

ProbeParam defines specification of extra parameters for a Probe.

prober

object

prober defines the specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.

sampleLimit

integer

sampleLimit defines per-scrape limit on number of scraped samples that will be accepted.

scrapeClass

string

scrapeClass defines the scrape class to apply.

scrapeClassicHistograms

boolean

scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.

Notice: scrapeClassicHistograms corresponds to the always_scrape_classic_histograms field in the Prometheus configuration.

scrapeProtocols

array (string)

scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred).

If unset, Prometheus uses its default value.

It requires Prometheus >= v2.49.0.

scrapeTimeout

string

scrapeTimeout defines the timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape timeout is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.

targetLimit

integer

targetLimit defines a limit on the number of scraped targets that will be accepted.

targets

object

targets defines a set of static or dynamically discovered targets to probe.

tlsConfig

object

tlsConfig defines the TLS configuration to use when scraping the endpoint.

8.1.2. .spec.authorization

Description
authorization section for this endpoint
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

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

"Basic" is not a supported value.

Default: "Bearer"

8.1.3. .spec.authorization.credentials

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.4. .spec.basicAuth

Description
basicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint
Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

8.1.5. .spec.basicAuth.password

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.6. .spec.basicAuth.username

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.7. .spec.bearerTokenSecret

Description
bearerTokenSecret defines the secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the probe and accessible by the Prometheus Operator.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.8. .spec.metricRelabelings

Description
metricRelabelings defines the RelabelConfig to apply to samples before ingestion.
Type
array

8.1.9. .spec.metricRelabelings[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

8.1.10. .spec.oauth2

Description
oauth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

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

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

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

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

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

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

8.1.11. .spec.oauth2.clientId

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

8.1.12. .spec.oauth2.clientId.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

8.1.13. .spec.oauth2.clientId.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.14. .spec.oauth2.clientSecret

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.15. .spec.oauth2.proxyConnectHeader

Description

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.

Type
object

8.1.16. .spec.oauth2.proxyConnectHeader{}

Description
Type
array

8.1.17. .spec.oauth2.proxyConnectHeader{}[]

Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.18. .spec.oauth2.tlsConfig

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

8.1.19. .spec.oauth2.tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

8.1.20. .spec.oauth2.tlsConfig.ca.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

8.1.21. .spec.oauth2.tlsConfig.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.22. .spec.oauth2.tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

8.1.23. .spec.oauth2.tlsConfig.cert.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

8.1.24. .spec.oauth2.tlsConfig.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.25. .spec.oauth2.tlsConfig.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.26. .spec.params

Description
params defines the list of HTTP query parameters for the scrape. Please note that the .spec.module field takes precedence over the module parameter from this list when both are defined. The module name must be added using Module under ProbeSpec.
Type
array

8.1.27. .spec.params[]

Description
ProbeParam defines specification of extra parameters for a Probe.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name defines the parameter name

values

array (string)

values defines the parameter values

8.1.28. .spec.prober

Description
prober defines the specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.
Type
object
Required
  • url
Expand
PropertyTypeDescription

noProxy

string

noProxy defines 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.

path

string

path to collect metrics from. Defaults to /probe.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scheme

string

scheme defines the HTTP scheme to use when scraping the prober.

url

string

url defines the address of the prober.

Unlike what the name indicates, the value should be in the form of address:port without any scheme which should be specified in the scheme field.

8.1.29. .spec.prober.proxyConnectHeader

Description

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.

Type
object

8.1.30. .spec.prober.proxyConnectHeader{}

Description
Type
array

8.1.31. .spec.prober.proxyConnectHeader{}[]

Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.32. .spec.targets

Description
targets defines a set of static or dynamically discovered targets to probe.
Type
object
Expand
PropertyTypeDescription

ingress

object

ingress defines the Ingress objects to probe and the relabeling configuration. If staticConfig is also defined, staticConfig takes precedence.

staticConfig

object

staticConfig defines the static list of targets to probe and the relabeling configuration. If ingress is also defined, staticConfig takes precedence. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config.

8.1.33. .spec.targets.ingress

Description
ingress defines the Ingress objects to probe and the relabeling configuration. If staticConfig is also defined, staticConfig takes precedence.
Type
object
Expand
PropertyTypeDescription

namespaceSelector

object

namespaceSelector defines from which namespaces to select Ingress objects.

relabelingConfigs

array

relabelingConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the __tmp_prometheus_ingress_address label. It can be used to customize the probed URL. The original scrape job’s name is available via the \__tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

selector

object

selector to select the Ingress objects.

8.1.34. .spec.targets.ingress.namespaceSelector

Description
namespaceSelector defines from which namespaces to select Ingress objects.
Type
object
Expand
PropertyTypeDescription

any

boolean

any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them.

matchNames

array (string)

matchNames defines the list of namespace names to select from.

8.1.35. .spec.targets.ingress.relabelingConfigs

Description
relabelingConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the __tmp_prometheus_ingress_address label. It can be used to customize the probed URL. The original scrape job’s name is available via the \__tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
Type
array

8.1.36. .spec.targets.ingress.relabelingConfigs[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

8.1.37. .spec.targets.ingress.selector

Description
selector to select the Ingress objects.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

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

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

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.

8.1.40. .spec.targets.staticConfig

Description
staticConfig defines the static list of targets to probe and the relabeling configuration. If ingress is also defined, staticConfig takes precedence. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config.
Type
object
Expand
PropertyTypeDescription

labels

object (string)

labels defines all labels assigned to all metrics scraped from the targets.

relabelingConfigs

array

relabelingConfigs defines relabelings to be apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

static

array (string)

static defines the list of hosts to probe.

Description
relabelingConfigs defines relabelings to be apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
Type
array
Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

8.1.43. .spec.tlsConfig

Description
tlsConfig defines the TLS configuration to use when scraping the endpoint.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

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

minVersion

string

minVersion defines the minimum acceptable TLS version.

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

serverName

string

serverName is used to verify the hostname for the targets.

8.1.44. .spec.tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

8.1.45. .spec.tlsConfig.ca.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

8.1.46. .spec.tlsConfig.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.47. .spec.tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

8.1.48. .spec.tlsConfig.cert.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

8.1.49. .spec.tlsConfig.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.50. .spec.tlsConfig.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

8.1.51. .status

Description

status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.

Most recent observed status of the Probe. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Type
object
Expand
PropertyTypeDescription

bindings

array

bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.

bindings[]

object

WorkloadBinding is a link between a configuration resource and a workload resource.

8.1.52. .status.bindings

Description
bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
Type
array

8.1.53. .status.bindings[]

Description
WorkloadBinding is a link between a configuration resource and a workload resource.
Type
object
Required
  • group
  • name
  • namespace
  • resource
Expand
PropertyTypeDescription

conditions

array

conditions defines the current state of the configuration resource when bound to the referenced Workload object.

conditions[]

object

ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.

group

string

group defines the group of the referenced resource.

name

string

name defines the name of the referenced object.

namespace

string

namespace defines the namespace of the referenced object.

resource

string

resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).

8.1.54. .status.bindings[].conditions

Description
conditions defines the current state of the configuration resource when bound to the referenced Workload object.
Type
array

8.1.55. .status.bindings[].conditions[]

Description
ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
Type
object
Required
  • lastTransitionTime
  • status
  • type
Expand
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime defines the time of the last update to the current status property.

message

string

message defines the human-readable message indicating details for the condition’s last transition.

observedGeneration

integer

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

reason

string

reason for the condition’s last transition.

status

string

status of the condition.

type

string

type of the condition being reported. Currently, only "Accepted" is supported.

8.2. API endpoints

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1/probes

    • GET: list objects of kind Probe
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes

    • DELETE: delete collection of Probe
    • GET: list objects of kind Probe
    • POST: create a Probe
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}

    • DELETE: delete a Probe
    • GET: read the specified Probe
    • PATCH: partially update the specified Probe
    • PUT: replace the specified Probe
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}/status

    • GET: read status of the specified Probe
    • PATCH: partially update status of the specified Probe
    • PUT: replace status of the specified Probe

8.2.1. /apis/monitoring.coreos.com/v1/probes

HTTP method
GET
Description
list objects of kind Probe
Expand
Table 8.1. HTTP responses
HTTP codeReponse body

200 - OK

ProbeList schema

401 - Unauthorized

Empty

HTTP method
DELETE
Description
delete collection of Probe
Expand
Table 8.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind Probe
Expand
Table 8.3. HTTP responses
HTTP codeReponse body

200 - OK

ProbeList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a Probe
Expand
Table 8.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 8.5. Body parameters
ParameterTypeDescription

body

Probe schema

 
Expand
Table 8.6. HTTP responses
HTTP codeReponse body

200 - OK

Probe schema

201 - Created

Probe schema

202 - Accepted

Probe schema

401 - Unauthorized

Empty

Expand
Table 8.7. Global path parameters
ParameterTypeDescription

name

string

name of the Probe

HTTP method
DELETE
Description
delete a Probe
Expand
Table 8.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 8.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified Probe
Expand
Table 8.10. HTTP responses
HTTP codeReponse body

200 - OK

Probe schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified Probe
Expand
Table 8.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 8.12. HTTP responses
HTTP codeReponse body

200 - OK

Probe schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified Probe
Expand
Table 8.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 8.14. Body parameters
ParameterTypeDescription

body

Probe schema

 
Expand
Table 8.15. HTTP responses
HTTP codeReponse body

200 - OK

Probe schema

201 - Created

Probe schema

401 - Unauthorized

Empty

Expand
Table 8.16. Global path parameters
ParameterTypeDescription

name

string

name of the Probe

HTTP method
GET
Description
read status of the specified Probe
Expand
Table 8.17. HTTP responses
HTTP codeReponse body

200 - OK

Probe schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified Probe
Expand
Table 8.18. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 8.19. HTTP responses
HTTP codeReponse body

200 - OK

Probe schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified Probe
Expand
Table 8.20. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 8.21. Body parameters
ParameterTypeDescription

body

Probe schema

 
Expand
Table 8.22. HTTP responses
HTTP codeReponse body

200 - OK

Probe schema

201 - Created

Probe schema

401 - Unauthorized

Empty

Chapter 9. Prometheus [monitoring.coreos.com/v1]

Description

The Prometheus custom resource definition (CRD) defines a desired [Prometheus](https://prometheus.io/docs/prometheus) setup to run in a Kubernetes cluster. It allows to specify many options such as the number of replicas, persistent storage, and Alertmanagers where firing alerts should be sent and many more.

For each Prometheus resource, the Operator deploys one or several StatefulSet objects in the same namespace. The number of StatefulSets is equal to the number of shards which is 1 by default.

The resource defines via label and namespace selectors which ServiceMonitor, PodMonitor, Probe and PrometheusRule objects should be associated to the deployed Prometheus instances.

The Operator continuously reconciles the scrape and rules configuration and a sidecar container running in the Prometheus pods triggers a reload of the configuration when needed.

Type
object
Required
  • spec

9.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

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

kind

string

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

metadata

ObjectMeta

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

spec

object

spec defines the specification of the desired behavior of the Prometheus cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

status

object

status defines the most recent observed status of the Prometheus cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

9.1.1. .spec

Description
spec defines the specification of the desired behavior of the Prometheus cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Type
object
Expand
PropertyTypeDescription

additionalAlertManagerConfigs

object

additionalAlertManagerConfigs defines a key of a Secret containing additional Prometheus Alertmanager configurations. The Alertmanager configurations are appended to the configuration generated by the Prometheus Operator. They must be formatted according to the official Prometheus documentation:

https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config

The user is responsible for making sure that the configurations are valid

Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible AlertManager configs are going to break Prometheus after the upgrade.

additionalAlertRelabelConfigs

object

additionalAlertRelabelConfigs defines a key of a Secret containing additional Prometheus alert relabel configurations. The alert relabel configurations are appended to the configuration generated by the Prometheus Operator. They must be formatted according to the official Prometheus documentation:

https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs

The user is responsible for making sure that the configurations are valid

Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible alert relabel configs are going to break Prometheus after the upgrade.

additionalArgs

array

additionalArgs allows setting additional arguments for the 'prometheus' 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 Prometheus container which may cause issues if they are invalid or not supported by the given Prometheus version.

In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument, the reconciliation will fail and an error will be logged.

additionalArgs[]

object

Argument as part of the AdditionalArgs list.

additionalScrapeConfigs

object

additionalScrapeConfigs allows specifying a key of a Secret containing additional Prometheus scrape configurations. Scrape configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config. As scrape configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible scrape configs are going to break Prometheus after the upgrade.

affinity

object

affinity defines the Pods' affinity scheduling rules if specified.

alerting

object

alerting defines the settings related to Alertmanager.

allowOverlappingBlocks

boolean

allowOverlappingBlocks enables vertical compaction and vertical query merge in Prometheus.

Deprecated: this flag has no effect for Prometheus >= 2.39.0 where overlapping blocks are enabled by default.

apiserverConfig

object

apiserverConfig allows specifying a host and auth methods to access the Kuberntees API server. If null, Prometheus is assumed to run inside of the cluster: it will discover the API servers automatically and use the Pod’s CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.

arbitraryFSAccessThroughSMs

object

arbitraryFSAccessThroughSMs when true, ServiceMonitor, PodMonitor and Probe object are forbidden to reference arbitrary files on the file system of the 'prometheus' container. When a ServiceMonitor’s endpoint specifies a bearerTokenFile value (e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a malicious target can get access to the Prometheus service account’s token in the Prometheus' scrape request. Setting spec.arbitraryFSAccessThroughSM to 'true' would prevent the attack. Users should instead provide the credentials using the spec.bearerTokenSecret field.

automountServiceAccountToken

boolean

automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod. If the field isn’t set, the operator mounts the service account token by default.

Warning: be aware that by default, Prometheus requires the service account token for Kubernetes service discovery. It is possible to use strategic merge patch to project the service account token into the 'prometheus' container.

baseImage

string

baseImage is deprecated: use 'spec.image' instead.

bodySizeLimit

string

bodySizeLimit defines per-scrape on response body size. Only valid in Prometheus versions 2.45.0 and newer.

Note that the global limit only applies to scrape objects that don’t specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit.

configMaps

array (string)

configMaps defines a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each ConfigMap is added to the StatefulSet definition as a volume named configmap-<configmap-name>. The ConfigMaps are mounted into /etc/prometheus/configmaps/<configmap-name> in the 'prometheus' container.

containers

array

containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to the Pods or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch.

The names of containers managed by the operator are: * prometheus * config-reloader * thanos-sidecar

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.

containers[]

object

A single application container that you want to run within a pod.

convertClassicHistogramsToNHCB

boolean

convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets.

It requires Prometheus >= v3.4.0.

disableCompaction

boolean

disableCompaction when true, the Prometheus compaction is disabled. When spec.thanos.objectStorageConfig or spec.objectStorageConfigFile are defined, the operator automatically disables block compaction to avoid race conditions during block uploads (as the Thanos documentation recommends).

dnsConfig

object

dnsConfig defines the DNS configuration for the pods.

dnsPolicy

string

dnsPolicy defines the DNS policy for the pods.

enableAdminAPI

boolean

enableAdminAPI defines access to the Prometheus web admin API.

WARNING: Enabling the admin APIs enables mutating endpoints, to delete data, shutdown Prometheus, and more. Enabling this should be done with care and the user is advised to add additional authentication authorization via a proxy to ensure only clients authorized to perform these actions can do so.

For more information: https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis

enableFeatures

array (string)

enableFeatures enables access to Prometheus 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.

For more information see https://prometheus.io/docs/prometheus/latest/feature_flags/

enableOTLPReceiver

boolean

enableOTLPReceiver defines the Prometheus to be used as a receiver for the OTLP Metrics protocol.

Note that the OTLP receiver endpoint is automatically enabled if .spec.otlpConfig is defined.

It requires Prometheus >= v2.47.0.

enableRemoteWriteReceiver

boolean

enableRemoteWriteReceiver defines the Prometheus to be used as a receiver for the Prometheus remote write protocol.

WARNING: This is not considered an efficient way of ingesting samples. Use it with caution for specific low-volume use cases. It is not suitable for replacing the ingestion via scraping and turning Prometheus into a push-based metrics collection system. For more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver

It requires Prometheus >= v2.33.0.

enableServiceLinks

boolean

enableServiceLinks defines whether information about services should be injected into pod’s environment variables

enforcedBodySizeLimit

string

enforcedBodySizeLimit when defined specifies a global limit on the size of uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail.

It requires Prometheus >= v2.28.0.

When both enforcedBodySizeLimit and bodySizeLimit are defined and greater than zero, the following rules apply: * Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0). If Prometheus version is >= 2.45.0 and the enforcedBodySizeLimit is greater than the bodySizeLimit, the bodySizeLimit will be set to enforcedBodySizeLimit. * Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value. * Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit.

enforcedKeepDroppedTargets

integer

enforcedKeepDroppedTargets when defined specifies a global limit on the number of targets dropped by relabeling that will be kept in memory. The value overrides any spec.keepDroppedTargets set by ServiceMonitor, PodMonitor, Probe objects unless spec.keepDroppedTargets is greater than zero and less than spec.enforcedKeepDroppedTargets.

It requires Prometheus >= v2.47.0.

When both enforcedKeepDroppedTargets and keepDroppedTargets are defined and greater than zero, the following rules apply: * Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0). If Prometheus version is >= 2.45.0 and the enforcedKeepDroppedTargets is greater than the keepDroppedTargets, the keepDroppedTargets will be set to enforcedKeepDroppedTargets. * Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value. * Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets.

enforcedLabelLimit

integer

enforcedLabelLimit when defined specifies a global limit on the number of labels per sample. The value overrides any spec.labelLimit set by ServiceMonitor, PodMonitor, Probe objects unless spec.labelLimit is greater than zero and less than spec.enforcedLabelLimit.

It requires Prometheus >= v2.27.0.

When both enforcedLabelLimit and labelLimit are defined and greater than zero, the following rules apply: * Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0). If Prometheus version is >= 2.45.0 and the enforcedLabelLimit is greater than the labelLimit, the labelLimit will be set to enforcedLabelLimit. * Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value. * Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit.

enforcedLabelNameLengthLimit

integer

enforcedLabelNameLengthLimit when defined specifies a global limit on the length of labels name per sample. The value overrides any spec.labelNameLengthLimit set by ServiceMonitor, PodMonitor, Probe objects unless spec.labelNameLengthLimit is greater than zero and less than spec.enforcedLabelNameLengthLimit.

It requires Prometheus >= v2.27.0.

When both enforcedLabelNameLengthLimit and labelNameLengthLimit are defined and greater than zero, the following rules apply: * Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0). If Prometheus version is >= 2.45.0 and the enforcedLabelNameLengthLimit is greater than the labelNameLengthLimit, the labelNameLengthLimit will be set to enforcedLabelNameLengthLimit. * Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value. * Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit.

enforcedLabelValueLengthLimit

integer

enforcedLabelValueLengthLimit when not null defines a global limit on the length of labels value per sample. The value overrides any spec.labelValueLengthLimit set by ServiceMonitor, PodMonitor, Probe objects unless spec.labelValueLengthLimit is greater than zero and less than spec.enforcedLabelValueLengthLimit.

It requires Prometheus >= v2.27.0.

When both enforcedLabelValueLengthLimit and labelValueLengthLimit are defined and greater than zero, the following rules apply: * Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0). If Prometheus version is >= 2.45.0 and the enforcedLabelValueLengthLimit is greater than the labelValueLengthLimit, the labelValueLengthLimit will be set to enforcedLabelValueLengthLimit. * Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value. * Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit.

enforcedNamespaceLabel

string

enforcedNamespaceLabel when not empty, a label will be added to:

1. All metrics scraped from ServiceMonitor, PodMonitor, Probe and ScrapeConfig objects. 2. All metrics generated from recording rules defined in PrometheusRule objects. 3. All alerts generated from alerting rules defined in PrometheusRule objects. 4. All vector selectors of PromQL expressions defined in PrometheusRule objects.

The label will not added for objects referenced in spec.excludedFromEnforcement.

The label’s name is this field’s value. The label’s value is the namespace of the ServiceMonitor, PodMonitor, Probe, PrometheusRule or ScrapeConfig object.

enforcedSampleLimit

integer

enforcedSampleLimit when defined specifies a global limit on the number of scraped samples that will be accepted. This overrides any spec.sampleLimit set by ServiceMonitor, PodMonitor, Probe objects unless spec.sampleLimit is greater than zero and less than spec.enforcedSampleLimit.

It is meant to be used by admins to keep the overall number of samples/series under a desired limit.

When both enforcedSampleLimit and sampleLimit are defined and greater than zero, the following rules apply: * Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0). If Prometheus version is >= 2.45.0 and the enforcedSampleLimit is greater than the sampleLimit, the sampleLimit will be set to enforcedSampleLimit. * Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value. * Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit.

enforcedTargetLimit

integer

enforcedTargetLimit when defined specifies a global limit on the number of scraped targets. The value overrides any spec.targetLimit set by ServiceMonitor, PodMonitor, Probe objects unless spec.targetLimit is greater than zero and less than spec.enforcedTargetLimit.

It is meant to be used by admins to to keep the overall number of targets under a desired limit.

When both enforcedTargetLimit and targetLimit are defined and greater than zero, the following rules apply: * Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0). If Prometheus version is >= 2.45.0 and the enforcedTargetLimit is greater than the targetLimit, the targetLimit will be set to enforcedTargetLimit. * Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value. * Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit.

evaluationInterval

string

evaluationInterval defines the interval between rule evaluations. Default: "30s"

excludedFromEnforcement

array

excludedFromEnforcement defines the list of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects to be excluded from enforcing a namespace label of origin.

It is only applicable if spec.enforcedNamespaceLabel set to true.

excludedFromEnforcement[]

object

ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.

exemplars

object

exemplars related settings that are runtime reloadable. It requires to enable the exemplar-storage feature flag to be effective.

externalLabels

object (string)

externalLabels defines the labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager). Labels defined by spec.replicaExternalLabelName and spec.prometheusExternalLabelName take precedence over this list.

externalUrl

string

externalUrl defines the external URL under which the Prometheus service is externally available. This is necessary to generate correct URLs (for instance if Prometheus is accessible behind an Ingress resource).

hostAliases

array

hostAliases defines the optional list of hosts and IPs that will be injected into the Pod’s hosts file if specified.

hostAliases[]

object

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.

hostNetwork

boolean

hostNetwork defines the host’s network namespace if true.

Make sure to understand the security implications if you want to enable it (https://kubernetes.io/docs/concepts/configuration/overview/ ).

When hostNetwork is enabled, this will set the DNS policy to ClusterFirstWithHostNet automatically (unless .spec.DNSPolicy is set to a different value).

hostUsers

boolean

hostUsers supports the user space in Kubernetes.

More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/

The feature requires at least Kubernetes 1.28 with the UserNamespacesSupport feature gate enabled. Starting Kubernetes 1.33, the feature is enabled by default.

ignoreNamespaceSelectors

boolean

ignoreNamespaceSelectors when true, spec.namespaceSelector from all PodMonitor, ServiceMonitor and Probe objects will be ignored. They will only discover targets within the namespace of the PodMonitor, ServiceMonitor and Probe object.

image

string

image defines the container image name for Prometheus. If specified, it takes precedence over the spec.baseImage, spec.tag and spec.sha fields.

Specifying spec.version is still necessary to ensure the Prometheus Operator knows which version of Prometheus is being configured.

If neither spec.image nor spec.baseImage are defined, the operator will use the latest upstream version of Prometheus available at the time when the operator was released.

imagePullPolicy

string

imagePullPolicy defines the image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.

imagePullSecrets

array

imagePullSecrets defines an optional list of references to Secrets in the same namespace to use for pulling images from registries. See http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

imagePullSecrets[]

object

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

initContainers

array

initContainers allows injecting initContainers to the Pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus 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 names of init container name managed by the operator are: * 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.

initContainers[]

object

A single application container that you want to run within a pod.

keepDroppedTargets

integer

keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.

It requires Prometheus >= v2.47.0.

Note that the global limit only applies to scrape objects that don’t specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets.

labelLimit

integer

labelLimit defines per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer.

Note that the global limit only applies to scrape objects that don’t specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit.

labelNameLengthLimit

integer

labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer.

Note that the global limit only applies to scrape objects that don’t specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit.

labelValueLengthLimit

integer

labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer.

Note that the global limit only applies to scrape objects that don’t specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit.

listenLocal

boolean

listenLocal when true, the Prometheus server listens on the loopback address instead of the Pod IP’s address.

logFormat

string

logFormat for Log level for Prometheus and the config-reloader sidecar.

logLevel

string

logLevel for Prometheus and the config-reloader sidecar.

maximumStartupDurationSeconds

integer

maximumStartupDurationSeconds defines the maximum time that the prometheus container’s startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. If set, the value should be greater than 60 (seconds). Otherwise it will be equal to 900 seconds (15 minutes).

minReadySeconds

integer

minReadySeconds defines the 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.

If unset, pods will be considered available as soon as they are ready.

nameEscapingScheme

string

nameEscapingScheme defines the character escaping scheme that will be requested when scraping for metric and label names that do not conform to the legacy Prometheus character set.

It requires Prometheus >= v3.4.0.

nameValidationScheme

string

nameValidationScheme defines the validation scheme for metric and label names.

It requires Prometheus >= v2.55.0.

nodeSelector

object (string)

nodeSelector defines on which Nodes the Pods are scheduled.

otlp

object

otlp defines the settings related to the OTLP receiver feature. It requires Prometheus >= v2.55.0.

overrideHonorLabels

boolean

overrideHonorLabels when true, Prometheus resolves label conflicts by renaming the labels in the scraped data to “exported_” for all targets created from ServiceMonitor, PodMonitor and ScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies. In practice,OverrideHonorLabels:true enforces honorLabels:false for all ServiceMonitor, PodMonitor and ScrapeConfig objects.

overrideHonorTimestamps

boolean

overrideHonorTimestamps when true, Prometheus ignores the timestamps for all the targets created from service and pod monitors. Otherwise the HonorTimestamps field of the service or pod monitor applies.

paused

boolean

paused defines when a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects.

persistentVolumeClaimRetentionPolicy

object

persistentVolumeClaimRetentionPolicy defines 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.

podMetadata

object

podMetadata defines labels and annotations which are propagated to the Prometheus pods.

The following items are reserved and cannot be overridden: * "prometheus" label, set to the name of the Prometheus object. * "app.kubernetes.io/instance" label, set to the name of the Prometheus object. * "app.kubernetes.io/managed-by" label, set to "prometheus-operator". * "app.kubernetes.io/name" label, set to "prometheus". * "app.kubernetes.io/version" label, set to the Prometheus version. * "operator.prometheus.io/name" label, set to the name of the Prometheus object. * "operator.prometheus.io/shard" label, set to the shard number of the Prometheus object. * "kubectl.kubernetes.io/default-container" annotation, set to "prometheus".

podMonitorNamespaceSelector

object

podMonitorNamespaceSelector defines the namespaces to match for PodMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only.

podMonitorSelector

object

podMonitorSelector defines the podMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.

If spec.serviceMonitorSelector, spec.podMonitorSelector, spec.probeSelector and spec.scrapeConfigSelector are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration’s Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the prometheus.yaml.gz key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use spec.additionalScrapeConfigs instead.

podTargetLabels

array (string)

podTargetLabels are appended to the spec.podTargetLabels field of all PodMonitor and ServiceMonitor objects.

portName

string

portName used for the pods and governing service. Default: "web"

priorityClassName

string

priorityClassName assigned to the Pods.

probeNamespaceSelector

object

probeNamespaceSelector defines the namespaces to match for Probe discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only.

probeSelector

object

probeSelector defines the probes to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.

If spec.serviceMonitorSelector, spec.podMonitorSelector, spec.probeSelector and spec.scrapeConfigSelector are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration’s Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the prometheus.yaml.gz key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use spec.additionalScrapeConfigs instead.

prometheusExternalLabelName

string

prometheusExternalLabelName defines the name of Prometheus external label used to denote the Prometheus instance name. The external label will not be added when the field is set to the empty string ("").

Default: "prometheus"

prometheusRulesExcludedFromEnforce

array

prometheusRulesExcludedFromEnforce defines the list of PrometheusRule objects to which the namespace label enforcement doesn’t apply. This is only relevant when spec.enforcedNamespaceLabel is set to true. Deprecated: use spec.excludedFromEnforcement instead.

prometheusRulesExcludedFromEnforce[]

object

PrometheusRuleExcludeConfig enables users to configure excluded PrometheusRule names and their namespaces to be ignored while enforcing namespace label for alerts and metrics.

query

object

query defines the configuration of the Prometheus query service.

queryLogFile

string

queryLogFile specifies where the file to which PromQL queries are logged.

If the filename has an empty path, e.g. 'query.log', The Prometheus Pods will mount the file into an emptyDir volume at /var/log/prometheus. If a full path is provided, e.g. '/var/log/prometheus/query.log', you must mount a volume in the specified directory and it must be writable. This is because the prometheus container runs with a read-only root filesystem for security reasons. Alternatively, the location can be set to a standard I/O stream, e.g. /dev/stdout, to log query information to the default Prometheus log stream.

reloadStrategy

string

reloadStrategy defines the strategy used to reload the Prometheus configuration. If not specified, the configuration is reloaded using the /-/reload HTTP endpoint.

remoteRead

array

remoteRead defines the list of remote read configurations.

remoteRead[]

object

RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.

remoteWrite

array

remoteWrite defines the list of remote write configurations.

remoteWrite[]

object

RemoteWriteSpec defines the configuration to write samples from Prometheus to a remote endpoint.

remoteWriteReceiverMessageVersions

array (string)

remoteWriteReceiverMessageVersions list of the protobuf message versions to accept when receiving the remote writes.

It requires Prometheus >= v2.54.0.

replicaExternalLabelName

string

replicaExternalLabelName defines the name of Prometheus external label used to denote the replica name. The external label will not be added when the field is set to the empty string ("").

Default: "prometheus_replica"

replicas

integer

replicas defines the number of replicas of each shard to deploy for a Prometheus deployment. spec.replicas multiplied by spec.shards is the total number of Pods created.

Default: 1

resources

object

resources defines the resources requests and limits of the 'prometheus' container.

retention

string

retention defines how long to retain the Prometheus data.

Default: "24h" if spec.retention and spec.retentionSize are empty.

retentionSize

string

retentionSize defines the maximum number of bytes used by the Prometheus data.

routePrefix

string

routePrefix defines the route prefix Prometheus registers HTTP handlers for.

This is useful when using spec.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.

ruleNamespaceSelector

object

ruleNamespaceSelector defines the namespaces to match for PrometheusRule discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only.

ruleQueryOffset

string

ruleQueryOffset defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past. It requires Prometheus >= v2.53.0.

ruleSelector

object

ruleSelector defines the prometheusRule objects to be selected for rule evaluation. An empty label selector matches all objects. A null label selector matches no objects.

rules

object

rules defines the configuration of the Prometheus rules' engine.

runtime

object

runtime defines the values for the Prometheus process behavior

sampleLimit

integer

sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. Only valid in Prometheus versions 2.45.0 and newer.

Note that the global limit only applies to scrape objects that don’t specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit.

scrapeClasses

array

scrapeClasses defines the list of scrape classes to expose to scraping objects such as PodMonitors, ServiceMonitors, Probes and ScrapeConfigs.

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

scrapeClasses[]

object

 

scrapeClassicHistograms

boolean

scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.

Notice: scrapeClassicHistograms corresponds to the always_scrape_classic_histograms field in the Prometheus configuration.

It requires Prometheus >= v3.5.0.

scrapeConfigNamespaceSelector

object

scrapeConfigNamespaceSelector defines the namespaces to match for ScrapeConfig discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only.

Note that the ScrapeConfig custom resource definition is currently at Alpha level.

scrapeConfigSelector

object

scrapeConfigSelector defines the scrapeConfigs to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.

If spec.serviceMonitorSelector, spec.podMonitorSelector, spec.probeSelector and spec.scrapeConfigSelector are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration’s Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the prometheus.yaml.gz key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use spec.additionalScrapeConfigs instead.

Note that the ScrapeConfig custom resource definition is currently at Alpha level.

scrapeFailureLogFile

string

scrapeFailureLogFile defines the file to which scrape failures are logged. Reloading the configuration will reopen the file.

If the filename has an empty path, e.g. 'file.log', The Prometheus Pods will mount the file into an emptyDir volume at /var/log/prometheus. If a full path is provided, e.g. '/var/log/prometheus/file.log', you must mount a volume in the specified directory and it must be writable. It requires Prometheus >= v2.55.0.

scrapeInterval

string

scrapeInterval defines interval between consecutive scrapes.

Default: "30s"

scrapeProtocols

array (string)

scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred).

If unset, Prometheus uses its default value.

It requires Prometheus >= v2.49.0.

PrometheusText1.0.0 requires Prometheus >= v3.0.0.

scrapeTimeout

string

scrapeTimeout defines the number of seconds to wait until a scrape request times out. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.

secrets

array (string)

secrets defines a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each Secret is added to the StatefulSet definition as a volume named secret-<secret-name>. The Secrets are mounted into /etc/prometheus/secrets/<secret-name> in the 'prometheus' container.

securityContext

object

securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.

serviceAccountName

string

serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.

serviceDiscoveryRole

string

serviceDiscoveryRole defines the service discovery role used to discover targets from ServiceMonitor objects and Alertmanager endpoints.

If set, the value should be either "Endpoints" or "EndpointSlice". If unset, the operator assumes the "Endpoints" role.

serviceMonitorNamespaceSelector

object

serviceMonitorNamespaceSelector defines the namespaces to match for ServicedMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only.

serviceMonitorSelector

object

serviceMonitorSelector defines the serviceMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.

If spec.serviceMonitorSelector, spec.podMonitorSelector, spec.probeSelector and spec.scrapeConfigSelector are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration’s Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the prometheus.yaml.gz key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use spec.additionalScrapeConfigs instead.

serviceName

string

serviceName defines 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 Prometheus/PrometheusAgent 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 prometheus-operated for Prometheus resources, or prometheus-agent-operated for PrometheusAgent resources. When deploying multiple Prometheus/PrometheusAgent 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.

sha

string

sha is deprecated: use 'spec.image' instead. The image’s digest can be specified as part of the image name.

shardRetentionPolicy

object

shardRetentionPolicy defines the retention policy for the Prometheus shards. (Alpha) Using this field requires the 'PrometheusShardRetentionPolicy' feature gate to be enabled.

The final goals for this feature can be seen at https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/proposals/202310-shard-autoscaling.md#graceful-scale-down-of-prometheus-servers, however, the feature is not yet fully implemented in this PR. The limitation being: * Retention duration is not settable, for now, shards are retained forever.

shards

integer

shards defines the number of shards to distribute the scraped targets onto.

spec.replicas multiplied by spec.shards is the total number of Pods being created.

When not defined, the operator assumes only one shard.

Note that scaling down shards will not reshard data onto the remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same instances. To query globally, use either * Thanos sidecar + querier for query federation and Thanos Ruler for rules. * Remote-write to send metrics to a central location.

By default, the sharding of targets is performed on: * The address target’s metadata label for PodMonitor, ServiceMonitor and ScrapeConfig resources. * The param_target label for Probe resources.

Users can define their own sharding implementation by setting the __tmp_hash label during the target discovery with relabeling configuration (either in the monitoring resources or via scrape class).

You can also disable sharding on a specific target by setting the __tmp_disable_sharding label with relabeling configuration. When the label value isn’t empty, all Prometheus shards will scrape the target.

storage

object

storage defines the storage used by Prometheus.

tag

string

tag is deprecated: use 'spec.image' instead. The image’s tag can be specified as part of the image name.

targetLimit

integer

targetLimit defines a limit on the number of scraped targets that will be accepted. Only valid in Prometheus versions 2.45.0 and newer.

Note that the global limit only applies to scrape objects that don’t specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit.

terminationGracePeriodSeconds

integer

terminationGracePeriodSeconds defines the 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 600 seconds.

thanos

object

thanos defines the configuration of the optional Thanos sidecar.

tolerations

array

tolerations defines the Pods' tolerations if specified.

tolerations[]

object

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

topologySpreadConstraints

array

topologySpreadConstraints defines the pod’s topology spread constraints if specified.

topologySpreadConstraints[]

object

 

tracingConfig

object

tracingConfig defines tracing in Prometheus.

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

tsdb

object

tsdb defines the runtime reloadable configuration of the timeseries database(TSDB). It requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.

version

string

version of Prometheus being deployed. The operator uses this information to generate the Prometheus StatefulSet + configuration files.

If not specified, the operator assumes the latest upstream version of Prometheus available at the time when the version of the operator was released.

volumeMounts

array

volumeMounts allows the configuration of additional VolumeMounts.

VolumeMounts will be appended to other VolumeMounts in the 'prometheus' container, that are generated as a result of StorageSpec objects.

volumeMounts[]

object

VolumeMount describes a mounting of a Volume within a container.

volumes

array

volumes allows the 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.

volumes[]

object

Volume represents a named volume in a pod that may be accessed by any container in the pod.

walCompression

boolean

walCompression defines the compression of the write-ahead log (WAL) using Snappy.

WAL compression is enabled by default for Prometheus >= 2.20.0

Requires Prometheus v2.11.0 and above.

web

object

web defines the configuration of the Prometheus web server.

9.1.2. .spec.additionalAlertManagerConfigs

Description

additionalAlertManagerConfigs defines a key of a Secret containing additional Prometheus Alertmanager configurations. The Alertmanager configurations are appended to the configuration generated by the Prometheus Operator. They must be formatted according to the official Prometheus documentation:

https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config

The user is responsible for making sure that the configurations are valid

Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible AlertManager configs are going to break Prometheus after the upgrade.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.3. .spec.additionalAlertRelabelConfigs

Description

additionalAlertRelabelConfigs defines a key of a Secret containing additional Prometheus alert relabel configurations. The alert relabel configurations are appended to the configuration generated by the Prometheus Operator. They must be formatted according to the official Prometheus documentation:

https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs

The user is responsible for making sure that the configurations are valid

Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible alert relabel configs are going to break Prometheus after the upgrade.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.4. .spec.additionalArgs

Description

additionalArgs allows setting additional arguments for the 'prometheus' 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 Prometheus container which may cause issues if they are invalid or not supported by the given Prometheus version.

In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument, the reconciliation will fail and an error will be logged.

Type
array

9.1.5. .spec.additionalArgs[]

Description
Argument as part of the AdditionalArgs list.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name of the argument, e.g. "scrape.discovery-reload-interval".

value

string

value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)

9.1.6. .spec.additionalScrapeConfigs

Description
additionalScrapeConfigs allows specifying a key of a Secret containing additional Prometheus scrape configurations. Scrape configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config. As scrape configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible scrape configs are going to break Prometheus after the upgrade.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

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

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.7. .spec.affinity

Description
affinity defines the Pods' affinity scheduling rules if specified.
Type
object
Expand
PropertyTypeDescription

nodeAffinity

object

Describes node affinity scheduling rules for the pod.

podAffinity

object

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

podAntiAffinity

object

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

9.1.8. .spec.affinity.nodeAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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.

preferredDuringSchedulingIgnoredDuringExecution[]

object

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

requiredDuringSchedulingIgnoredDuringExecution

object

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.

Description
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
Type
array
Description
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Type
object
Required
  • preference
  • weight
Expand
PropertyTypeDescription

preference

object

A node selector term, associated with the corresponding weight.

weight

integer

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

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

matchExpressions

array

A list of node selector requirements by node’s labels.

matchExpressions[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchFields

array

A list of node selector requirements by node’s fields.

matchFields[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Description
A list of node selector requirements by node’s labels.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values

array (string)

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.

Description
A list of node selector requirements by node’s fields.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values

array (string)

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.

Description
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
Type
object
Required
  • nodeSelectorTerms
Expand
PropertyTypeDescription

nodeSelectorTerms

array

Required. A list of node selector terms. The terms are ORed.

nodeSelectorTerms[]

object

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Description
Required. A list of node selector terms. The terms are ORed.
Type
array
Description
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

A list of node selector requirements by node’s labels.

matchExpressions[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchFields

array

A list of node selector requirements by node’s fields.

matchFields[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Description
A list of node selector requirements by node’s labels.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values

array (string)

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.

Description
A list of node selector requirements by node’s fields.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values

array (string)

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.

9.1.23. .spec.affinity.podAffinity

Description
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Type
object
Expand
PropertyTypeDescription

preferredDuringSchedulingIgnoredDuringExecution

array

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.

preferredDuringSchedulingIgnoredDuringExecution[]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

requiredDuringSchedulingIgnoredDuringExecution

array

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.

requiredDuringSchedulingIgnoredDuringExecution[]

object

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

Description
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
Type
array
Description
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Type
object
Required
  • podAffinityTerm
  • weight
Expand
PropertyTypeDescription

podAffinityTerm

object

Required. A pod affinity term, associated with the corresponding weight.

weight

integer

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

Description
Required. A pod affinity term, associated with the corresponding weight.
Type
object
Required
  • topologyKey
Expand
PropertyTypeDescription

labelSelector

object

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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".

topologyKey

string

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.

Description
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Type
array
Description
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
Type
object
Required
  • topologyKey
Expand
PropertyTypeDescription

labelSelector

object

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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".

topologyKey

string

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.

Description
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.41. .spec.affinity.podAntiAffinity

Description
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Type
object
Expand
PropertyTypeDescription

preferredDuringSchedulingIgnoredDuringExecution

array

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 subtracting "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

preferredDuringSchedulingIgnoredDuringExecution[]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

requiredDuringSchedulingIgnoredDuringExecution

array

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.

requiredDuringSchedulingIgnoredDuringExecution[]

object

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

Description
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and subtracting "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
Type
array
Description
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Type
object
Required
  • podAffinityTerm
  • weight
Expand
PropertyTypeDescription

podAffinityTerm

object

Required. A pod affinity term, associated with the corresponding weight.

weight

integer

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

Description
Required. A pod affinity term, associated with the corresponding weight.
Type
object
Required
  • topologyKey
Expand
PropertyTypeDescription

labelSelector

object

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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".

topologyKey

string

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.

Description
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Type
array
Description
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
Type
object
Required
  • topologyKey
Expand
PropertyTypeDescription

labelSelector

object

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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".

topologyKey

string

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.

Description
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.59. .spec.alerting

Description
alerting defines the settings related to Alertmanager.
Type
object
Required
  • alertmanagers
Expand
PropertyTypeDescription

alertmanagers

array

alertmanagers endpoints where Prometheus should send alerts to.

alertmanagers[]

object

AlertmanagerEndpoints defines a selection of a single Endpoints object containing Alertmanager IPs to fire alerts against.

9.1.60. .spec.alerting.alertmanagers

Description
alertmanagers endpoints where Prometheus should send alerts to.
Type
array

9.1.61. .spec.alerting.alertmanagers[]

Description
AlertmanagerEndpoints defines a selection of a single Endpoints object containing Alertmanager IPs to fire alerts against.
Type
object
Required
  • name
  • port
Expand
PropertyTypeDescription

alertRelabelings

array

alertRelabelings defines the relabeling configs applied before sending alerts to a specific Alertmanager. It requires Prometheus >= v2.51.0.

alertRelabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

apiVersion

string

apiVersion defines the version of the Alertmanager API that Prometheus uses to send alerts. It can be "V1" or "V2". The field has no effect for Prometheus >= v3.0.0 because only the v2 API is supported.

authorization

object

authorization section for Alertmanager.

Cannot be set at the same time as basicAuth, bearerTokenFile or sigv4.

basicAuth

object

basicAuth configuration for Alertmanager.

Cannot be set at the same time as bearerTokenFile, authorization or sigv4.

bearerTokenFile

string

bearerTokenFile defines the file to read bearer token for Alertmanager.

Cannot be set at the same time as basicAuth, authorization, or sigv4.

Deprecated: this will be removed in a future release. Prefer using authorization.

enableHttp2

boolean

enableHttp2 defines whether to enable HTTP2.

name

string

name of the Endpoints object in the namespace.

namespace

string

namespace of the Endpoints object.

If not set, the object will be discovered in the namespace of the Prometheus object.

noProxy

string

noProxy defines 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.

pathPrefix

string

pathPrefix defines the prefix for the HTTP path alerts are pushed to.

port

integer-or-string

port on which the Alertmanager API is exposed.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

relabelings

array

relabelings defines the relabel configuration applied to the discovered Alertmanagers.

relabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

scheme

string

scheme defines the HTTP scheme to use when sending alerts.

sigv4

object

sigv4 defines AWS’s Signature Verification 4 for the URL.

It requires Prometheus >= v2.48.0.

Cannot be set at the same time as basicAuth, bearerTokenFile or authorization.

timeout

string

timeout defines a per-target Alertmanager timeout when pushing alerts.

tlsConfig

object

tlsConfig to use for Alertmanager.

Description
alertRelabelings defines the relabeling configs applied before sending alerts to a specific Alertmanager. It requires Prometheus >= v2.51.0.
Type
array
Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

Description

authorization section for Alertmanager.

Cannot be set at the same time as basicAuth, bearerTokenFile or sigv4.

Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.66. .spec.alerting.alertmanagers[].basicAuth

Description

basicAuth configuration for Alertmanager.

Cannot be set at the same time as bearerTokenFile, authorization or sigv4.

Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.72. .spec.alerting.alertmanagers[].relabelings

Description
relabelings defines the relabel configuration applied to the discovered Alertmanagers.
Type
array
Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

9.1.74. .spec.alerting.alertmanagers[].sigv4

Description

sigv4 defines AWS’s Signature Verification 4 for the URL.

It requires Prometheus >= v2.48.0.

Cannot be set at the same time as basicAuth, bearerTokenFile or authorization.

Type
object
Expand
PropertyTypeDescription

accessKey

object

accessKey defines the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID is used.

profile

string

profile defines the named AWS profile used to authenticate.

region

string

region defines the AWS region. If blank, the region from the default credentials chain used.

roleArn

string

roleArn defines the named AWS profile used to authenticate.

secretKey

object

secretKey defines the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY is used.

useFIPSSTSEndpoint

boolean

useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. It requires Prometheus >= v2.54.0.

Description
accessKey defines the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID is used.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
secretKey defines the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY is used.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.77. .spec.alerting.alertmanagers[].tlsConfig

Description
tlsConfig to use for Alertmanager.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

caFile

string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

cert

object

cert defines the Client certificate to present when doing client-authentication.

certFile

string

certFile defines the path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keyFile

string

keyFile defines the path to the client key file in the Prometheus container for the targets.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.85. .spec.apiserverConfig

Description
apiserverConfig allows specifying a host and auth methods to access the Kuberntees API server. If null, Prometheus is assumed to run inside of the cluster: it will discover the API servers automatically and use the Pod’s CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.
Type
object
Required
  • host
Expand
PropertyTypeDescription

authorization

object

authorization section for the API server.

Cannot be set at the same time as basicAuth, bearerToken, or bearerTokenFile.

basicAuth

object

basicAuth configuration for the API server.

Cannot be set at the same time as authorization, bearerToken, or bearerTokenFile.

bearerToken

string

bearerToken is deprecated: this will be removed in a future release. Warning: this field shouldn’t be used because the token value appears in clear-text. Prefer using authorization.

bearerTokenFile

string

bearerTokenFile defines the file to read bearer token for accessing apiserver.

Cannot be set at the same time as basicAuth, authorization, or bearerToken.

Deprecated: this will be removed in a future release. Prefer using authorization.

host

string

host defines the Kubernetes API address consisting of a hostname or IP address followed by an optional port number.

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

tlsConfig

object

tlsConfig to use for the API server.

9.1.86. .spec.apiserverConfig.authorization

Description

authorization section for the API server.

Cannot be set at the same time as basicAuth, bearerToken, or bearerTokenFile.

Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

credentialsFile

string

credentialsFile defines the file to read a secret from, mutually exclusive with credentials.

type

string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.88. .spec.apiserverConfig.basicAuth

Description

basicAuth configuration for the API server.

Cannot be set at the same time as authorization, bearerToken, or bearerTokenFile.

Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

9.1.89. .spec.apiserverConfig.basicAuth.password

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.90. .spec.apiserverConfig.basicAuth.username

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.91. .spec.apiserverConfig.proxyConnectHeader

Description

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.

Type
object

9.1.92. .spec.apiserverConfig.proxyConnectHeader{}

Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.94. .spec.apiserverConfig.tlsConfig

Description
tlsConfig to use for the API server.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

caFile

string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

cert

object

cert defines the Client certificate to present when doing client-authentication.

certFile

string

certFile defines the path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keyFile

string

keyFile defines the path to the client key file in the Prometheus container for the targets.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

9.1.95. .spec.apiserverConfig.tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.97. .spec.apiserverConfig.tlsConfig.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.98. .spec.apiserverConfig.tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.101. .spec.apiserverConfig.tlsConfig.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.102. .spec.arbitraryFSAccessThroughSMs

Description
arbitraryFSAccessThroughSMs when true, ServiceMonitor, PodMonitor and Probe object are forbidden to reference arbitrary files on the file system of the 'prometheus' container. When a ServiceMonitor’s endpoint specifies a bearerTokenFile value (e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a malicious target can get access to the Prometheus service account’s token in the Prometheus' scrape request. Setting spec.arbitraryFSAccessThroughSM to 'true' would prevent the attack. Users should instead provide the credentials using the spec.bearerTokenSecret field.
Type
object
Expand
PropertyTypeDescription

deny

boolean

deny prevents service monitors from accessing arbitrary files on the file system. When true, service monitors cannot use file-based configurations like BearerTokenFile that could potentially access sensitive files. When false (default), such access is allowed. Setting this to true enhances security by preventing potential credential theft attacks.

9.1.103. .spec.containers

Description

containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to the Pods or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch.

The names of containers managed by the operator are: * prometheus * config-reloader * thanos-sidecar

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.

Type
array

9.1.104. .spec.containers[]

Description
A single application container that you want to run within a pod.
Type
object
Required
  • name
Expand
PropertyTypeDescription

args

array (string)

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

command

array (string)

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

env

array

List of environment variables to set in the container. Cannot be updated.

env[]

object

EnvVar represents an environment variable present in a Container.

envFrom

array

List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. 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.

envFrom[]

object

EnvFromSource represents the source of a set of ConfigMaps or Secrets

image

string

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.

imagePullPolicy

string

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

object

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

livenessProbe

object

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

name

string

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

ports

array

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.

ports[]

object

ContainerPort represents a network port in a single container.

readinessProbe

object

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

resizePolicy

array

Resources resize policy for the container.

resizePolicy[]

object

ContainerResizePolicy represents resource resize policy for the container.

resources

object

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

restartPolicy

string

RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Additionally, 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.

restartPolicyRules

array

Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.

restartPolicyRules[]

object

ContainerRestartRule describes how a container exit is handled.

securityContext

object

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbe

object

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

stdin

boolean

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.

stdinOnce

boolean

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

terminationMessagePath

string

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.

terminationMessagePolicy

string

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.

tty

boolean

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

volumeDevices

array

volumeDevices is the list of block devices to be used by the container.

volumeDevices[]

object

volumeDevice describes a mapping of a raw block device within a container.

volumeMounts

array

Pod volumes to mount into the container’s filesystem. Cannot be updated.

volumeMounts[]

object

VolumeMount describes a mounting of a Volume within a container.

workingDir

string

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.

9.1.105. .spec.containers[].env

Description
List of environment variables to set in the container. Cannot be updated.
Type
array

9.1.106. .spec.containers[].env[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

Name of the environment variable. May consist of any printable ASCII characters except '='.

value

string

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 "".

valueFrom

object

Source for the environment variable’s value. Cannot be used if value is not empty.

9.1.107. .spec.containers[].env[].valueFrom

Description
Source for the environment variable’s value. Cannot be used if value is not empty.
Type
object
Expand
PropertyTypeDescription

configMapKeyRef

object

Selects a key of a ConfigMap.

fieldRef

object

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.

fileKeyRef

object

FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.

resourceFieldRef

object

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.

secretKeyRef

object

Selects a key of a secret in the pod’s namespace

Description
Selects a key of a ConfigMap.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
  • fieldPath
Expand
PropertyTypeDescription

apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPath

string

Path of the field to select in the specified API version.

Description
FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
Type
object
Required
  • key
  • path
  • volumeName
Expand
PropertyTypeDescription

key

string

The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

optional

boolean

Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod’s containers.

If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.

path

string

The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.

volumeName

string

The name of the volume mount containing the env file.

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
  • resource
Expand
PropertyTypeDescription

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

Specifies the output format of the exposed resources, defaults to "1"

resource

string

Required: resource to select

Description
Selects a key of a secret in the pod’s namespace
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.113. .spec.containers[].envFrom

Description
List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
Type
array

9.1.114. .spec.containers[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps or Secrets
Type
object
Expand
PropertyTypeDescription

configMapRef

object

The ConfigMap to select from

prefix

string

Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.

secretRef

object

The Secret to select from

9.1.115. .spec.containers[].envFrom[].configMapRef

Description
The ConfigMap to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the ConfigMap must be defined

9.1.116. .spec.containers[].envFrom[].secretRef

Description
The Secret to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the Secret must be defined

9.1.117. .spec.containers[].lifecycle

Description
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Type
object
Expand
PropertyTypeDescription

postStart

object

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStop

object

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

stopSignal

string

StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name

9.1.118. .spec.containers[].lifecycle.postStart

Description
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

9.1.125. .spec.containers[].lifecycle.preStop

Description
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

9.1.126. .spec.containers[].lifecycle.preStop.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

9.1.132. .spec.containers[].livenessProbe

Description
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

9.1.133. .spec.containers[].livenessProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

9.1.134. .spec.containers[].livenessProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

9.1.135. .spec.containers[].livenessProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

9.1.139. .spec.containers[].ports

Description
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.
Type
array

9.1.140. .spec.containers[].ports[]

Description
ContainerPort represents a network port in a single container.
Type
object
Required
  • containerPort
Expand
PropertyTypeDescription

containerPort

integer

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

hostIP

string

What host IP to bind the external port to.

hostPort

integer

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.

name

string

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

protocol

string

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

9.1.141. .spec.containers[].readinessProbe

Description
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

9.1.142. .spec.containers[].readinessProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

9.1.143. .spec.containers[].readinessProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

9.1.144. .spec.containers[].readinessProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

9.1.148. .spec.containers[].resizePolicy

Description
Resources resize policy for the container.
Type
array

9.1.149. .spec.containers[].resizePolicy[]

Description
ContainerResizePolicy represents resource resize policy for the container.
Type
object
Required
  • resourceName
  • restartPolicy
Expand
PropertyTypeDescription

resourceName

string

Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.

restartPolicy

string

Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

9.1.150. .spec.containers[].resources

Description
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object
Expand
PropertyTypeDescription

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

9.1.151. .spec.containers[].resources.claims

Description

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Type
array

9.1.152. .spec.containers[].resources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

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.

request

string

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.

9.1.153. .spec.containers[].restartPolicyRules

Description
Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.
Type
array

9.1.154. .spec.containers[].restartPolicyRules[]

Description
ContainerRestartRule describes how a container exit is handled.
Type
object
Required
  • action
Expand
PropertyTypeDescription

action

string

Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container.

exitCodes

object

Represents the exit codes to check on container exits.

Description
Represents the exit codes to check on container exits.
Type
object
Required
  • operator
Expand
PropertyTypeDescription

operator

string

Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values. - NotIn: the requirement is satisfied if the container exit code is not in the set of specified values.

values

array (integer)

Specifies the set of values to check for container exit codes. At most 255 elements are allowed.

9.1.156. .spec.containers[].securityContext

Description
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Type
object
Expand
PropertyTypeDescription

allowPrivilegeEscalation

boolean

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.

appArmorProfile

object

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.

capabilities

object

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.

privileged

boolean

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.

procMount

string

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.

readOnlyRootFilesystem

boolean

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.

runAsGroup

integer

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.

runAsNonRoot

boolean

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.

runAsUser

integer

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.

seLinuxOptions

object

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.

seccompProfile

object

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.

windowsOptions

object

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.

Description
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.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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".

type

string

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.

Description
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.
Type
object
Expand
PropertyTypeDescription

add

array (string)

Added capabilities

drop

array (string)

Removed capabilities

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Type
object
Expand
PropertyTypeDescription

level

string

Level is SELinux level label that applies to the container.

role

string

Role is a SELinux role label that applies to the container.

type

string

Type is a SELinux type label that applies to the container.

user

string

User is a SELinux user label that applies to the container.

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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.

type

string

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.

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
Expand
PropertyTypeDescription

gmsaCredentialSpec

string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcess

boolean

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.

runAsUserName

string

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.

9.1.162. .spec.containers[].startupProbe

Description
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

9.1.163. .spec.containers[].startupProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

9.1.164. .spec.containers[].startupProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

9.1.165. .spec.containers[].startupProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

9.1.168. .spec.containers[].startupProbe.tcpSocket

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

9.1.169. .spec.containers[].volumeDevices

Description
volumeDevices is the list of block devices to be used by the container.
Type
array

9.1.170. .spec.containers[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
  • devicePath
  • name
Expand
PropertyTypeDescription

devicePath

string

devicePath is the path inside of the container that the device will be mapped to.

name

string

name must match the name of a persistentVolumeClaim in the pod

9.1.171. .spec.containers[].volumeMounts

Description
Pod volumes to mount into the container’s filesystem. Cannot be updated.
Type
array

9.1.172. .spec.containers[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
  • mountPath
  • name
Expand
PropertyTypeDescription

mountPath

string

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation

string

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).

name

string

This must match the Name of a Volume.

readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly

string

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.

subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

subPathExpr

string

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.

9.1.173. .spec.dnsConfig

Description
dnsConfig defines the DNS configuration for the pods.
Type
object
Expand
PropertyTypeDescription

nameservers

array (string)

nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy.

options

array

options defines the 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.

options[]

object

PodDNSConfigOption defines DNS resolver options of a pod.

searches

array (string)

searches defines the list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy.

9.1.174. .spec.dnsConfig.options

Description
options defines the 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.
Type
array

9.1.175. .spec.dnsConfig.options[]

Description
PodDNSConfigOption defines DNS resolver options of a pod.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name is required and must be unique.

value

string

value is optional.

9.1.176. .spec.excludedFromEnforcement

Description

excludedFromEnforcement defines the list of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects to be excluded from enforcing a namespace label of origin.

It is only applicable if spec.enforcedNamespaceLabel set to true.

Type
array

9.1.177. .spec.excludedFromEnforcement[]

Description
ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.
Type
object
Required
  • namespace
  • resource
Expand
PropertyTypeDescription

group

string

group of the referent. When not specified, it defaults to monitoring.coreos.com

name

string

name of the referent. When not set, all resources in the namespace are matched.

namespace

string

namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resource

string

resource of the referent.

9.1.178. .spec.exemplars

Description
exemplars related settings that are runtime reloadable. It requires to enable the exemplar-storage feature flag to be effective.
Type
object
Expand
PropertyTypeDescription

maxSize

integer

maxSize defines the maximum number of exemplars stored in memory for all series.

exemplar-storage itself must be enabled using the spec.enableFeature option for exemplars to be scraped in the first place.

If not set, Prometheus uses its default value. A value of zero or less than zero disables the storage.

9.1.179. .spec.hostAliases

Description
hostAliases defines the optional list of hosts and IPs that will be injected into the Pod’s hosts file if specified.
Type
array

9.1.180. .spec.hostAliases[]

Description
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
Type
object
Required
  • hostnames
  • ip
Expand
PropertyTypeDescription

hostnames

array (string)

hostnames defines hostnames for the above IP address.

ip

string

ip defines the IP address of the host file entry.

9.1.181. .spec.imagePullSecrets

Description
imagePullSecrets defines an optional list of references to Secrets in the same namespace to use for pulling images from registries. See http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
Type
array

9.1.182. .spec.imagePullSecrets[]

Description
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Type
object
Expand
PropertyTypeDescription

name

string

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

9.1.183. .spec.initContainers

Description

initContainers allows injecting initContainers to the Pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus 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 names of init container name managed by the operator are: * 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.

Type
array

9.1.184. .spec.initContainers[]

Description
A single application container that you want to run within a pod.
Type
object
Required
  • name
Expand
PropertyTypeDescription

args

array (string)

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

command

array (string)

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

env

array

List of environment variables to set in the container. Cannot be updated.

env[]

object

EnvVar represents an environment variable present in a Container.

envFrom

array

List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. 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.

envFrom[]

object

EnvFromSource represents the source of a set of ConfigMaps or Secrets

image

string

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.

imagePullPolicy

string

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

object

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

livenessProbe

object

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

name

string

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

ports

array

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.

ports[]

object

ContainerPort represents a network port in a single container.

readinessProbe

object

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

resizePolicy

array

Resources resize policy for the container.

resizePolicy[]

object

ContainerResizePolicy represents resource resize policy for the container.

resources

object

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

restartPolicy

string

RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Additionally, 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.

restartPolicyRules

array

Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.

restartPolicyRules[]

object

ContainerRestartRule describes how a container exit is handled.

securityContext

object

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbe

object

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

stdin

boolean

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.

stdinOnce

boolean

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

terminationMessagePath

string

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.

terminationMessagePolicy

string

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.

tty

boolean

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

volumeDevices

array

volumeDevices is the list of block devices to be used by the container.

volumeDevices[]

object

volumeDevice describes a mapping of a raw block device within a container.

volumeMounts

array

Pod volumes to mount into the container’s filesystem. Cannot be updated.

volumeMounts[]

object

VolumeMount describes a mounting of a Volume within a container.

workingDir

string

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.

9.1.185. .spec.initContainers[].env

Description
List of environment variables to set in the container. Cannot be updated.
Type
array

9.1.186. .spec.initContainers[].env[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

Name of the environment variable. May consist of any printable ASCII characters except '='.

value

string

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 "".

valueFrom

object

Source for the environment variable’s value. Cannot be used if value is not empty.

9.1.187. .spec.initContainers[].env[].valueFrom

Description
Source for the environment variable’s value. Cannot be used if value is not empty.
Type
object
Expand
PropertyTypeDescription

configMapKeyRef

object

Selects a key of a ConfigMap.

fieldRef

object

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.

fileKeyRef

object

FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.

resourceFieldRef

object

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.

secretKeyRef

object

Selects a key of a secret in the pod’s namespace

Description
Selects a key of a ConfigMap.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
  • fieldPath
Expand
PropertyTypeDescription

apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPath

string

Path of the field to select in the specified API version.

Description
FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
Type
object
Required
  • key
  • path
  • volumeName
Expand
PropertyTypeDescription

key

string

The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

optional

boolean

Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod’s containers.

If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.

path

string

The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.

volumeName

string

The name of the volume mount containing the env file.

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
  • resource
Expand
PropertyTypeDescription

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

Specifies the output format of the exposed resources, defaults to "1"

resource

string

Required: resource to select

Description
Selects a key of a secret in the pod’s namespace
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.193. .spec.initContainers[].envFrom

Description
List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
Type
array

9.1.194. .spec.initContainers[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps or Secrets
Type
object
Expand
PropertyTypeDescription

configMapRef

object

The ConfigMap to select from

prefix

string

Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.

secretRef

object

The Secret to select from

Description
The ConfigMap to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the ConfigMap must be defined

Description
The Secret to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the Secret must be defined

9.1.197. .spec.initContainers[].lifecycle

Description
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Type
object
Expand
PropertyTypeDescription

postStart

object

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStop

object

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

stopSignal

string

StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name

Description
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

9.1.205. .spec.initContainers[].lifecycle.preStop

Description
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

9.1.212. .spec.initContainers[].livenessProbe

Description
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

9.1.213. .spec.initContainers[].livenessProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

9.1.214. .spec.initContainers[].livenessProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

9.1.219. .spec.initContainers[].ports

Description
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.
Type
array

9.1.220. .spec.initContainers[].ports[]

Description
ContainerPort represents a network port in a single container.
Type
object
Required
  • containerPort
Expand
PropertyTypeDescription

containerPort

integer

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

hostIP

string

What host IP to bind the external port to.

hostPort

integer

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.

name

string

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

protocol

string

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

9.1.221. .spec.initContainers[].readinessProbe

Description
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

9.1.228. .spec.initContainers[].resizePolicy

Description
Resources resize policy for the container.
Type
array

9.1.229. .spec.initContainers[].resizePolicy[]

Description
ContainerResizePolicy represents resource resize policy for the container.
Type
object
Required
  • resourceName
  • restartPolicy
Expand
PropertyTypeDescription

resourceName

string

Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.

restartPolicy

string

Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

9.1.230. .spec.initContainers[].resources

Description
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object
Expand
PropertyTypeDescription

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

9.1.231. .spec.initContainers[].resources.claims

Description

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Type
array

9.1.232. .spec.initContainers[].resources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

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.

request

string

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.

9.1.233. .spec.initContainers[].restartPolicyRules

Description
Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.
Type
array
Description
ContainerRestartRule describes how a container exit is handled.
Type
object
Required
  • action
Expand
PropertyTypeDescription

action

string

Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container.

exitCodes

object

Represents the exit codes to check on container exits.

Description
Represents the exit codes to check on container exits.
Type
object
Required
  • operator
Expand
PropertyTypeDescription

operator

string

Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values. - NotIn: the requirement is satisfied if the container exit code is not in the set of specified values.

values

array (integer)

Specifies the set of values to check for container exit codes. At most 255 elements are allowed.

9.1.236. .spec.initContainers[].securityContext

Description
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Type
object
Expand
PropertyTypeDescription

allowPrivilegeEscalation

boolean

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.

appArmorProfile

object

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.

capabilities

object

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.

privileged

boolean

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.

procMount

string

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.

readOnlyRootFilesystem

boolean

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.

runAsGroup

integer

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.

runAsNonRoot

boolean

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.

runAsUser

integer

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.

seLinuxOptions

object

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.

seccompProfile

object

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.

windowsOptions

object

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.

Description
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.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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".

type

string

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.

Description
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.
Type
object
Expand
PropertyTypeDescription

add

array (string)

Added capabilities

drop

array (string)

Removed capabilities

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Type
object
Expand
PropertyTypeDescription

level

string

Level is SELinux level label that applies to the container.

role

string

Role is a SELinux role label that applies to the container.

type

string

Type is a SELinux type label that applies to the container.

user

string

User is a SELinux user label that applies to the container.

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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.

type

string

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.

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
Expand
PropertyTypeDescription

gmsaCredentialSpec

string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcess

boolean

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.

runAsUserName

string

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.

9.1.242. .spec.initContainers[].startupProbe

Description
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

9.1.243. .spec.initContainers[].startupProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

9.1.244. .spec.initContainers[].startupProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

9.1.249. .spec.initContainers[].volumeDevices

Description
volumeDevices is the list of block devices to be used by the container.
Type
array

9.1.250. .spec.initContainers[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
  • devicePath
  • name
Expand
PropertyTypeDescription

devicePath

string

devicePath is the path inside of the container that the device will be mapped to.

name

string

name must match the name of a persistentVolumeClaim in the pod

9.1.251. .spec.initContainers[].volumeMounts

Description
Pod volumes to mount into the container’s filesystem. Cannot be updated.
Type
array

9.1.252. .spec.initContainers[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
  • mountPath
  • name
Expand
PropertyTypeDescription

mountPath

string

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation

string

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).

name

string

This must match the Name of a Volume.

readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly

string

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.

subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

subPathExpr

string

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.

9.1.253. .spec.otlp

Description
otlp defines the settings related to the OTLP receiver feature. It requires Prometheus >= v2.55.0.
Type
object
Expand
PropertyTypeDescription

convertHistogramsToNHCB

boolean

convertHistogramsToNHCB defines optional translation of OTLP explicit bucket histograms into native histograms with custom buckets. It requires Prometheus >= v3.4.0.

ignoreResourceAttributes

array (string)

ignoreResourceAttributes defines the list of OpenTelemetry resource attributes to ignore when promoteAllResourceAttributes is true.

It requires promoteAllResourceAttributes to be true. It requires Prometheus >= v3.5.0.

keepIdentifyingResourceAttributes

boolean

keepIdentifyingResourceAttributes enables adding service.name, service.namespace and service.instance.id resource attributes to the target_info metric, on top of converting them into the instance and job labels.

It requires Prometheus >= v3.1.0.

promoteAllResourceAttributes

boolean

promoteAllResourceAttributes promotes all resource attributes to metric labels except the ones defined in ignoreResourceAttributes.

Cannot be true when promoteResourceAttributes is defined. It requires Prometheus >= v3.5.0.

promoteResourceAttributes

array (string)

promoteResourceAttributes defines the list of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. Cannot be defined when promoteAllResourceAttributes is true.

promoteScopeMetadata

boolean

promoteScopeMetadata controls whether to promote OpenTelemetry scope metadata (i.e. name, version, schema URL, and attributes) to metric labels. As per the OpenTelemetry specification, the aforementioned scope metadata should be identifying, i.e. made into metric labels. It requires Prometheus >= v3.6.0.

translationStrategy

string

translationStrategy defines how the OTLP receiver endpoint translates the incoming metrics.

It requires Prometheus >= v3.0.0.

Description
persistentVolumeClaimRetentionPolicy defines 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.
Type
object
Expand
PropertyTypeDescription

whenDeleted

string

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.

whenScaled

string

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.

9.1.255. .spec.podMetadata

Description

podMetadata defines labels and annotations which are propagated to the Prometheus pods.

The following items are reserved and cannot be overridden: * "prometheus" label, set to the name of the Prometheus object. * "app.kubernetes.io/instance" label, set to the name of the Prometheus object. * "app.kubernetes.io/managed-by" label, set to "prometheus-operator". * "app.kubernetes.io/name" label, set to "prometheus". * "app.kubernetes.io/version" label, set to the Prometheus version. * "operator.prometheus.io/name" label, set to the name of the Prometheus object. * "operator.prometheus.io/shard" label, set to the shard number of the Prometheus object. * "kubectl.kubernetes.io/default-container" annotation, set to "prometheus".

Type
object
Expand
PropertyTypeDescription

annotations

object (string)

annotations defines 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

labels

object (string)

labels define the 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

name

string

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

9.1.256. .spec.podMonitorNamespaceSelector

Description
podMonitorNamespaceSelector defines the namespaces to match for PodMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.259. .spec.podMonitorSelector

Description

podMonitorSelector defines the podMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.

If spec.serviceMonitorSelector, spec.podMonitorSelector, spec.probeSelector and spec.scrapeConfigSelector are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration’s Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the prometheus.yaml.gz key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use spec.additionalScrapeConfigs instead.

Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

9.1.260. .spec.podMonitorSelector.matchExpressions

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.262. .spec.probeNamespaceSelector

Description
probeNamespaceSelector defines the namespaces to match for Probe discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.265. .spec.probeSelector

Description

probeSelector defines the probes to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.

If spec.serviceMonitorSelector, spec.podMonitorSelector, spec.probeSelector and spec.scrapeConfigSelector are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration’s Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the prometheus.yaml.gz key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use spec.additionalScrapeConfigs instead.

Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

9.1.266. .spec.probeSelector.matchExpressions

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array

9.1.267. .spec.probeSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.268. .spec.prometheusRulesExcludedFromEnforce

Description
prometheusRulesExcludedFromEnforce defines the list of PrometheusRule objects to which the namespace label enforcement doesn’t apply. This is only relevant when spec.enforcedNamespaceLabel is set to true. Deprecated: use spec.excludedFromEnforcement instead.
Type
array
Description
PrometheusRuleExcludeConfig enables users to configure excluded PrometheusRule names and their namespaces to be ignored while enforcing namespace label for alerts and metrics.
Type
object
Required
  • ruleName
  • ruleNamespace
Expand
PropertyTypeDescription

ruleName

string

ruleName defines the name of the excluded PrometheusRule object.

ruleNamespace

string

ruleNamespace defines the namespace of the excluded PrometheusRule object.

9.1.270. .spec.query

Description
query defines the configuration of the Prometheus query service.
Type
object
Expand
PropertyTypeDescription

lookbackDelta

string

lookbackDelta defines the delta difference allowed for retrieving metrics during expression evaluations.

maxConcurrency

integer

maxConcurrency defines the number of concurrent queries that can be run at once.

maxSamples

integer

maxSamples defines the maximum number of samples a single query can load into memory. Note that queries will fail if they would load more samples than this into memory, so this also limits the number of samples a query can return.

timeout

string

timeout defines the maximum time a query may take before being aborted.

9.1.271. .spec.remoteRead

Description
remoteRead defines the list of remote read configurations.
Type
array

9.1.272. .spec.remoteRead[]

Description
RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
Type
object
Required
  • url
Expand
PropertyTypeDescription

authorization

object

authorization section for the URL.

It requires Prometheus >= v2.26.0.

Cannot be set at the same time as basicAuth, or oauth2.

basicAuth

object

basicAuth configuration for the URL.

Cannot be set at the same time as authorization, or oauth2.

bearerToken

string

bearerToken is deprecated: this will be removed in a future release. Warning: this field shouldn’t be used because the token value appears in clear-text. Prefer using authorization.

bearerTokenFile

string

bearerTokenFile defines the file from which to read the bearer token for the URL.

Deprecated: this will be removed in a future release. Prefer using authorization.

filterExternalLabels

boolean

filterExternalLabels defines whether to use the external labels as selectors for the remote read endpoint.

It requires Prometheus >= v2.34.0.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects.

It requires Prometheus >= v2.26.0.

headers

object (string)

headers defines the custom HTTP headers to be sent along with each remote read request. Be aware that headers that are set by Prometheus itself can’t be overwritten. Only valid in Prometheus versions 2.26.0 and newer.

name

string

name of the remote read queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate read configurations.

It requires Prometheus >= v2.15.0.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 configuration for the URL.

It requires Prometheus >= v2.27.0.

Cannot be set at the same time as authorization, or basicAuth.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

readRecent

boolean

readRecent defines whether reads should be made for queries for time ranges that the local storage should have complete data for.

remoteTimeout

string

remoteTimeout defines the timeout for requests to the remote read endpoint.

requiredMatchers

object (string)

requiredMatchers defines an optional list of equality matchers which have to be present in a selector to query the remote read endpoint.

tlsConfig

object

tlsConfig to use for the URL.

url

string

url defines the URL of the endpoint to query from.

9.1.273. .spec.remoteRead[].authorization

Description

authorization section for the URL.

It requires Prometheus >= v2.26.0.

Cannot be set at the same time as basicAuth, or oauth2.

Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

credentialsFile

string

credentialsFile defines the file to read a secret from, mutually exclusive with credentials.

type

string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.275. .spec.remoteRead[].basicAuth

Description

basicAuth configuration for the URL.

Cannot be set at the same time as authorization, or oauth2.

Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

9.1.276. .spec.remoteRead[].basicAuth.password

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.277. .spec.remoteRead[].basicAuth.username

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.278. .spec.remoteRead[].oauth2

Description

oauth2 configuration for the URL.

It requires Prometheus >= v2.27.0.

Cannot be set at the same time as authorization, or basicAuth.

Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

endpointParams configures the HTTP parameters to append to the token URL.

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

9.1.279. .spec.remoteRead[].oauth2.clientId

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.281. .spec.remoteRead[].oauth2.clientId.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.282. .spec.remoteRead[].oauth2.clientSecret

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.286. .spec.remoteRead[].oauth2.tlsConfig

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

9.1.287. .spec.remoteRead[].oauth2.tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.290. .spec.remoteRead[].oauth2.tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.294. .spec.remoteRead[].proxyConnectHeader

Description

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.

Type
object

9.1.295. .spec.remoteRead[].proxyConnectHeader{}

Description
Type
array

9.1.296. .spec.remoteRead[].proxyConnectHeader{}[]

Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.297. .spec.remoteRead[].tlsConfig

Description
tlsConfig to use for the URL.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

caFile

string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

cert

object

cert defines the Client certificate to present when doing client-authentication.

certFile

string

certFile defines the path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keyFile

string

keyFile defines the path to the client key file in the Prometheus container for the targets.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

9.1.298. .spec.remoteRead[].tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

9.1.299. .spec.remoteRead[].tlsConfig.ca.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.300. .spec.remoteRead[].tlsConfig.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.301. .spec.remoteRead[].tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.303. .spec.remoteRead[].tlsConfig.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.304. .spec.remoteRead[].tlsConfig.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.305. .spec.remoteWrite

Description
remoteWrite defines the list of remote write configurations.
Type
array

9.1.306. .spec.remoteWrite[]

Description
RemoteWriteSpec defines the configuration to write samples from Prometheus to a remote endpoint.
Type
object
Required
  • url
Expand
PropertyTypeDescription

authorization

object

authorization section for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as sigv4, basicAuth, oauth2, or azureAd.

azureAd

object

azureAd for the URL.

It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.

Cannot be set at the same time as authorization, basicAuth, oauth2, or sigv4.

basicAuth

object

basicAuth configuration for the URL.

Cannot be set at the same time as sigv4, authorization, oauth2, or azureAd.

bearerToken

string

bearerToken is deprecated: this will be removed in a future release. Warning: this field shouldn’t be used because the token value appears in clear-text. Prefer using authorization.

bearerTokenFile

string

bearerTokenFile defines the file from which to read bearer token for the URL.

Deprecated: this will be removed in a future release. Prefer using authorization.

enableHTTP2

boolean

enableHTTP2 defines whether to enable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

headers

object (string)

headers defines the custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can’t be overwritten.

It requires Prometheus >= v2.25.0 or Thanos >= v0.24.0.

messageVersion

string

messageVersion defines the Remote Write message’s version to use when writing to the endpoint.

Version1.0 corresponds to the prometheus.WriteRequest protobuf message introduced in Remote Write 1.0. Version2.0 corresponds to the io.prometheus.write.v2.Request protobuf message introduced in Remote Write 2.0.

When Version2.0 is selected, Prometheus will automatically be configured to append the metadata of scraped metrics to the WAL.

Before setting this field, consult with your remote storage provider what message version it supports.

It requires Prometheus >= v2.54.0 or Thanos >= v0.37.0.

metadataConfig

object

metadataConfig defines how to send a series metadata to the remote storage.

When the field is empty, no metadata is sent. But when the field is null, metadata is sent.

name

string

name of the remote write queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate queues.

It requires Prometheus >= v2.15.0 or Thanos >= 0.24.0.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 configuration for the URL.

It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.

Cannot be set at the same time as sigv4, authorization, basicAuth, or azureAd.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

queueConfig

object

queueConfig allows tuning of the remote write queue parameters.

remoteTimeout

string

remoteTimeout defines the timeout for requests to the remote write endpoint.

roundRobinDNS

boolean

roundRobinDNS controls the DNS resolution behavior for remote-write connections. When enabled: - The remote-write mechanism will resolve the hostname via DNS. - It will randomly select one of the resolved IP addresses and connect to it.

When disabled (default behavior): - The Go standard library will handle hostname resolution. - It will attempt connections to each resolved IP address sequentially.

Note: The connection timeout applies to the entire resolution and connection process.

If disabled, the timeout is distributed across all connection attempts.

It requires Prometheus >= v3.1.0 or Thanos >= v0.38.0.

sendExemplars

boolean

sendExemplars enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the spec.enableFeatures option for exemplars to be scraped in the first place.

It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.

sendNativeHistograms

boolean

sendNativeHistograms enables sending of native histograms, also known as sparse histograms over remote write.

It requires Prometheus >= v2.40.0 or Thanos >= v0.30.0.

sigv4

object

sigv4 defines the AWS’s Signature Verification 4 for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as authorization, basicAuth, oauth2, or azureAd.

tlsConfig

object

tlsConfig to use for the URL.

url

string

url defines the URL of the endpoint to send samples to.

writeRelabelConfigs

array

writeRelabelConfigs defines the list of remote write relabel configurations.

writeRelabelConfigs[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

9.1.307. .spec.remoteWrite[].authorization

Description

authorization section for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as sigv4, basicAuth, oauth2, or azureAd.

Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

credentialsFile

string

credentialsFile defines the file to read a secret from, mutually exclusive with credentials.

type

string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.309. .spec.remoteWrite[].azureAd

Description

azureAd for the URL.

It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.

Cannot be set at the same time as authorization, basicAuth, oauth2, or sigv4.

Type
object
Expand
PropertyTypeDescription

cloud

string

cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.

managedIdentity

object

managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as oauth or sdk.

oauth

object

oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as managedIdentity or sdk.

It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.

sdk

object

sdk defines the Azure SDK config that is being used to authenticate. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication Cannot be set at the same time as oauth or managedIdentity.

It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.

Description
managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as oauth or sdk.
Type
object
Expand
PropertyTypeDescription

clientId

string

clientId defines the Azure User-assigned Managed identity.

For Prometheus >= 3.5.0 and Thanos >= 0.40.0, this field is allowed to be empty to support system-assigned managed identities.

9.1.311. .spec.remoteWrite[].azureAd.oauth

Description

oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as managedIdentity or sdk.

It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.

Type
object
Required
  • clientId
  • clientSecret
  • tenantId
Expand
PropertyTypeDescription

clientId

string

clientId defines the clientId of the Azure Active Directory application that is being used to authenticate.

clientSecret

object

clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.

tenantId

string

tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate.

Description
clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.313. .spec.remoteWrite[].azureAd.sdk

Description

sdk defines the Azure SDK config that is being used to authenticate. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication Cannot be set at the same time as oauth or managedIdentity.

It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.

Type
object
Expand
PropertyTypeDescription

tenantId

string

tenantId defines the tenant ID of the azure active directory application that is being used to authenticate.

9.1.314. .spec.remoteWrite[].basicAuth

Description

basicAuth configuration for the URL.

Cannot be set at the same time as sigv4, authorization, oauth2, or azureAd.

Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

9.1.315. .spec.remoteWrite[].basicAuth.password

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.316. .spec.remoteWrite[].basicAuth.username

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.317. .spec.remoteWrite[].metadataConfig

Description

metadataConfig defines how to send a series metadata to the remote storage.

When the field is empty, no metadata is sent. But when the field is null, metadata is sent.

Type
object
Expand
PropertyTypeDescription

maxSamplesPerSend

integer

maxSamplesPerSend defines the maximum number of metadata samples per send.

It requires Prometheus >= v2.29.0.

send

boolean

send defines whether metric metadata is sent to the remote storage or not.

sendInterval

string

sendInterval defines how frequently metric metadata is sent to the remote storage.

9.1.318. .spec.remoteWrite[].oauth2

Description

oauth2 configuration for the URL.

It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.

Cannot be set at the same time as sigv4, authorization, basicAuth, or azureAd.

Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

endpointParams configures the HTTP parameters to append to the token URL.

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

9.1.319. .spec.remoteWrite[].oauth2.clientId

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.322. .spec.remoteWrite[].oauth2.clientSecret

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.326. .spec.remoteWrite[].oauth2.tlsConfig

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

9.1.327. .spec.remoteWrite[].oauth2.tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.330. .spec.remoteWrite[].oauth2.tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.334. .spec.remoteWrite[].proxyConnectHeader

Description

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.

Type
object

9.1.335. .spec.remoteWrite[].proxyConnectHeader{}

Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.337. .spec.remoteWrite[].queueConfig

Description
queueConfig allows tuning of the remote write queue parameters.
Type
object
Expand
PropertyTypeDescription

batchSendDeadline

string

batchSendDeadline defines the maximum time a sample will wait in buffer.

capacity

integer

capacity defines the number of samples to buffer per shard before we start dropping them.

maxBackoff

string

maxBackoff defines the maximum retry delay.

maxRetries

integer

maxRetries defines the maximum number of times to retry a batch on recoverable errors.

maxSamplesPerSend

integer

maxSamplesPerSend defines the maximum number of samples per send.

maxShards

integer

maxShards defines the maximum number of shards, i.e. amount of concurrency.

minBackoff

string

minBackoff defines the initial retry delay. Gets doubled for every retry.

minShards

integer

minShards defines the minimum number of shards, i.e. amount of concurrency.

retryOnRateLimit

boolean

retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage.

This is an experimental feature, it may change in any upcoming release in a breaking way.

sampleAgeLimit

string

sampleAgeLimit drops samples older than the limit. It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0.

9.1.338. .spec.remoteWrite[].sigv4

Description

sigv4 defines the AWS’s Signature Verification 4 for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as authorization, basicAuth, oauth2, or azureAd.

Type
object
Expand
PropertyTypeDescription

accessKey

object

accessKey defines the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID is used.

profile

string

profile defines the named AWS profile used to authenticate.

region

string

region defines the AWS region. If blank, the region from the default credentials chain used.

roleArn

string

roleArn defines the named AWS profile used to authenticate.

secretKey

object

secretKey defines the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY is used.

useFIPSSTSEndpoint

boolean

useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. It requires Prometheus >= v2.54.0.

9.1.339. .spec.remoteWrite[].sigv4.accessKey

Description
accessKey defines the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID is used.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.340. .spec.remoteWrite[].sigv4.secretKey

Description
secretKey defines the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY is used.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.341. .spec.remoteWrite[].tlsConfig

Description
tlsConfig to use for the URL.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

caFile

string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

cert

object

cert defines the Client certificate to present when doing client-authentication.

certFile

string

certFile defines the path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keyFile

string

keyFile defines the path to the client key file in the Prometheus container for the targets.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

9.1.342. .spec.remoteWrite[].tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.344. .spec.remoteWrite[].tlsConfig.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.345. .spec.remoteWrite[].tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.347. .spec.remoteWrite[].tlsConfig.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.348. .spec.remoteWrite[].tlsConfig.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.349. .spec.remoteWrite[].writeRelabelConfigs

Description
writeRelabelConfigs defines the list of remote write relabel configurations.
Type
array

9.1.350. .spec.remoteWrite[].writeRelabelConfigs[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

9.1.351. .spec.resources

Description
resources defines the resources requests and limits of the 'prometheus' container.
Type
object
Expand
PropertyTypeDescription

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

9.1.352. .spec.resources.claims

Description

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Type
array

9.1.353. .spec.resources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

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.

request

string

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.

9.1.354. .spec.ruleNamespaceSelector

Description
ruleNamespaceSelector defines the namespaces to match for PrometheusRule discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.357. .spec.ruleSelector

Description
ruleSelector defines the prometheusRule objects to be selected for rule evaluation. An empty label selector matches all objects. A null label selector matches no objects.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

9.1.358. .spec.ruleSelector.matchExpressions

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array

9.1.359. .spec.ruleSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.360. .spec.rules

Description
rules defines the configuration of the Prometheus rules' engine.
Type
object
Expand
PropertyTypeDescription

alert

object

alert defines the parameters of the Prometheus rules' engine.

Any update to these parameters trigger a restart of the pods.

9.1.361. .spec.rules.alert

Description

alert defines the parameters of the Prometheus rules' engine.

Any update to these parameters trigger a restart of the pods.

Type
object
Expand
PropertyTypeDescription

forGracePeriod

string

forGracePeriod defines the minimum duration between alert and restored 'for' state.

This is maintained only for alerts with a configured 'for' time greater than the grace period.

forOutageTolerance

string

forOutageTolerance defines the max time to tolerate prometheus outage for restoring 'for' state of alert.

resendDelay

string

resendDelay defines the minimum amount of time to wait before resending an alert to Alertmanager.

9.1.362. .spec.runtime

Description
runtime defines the values for the Prometheus process behavior
Type
object
Expand
PropertyTypeDescription

goGC

integer

goGC defines the Go garbage collection target percentage. Lowering this number may increase the CPU usage. See: https://tip.golang.org/doc/gc-guide#GOGC

9.1.363. .spec.scrapeClasses

Description

scrapeClasses defines the list of scrape classes to expose to scraping objects such as PodMonitors, ServiceMonitors, Probes and ScrapeConfigs.

This is an experimental feature, it may change in any upcoming release in a breaking way.

Type
array

9.1.364. .spec.scrapeClasses[]

Description
Type
object
Required
  • name
Expand
PropertyTypeDescription

attachMetadata

object

attachMetadata defines additional metadata to the discovered targets. When the scrape object defines its own configuration, it takes precedence over the scrape class configuration.

authorization

object

authorization section for the ScrapeClass. It will only apply if the scrape resource doesn’t specify any Authorization.

default

boolean

default defines that the scrape applies to all scrape objects that don’t configure an explicit scrape class name.

Only one scrape class can be set as the default.

fallbackScrapeProtocol

string

fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It will only apply if the scrape resource doesn’t specify any FallbackScrapeProtocol

It requires Prometheus >= v3.0.0.

metricRelabelings

array

metricRelabelings defines the relabeling rules to apply to all samples before ingestion.

The Operator adds the scrape class metric relabelings defined here. Then the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs. Then the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

metricRelabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

name

string

name of the scrape class.

relabelings

array

relabelings defines the relabeling rules to apply to all scrape targets.

The Operator automatically adds relabelings for a few standard Kubernetes fields like __meta_kubernetes_namespace and \__meta_kubernetes_service_name. Then the Operator adds the scrape class relabelings defined here. Then the Operator adds the target-specific relabelings defined in the scrape object.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

tlsConfig

object

tlsConfig defines the TLS settings to use for the scrape. When the scrape objects define their own CA, certificate and/or key, they take precedence over the corresponding scrape class fields.

For now only the caFile, certFile and keyFile fields are supported.

9.1.365. .spec.scrapeClasses[].attachMetadata

Description
attachMetadata defines additional metadata to the discovered targets. When the scrape object defines its own configuration, it takes precedence over the scrape class configuration.
Type
object
Expand
PropertyTypeDescription

node

boolean

node when set to true, Prometheus attaches node metadata to the discovered targets.

The Prometheus service account must have the list and watch permissions on the Nodes objects.

9.1.366. .spec.scrapeClasses[].authorization

Description
authorization section for the ScrapeClass. It will only apply if the scrape resource doesn’t specify any Authorization.
Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

credentialsFile

string

credentialsFile defines the file to read a secret from, mutually exclusive with credentials.

type

string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.368. .spec.scrapeClasses[].metricRelabelings

Description

metricRelabelings defines the relabeling rules to apply to all samples before ingestion.

The Operator adds the scrape class metric relabelings defined here. Then the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs. Then the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

Type
array

9.1.369. .spec.scrapeClasses[].metricRelabelings[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

9.1.370. .spec.scrapeClasses[].relabelings

Description

relabelings defines the relabeling rules to apply to all scrape targets.

The Operator automatically adds relabelings for a few standard Kubernetes fields like __meta_kubernetes_namespace and \__meta_kubernetes_service_name. Then the Operator adds the scrape class relabelings defined here. Then the Operator adds the target-specific relabelings defined in the scrape object.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
array

9.1.371. .spec.scrapeClasses[].relabelings[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

9.1.372. .spec.scrapeClasses[].tlsConfig

Description

tlsConfig defines the TLS settings to use for the scrape. When the scrape objects define their own CA, certificate and/or key, they take precedence over the corresponding scrape class fields.

For now only the caFile, certFile and keyFile fields are supported.

Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

caFile

string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

cert

object

cert defines the Client certificate to present when doing client-authentication.

certFile

string

certFile defines the path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keyFile

string

keyFile defines the path to the client key file in the Prometheus container for the targets.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

9.1.373. .spec.scrapeClasses[].tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.375. .spec.scrapeClasses[].tlsConfig.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.376. .spec.scrapeClasses[].tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.379. .spec.scrapeClasses[].tlsConfig.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.380. .spec.scrapeConfigNamespaceSelector

Description

scrapeConfigNamespaceSelector defines the namespaces to match for ScrapeConfig discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only.

Note that the ScrapeConfig custom resource definition is currently at Alpha level.

Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.383. .spec.scrapeConfigSelector

Description

scrapeConfigSelector defines the scrapeConfigs to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.

If spec.serviceMonitorSelector, spec.podMonitorSelector, spec.probeSelector and spec.scrapeConfigSelector are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration’s Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the prometheus.yaml.gz key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use spec.additionalScrapeConfigs instead.

Note that the ScrapeConfig custom resource definition is currently at Alpha level.

Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.386. .spec.securityContext

Description
securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
Type
object
Expand
PropertyTypeDescription

appArmorProfile

object

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.

fsGroup

integer

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.

fsGroupChangePolicy

string

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.

runAsGroup

integer

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.

runAsNonRoot

boolean

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.

runAsUser

integer

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.

seLinuxChangePolicy

string

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.

seLinuxOptions

object

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.

seccompProfile

object

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

supplementalGroups

array (integer)

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.

supplementalGroupsPolicy

string

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.

sysctls

array

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.

sysctls[]

object

Sysctl defines a kernel parameter to be set

windowsOptions

object

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.

9.1.387. .spec.securityContext.appArmorProfile

Description
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.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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".

type

string

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.

9.1.388. .spec.securityContext.seLinuxOptions

Description
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
Type
object
Expand
PropertyTypeDescription

level

string

Level is SELinux level label that applies to the container.

role

string

Role is a SELinux role label that applies to the container.

type

string

Type is a SELinux type label that applies to the container.

user

string

User is a SELinux user label that applies to the container.

9.1.389. .spec.securityContext.seccompProfile

Description
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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.

type

string

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.

9.1.390. .spec.securityContext.sysctls

Description
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
Type
array

9.1.391. .spec.securityContext.sysctls[]

Description
Sysctl defines a kernel parameter to be set
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

Name of a property to set

value

string

Value of a property to set

9.1.392. .spec.securityContext.windowsOptions

Description
The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
Expand
PropertyTypeDescription

gmsaCredentialSpec

string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcess

boolean

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.

runAsUserName

string

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.

9.1.393. .spec.serviceMonitorNamespaceSelector

Description
serviceMonitorNamespaceSelector defines the namespaces to match for ServicedMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.396. .spec.serviceMonitorSelector

Description

serviceMonitorSelector defines the serviceMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.

If spec.serviceMonitorSelector, spec.podMonitorSelector, spec.probeSelector and spec.scrapeConfigSelector are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration’s Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the prometheus.yaml.gz key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use spec.additionalScrapeConfigs instead.

Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.399. .spec.shardRetentionPolicy

Description

shardRetentionPolicy defines the retention policy for the Prometheus shards. (Alpha) Using this field requires the 'PrometheusShardRetentionPolicy' feature gate to be enabled.

The final goals for this feature can be seen at https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/proposals/202310-shard-autoscaling.md#graceful-scale-down-of-prometheus-servers, however, the feature is not yet fully implemented in this PR. The limitation being: * Retention duration is not settable, for now, shards are retained forever.

Type
object
Expand
PropertyTypeDescription

retain

object

retain defines the config for retention when the retention policy is set to Retain. This field is ineffective as of now.

whenScaled

string

whenScaled defines the retention policy when the Prometheus shards are scaled down. * Delete, the operator will delete the pods from the scaled-down shard(s). * Retain, the operator will keep the pods from the scaled-down shard(s), so the data can still be queried.

If not defined, the operator assumes the Delete value.

9.1.400. .spec.shardRetentionPolicy.retain

Description
retain defines the config for retention when the retention policy is set to Retain. This field is ineffective as of now.
Type
object
Required
  • retentionPeriod
Expand
PropertyTypeDescription

retentionPeriod

string

retentionPeriod defines the retentionPeriod for shard retention policy.

9.1.401. .spec.storage

Description
storage defines the storage used by Prometheus.
Type
object
Expand
PropertyTypeDescription

disableMountSubPath

boolean

disableMountSubPath deprecated: subPath usage will be removed in a future release.

emptyDir

object

emptyDir 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

ephemeral

object

ephemeral 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

volumeClaimTemplate

object

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.

9.1.402. .spec.storage.emptyDir

Description
emptyDir 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
Type
object
Expand
PropertyTypeDescription

medium

string

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

sizeLimit

integer-or-string

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

9.1.403. .spec.storage.ephemeral

Description
ephemeral 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
Type
object
Expand
PropertyTypeDescription

volumeClaimTemplate

object

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.

Description

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Type
object
Required
  • spec
Expand
PropertyTypeDescription

metadata

object

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.

spec

object

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.

Description
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
Type
object
Description
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

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.

dataSourceRef

object

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.

resources

object

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

selector

object

selector is a label query over volumes to consider for binding.

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

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 or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

namespace

string

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.

Description
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
Type
object
Expand
PropertyTypeDescription

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

Description
selector is a label query over volumes to consider for binding.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.413. .spec.storage.volumeClaimTemplate

Description
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.
Type
object
Expand
PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

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

metadata

object

metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.

spec

object

spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

status

object

status is deprecated: this field is never set.

Description
metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
Type
object
Expand
PropertyTypeDescription

annotations

object (string)

annotations defines 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

labels

object (string)

labels define the 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

name

string

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

9.1.415. .spec.storage.volumeClaimTemplate.spec

Description
spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

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.

dataSourceRef

object

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.

resources

object

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

selector

object

selector is a label query over volumes to consider for binding.

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

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 or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

namespace

string

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.

Description
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
Type
object
Expand
PropertyTypeDescription

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

Description
selector is a label query over volumes to consider for binding.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.422. .spec.storage.volumeClaimTemplate.status

Description
status is deprecated: this field is never set.
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

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

allocatedResourceStatuses

object (string)

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.

allocatedResources

integer-or-string

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.

capacity

integer-or-string

capacity represents the actual resources of the underlying volume.

conditions

array

conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.

conditions[]

object

PersistentVolumeClaimCondition contains details about state of pvc

currentVolumeAttributesClassName

string

currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim

modifyVolumeStatus

object

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.

phase

string

phase represents the current phase of PersistentVolumeClaim.

Description
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
Type
array
Description
PersistentVolumeClaimCondition contains details about state of pvc
Type
object
Required
  • status
  • type
Expand
PropertyTypeDescription

lastProbeTime

string

lastProbeTime is the time we probed the condition.

lastTransitionTime

string

lastTransitionTime is the time the condition transitioned from one status to another.

message

string

message is the human-readable message indicating details about last transition.

reason

string

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.

status

string

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

type

string

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

Description
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.
Type
object
Required
  • status
Expand
PropertyTypeDescription

status

string

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.

targetVolumeAttributesClassName

string

targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled

9.1.426. .spec.thanos

Description
thanos defines the configuration of the optional Thanos sidecar.
Type
object
Expand
PropertyTypeDescription

additionalArgs

array

additionalArgs allows setting additional arguments for the Thanos container. The arguments are passed as-is to the Thanos container which may cause issues if they are invalid or not supported the given Thanos version. In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument, the reconciliation will fail and an error will be logged.

additionalArgs[]

object

Argument as part of the AdditionalArgs list.

baseImage

string

baseImage is deprecated: use 'image' instead.

blockSize

string

blockSize controls the size of TSDB blocks produced by Prometheus. The default value is 2h to match the upstream Prometheus defaults.

WARNING: Changing the block duration can impact the performance and efficiency of the entire Prometheus/Thanos stack due to how it interacts with memory and Thanos compactors. It is recommended to keep this value set to a multiple of 120 times your longest scrape or rule interval. For example, 30s * 120 = 1h.

getConfigInterval

string

getConfigInterval defines how often to retrieve the Prometheus configuration.

getConfigTimeout

string

getConfigTimeout defines the maximum time to wait when retrieving the Prometheus configuration.

grpcListenLocal

boolean

grpcListenLocal defines when true, the Thanos sidecar listens on the loopback interface instead of the Pod IP’s address for the gRPC endpoints.

It has no effect if listenLocal is true.

grpcServerTlsConfig

object

grpcServerTlsConfig defines the TLS parameters for the gRPC server providing the StoreAPI.

Note: Currently only the caFile, certFile, and keyFile fields are supported.

httpListenLocal

boolean

httpListenLocal when true, the Thanos sidecar listens on the loopback interface instead of the Pod IP’s address for the HTTP endpoints.

It has no effect if listenLocal is true.

image

string

image defines the container image name for Thanos. If specified, it takes precedence over the spec.thanos.baseImage, spec.thanos.tag and spec.thanos.sha fields.

Specifying spec.thanos.version is still necessary to ensure the Prometheus Operator knows which version of Thanos is being configured.

If neither spec.thanos.image nor spec.thanos.baseImage are defined, the operator will use the latest upstream version of Thanos available at the time when the operator was released.

listenLocal

boolean

listenLocal is deprecated: use grpcListenLocal and httpListenLocal instead.

logFormat

string

logFormat for the Thanos sidecar.

logLevel

string

logLevel for the Thanos sidecar.

minTime

string

minTime defines the start of time range limit served by the Thanos sidecar’s StoreAPI. The field’s value should be a constant time in RFC3339 format or a time duration relative to current time, such as -1d or 2h45m. Valid duration units are ms, s, m, h, d, w, y.

objectStorageConfig

object

objectStorageConfig defines the Thanos sidecar’s configuration to upload TSDB blocks to object storage.

More info: https://thanos.io/tip/thanos/storage.md/

objectStorageConfigFile takes precedence over this field.

objectStorageConfigFile

string

objectStorageConfigFile defines the Thanos sidecar’s configuration file to upload TSDB blocks to object storage.

More info: https://thanos.io/tip/thanos/storage.md/

This field takes precedence over objectStorageConfig.

readyTimeout

string

readyTimeout defines the maximum time that the Thanos sidecar will wait for Prometheus to start.

resources

object

resources defines the resources requests and limits of the Thanos sidecar.

sha

string

sha is deprecated: use 'image' instead. The image digest can be specified as part of the image name.

tag

string

tag is deprecated: use 'image' instead. The image’s tag can be specified as as part of the image name.

tracingConfig

object

tracingConfig defines the tracing configuration for the Thanos sidecar.

tracingConfigFile takes precedence over this field.

More info: https://thanos.io/tip/thanos/tracing.md/

This is an experimental feature, it may change in any upcoming release in a breaking way.

tracingConfigFile

string

tracingConfigFile defines the tracing configuration file for the Thanos sidecar.

This field takes precedence over tracingConfig.

More info: https://thanos.io/tip/thanos/tracing.md/

This is an experimental feature, it may change in any upcoming release in a breaking way.

version

string

version of Thanos being deployed. The operator uses this information to generate the Prometheus StatefulSet + configuration files.

If not specified, the operator assumes the latest upstream release of Thanos available at the time when the version of the operator was released.

volumeMounts

array

volumeMounts allows configuration of additional VolumeMounts for Thanos. VolumeMounts specified will be appended to other VolumeMounts in the 'thanos-sidecar' container.

volumeMounts[]

object

VolumeMount describes a mounting of a Volume within a container.

9.1.427. .spec.thanos.additionalArgs

Description
additionalArgs allows setting additional arguments for the Thanos container. The arguments are passed as-is to the Thanos container which may cause issues if they are invalid or not supported the given Thanos version. In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument, the reconciliation will fail and an error will be logged.
Type
array

9.1.428. .spec.thanos.additionalArgs[]

Description
Argument as part of the AdditionalArgs list.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name of the argument, e.g. "scrape.discovery-reload-interval".

value

string

value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)

9.1.429. .spec.thanos.grpcServerTlsConfig

Description

grpcServerTlsConfig defines the TLS parameters for the gRPC server providing the StoreAPI.

Note: Currently only the caFile, certFile, and keyFile fields are supported.

Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

caFile

string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

cert

object

cert defines the Client certificate to present when doing client-authentication.

certFile

string

certFile defines the path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keyFile

string

keyFile defines the path to the client key file in the Prometheus container for the targets.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

9.1.430. .spec.thanos.grpcServerTlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.433. .spec.thanos.grpcServerTlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.437. .spec.thanos.objectStorageConfig

Description

objectStorageConfig defines the Thanos sidecar’s configuration to upload TSDB blocks to object storage.

More info: https://thanos.io/tip/thanos/storage.md/

objectStorageConfigFile takes precedence over this field.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.438. .spec.thanos.resources

Description
resources defines the resources requests and limits of the Thanos sidecar.
Type
object
Expand
PropertyTypeDescription

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

9.1.439. .spec.thanos.resources.claims

Description

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Type
array

9.1.440. .spec.thanos.resources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

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.

request

string

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.

9.1.441. .spec.thanos.tracingConfig

Description

tracingConfig defines the tracing configuration for the Thanos sidecar.

tracingConfigFile takes precedence over this field.

More info: https://thanos.io/tip/thanos/tracing.md/

This is an experimental feature, it may change in any upcoming release in a breaking way.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.442. .spec.thanos.volumeMounts

Description
volumeMounts allows configuration of additional VolumeMounts for Thanos. VolumeMounts specified will be appended to other VolumeMounts in the 'thanos-sidecar' container.
Type
array

9.1.443. .spec.thanos.volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
  • mountPath
  • name
Expand
PropertyTypeDescription

mountPath

string

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation

string

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).

name

string

This must match the Name of a Volume.

readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly

string

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.

subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

subPathExpr

string

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.

9.1.444. .spec.tolerations

Description
tolerations defines the Pods' tolerations if specified.
Type
array

9.1.445. .spec.tolerations[]

Description
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
Type
object
Expand
PropertyTypeDescription

effect

string

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

key

string

Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

operator

string

Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

tolerationSeconds

integer

TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

value

string

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

9.1.446. .spec.topologySpreadConstraints

Description
topologySpreadConstraints defines the pod’s topology spread constraints if specified.
Type
array

9.1.447. .spec.topologySpreadConstraints[]

Description
Type
object
Required
  • maxSkew
  • topologyKey
  • whenUnsatisfiable
Expand
PropertyTypeDescription

additionalLabelSelectors

string

additionalLabelSelectors Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint.

labelSelector

object

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.

matchLabelKeys

array (string)

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).

maxSkew

integer

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.

minDomains

integer

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.

nodeAffinityPolicy

string

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.

nodeTaintsPolicy

string

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.

topologyKey

string

TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It’s a required field.

whenUnsatisfiable

string

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.

Description
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.451. .spec.tracingConfig

Description

tracingConfig defines tracing in Prometheus.

This is an experimental feature, it may change in any upcoming release in a breaking way.

Type
object
Required
  • endpoint
Expand
PropertyTypeDescription

clientType

string

clientType defines the client used to export the traces. Supported values are http or grpc.

compression

string

compression key for supported compression types. The only supported value is gzip.

endpoint

string

endpoint to send the traces to. Should be provided in format <host>:<port>.

headers

object (string)

headers defines the key-value pairs to be used as headers associated with gRPC or HTTP requests.

insecure

boolean

insecure if disabled, the client will use a secure connection.

samplingFraction

integer-or-string

samplingFraction defines the probability a given trace will be sampled. Must be a float from 0 through 1.

timeout

string

timeout defines the maximum time the exporter will wait for each batch export.

tlsConfig

object

tlsConfig to use when sending traces.

9.1.452. .spec.tracingConfig.tlsConfig

Description
tlsConfig to use when sending traces.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

caFile

string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

cert

object

cert defines the Client certificate to present when doing client-authentication.

certFile

string

certFile defines the path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keyFile

string

keyFile defines the path to the client key file in the Prometheus container for the targets.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

9.1.453. .spec.tracingConfig.tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.455. .spec.tracingConfig.tlsConfig.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.456. .spec.tracingConfig.tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.458. .spec.tracingConfig.tlsConfig.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.459. .spec.tracingConfig.tlsConfig.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.460. .spec.tsdb

Description
tsdb defines the runtime reloadable configuration of the timeseries database(TSDB). It requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.
Type
object
Expand
PropertyTypeDescription

outOfOrderTimeWindow

string

outOfOrderTimeWindow defines how old an out-of-order/out-of-bounds sample can be with respect to the TSDB max time.

An out-of-order/out-of-bounds sample is ingested into the TSDB as long as the timestamp of the sample is >= (TSDB.MaxTime - outOfOrderTimeWindow).

This is an experimental feature, it may change in any upcoming release in a breaking way.

It requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.

9.1.461. .spec.volumeMounts

Description

volumeMounts allows the configuration of additional VolumeMounts.

VolumeMounts will be appended to other VolumeMounts in the 'prometheus' container, that are generated as a result of StorageSpec objects.

Type
array

9.1.462. .spec.volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
  • mountPath
  • name
Expand
PropertyTypeDescription

mountPath

string

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation

string

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).

name

string

This must match the Name of a Volume.

readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly

string

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.

subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

subPathExpr

string

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.

9.1.463. .spec.volumes

Description
volumes allows the 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.
Type
array

9.1.464. .spec.volumes[]

Description
Volume represents a named volume in a pod that may be accessed by any container in the pod.
Type
object
Required
  • name
Expand
PropertyTypeDescription

awsElasticBlockStore

object

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

azureDisk

object

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.

azureFile

object

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.

cephfs

object

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.

cinder

object

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

configMap

object

configMap represents a configMap that should populate this volume

csi

object

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.

downwardAPI

object

downwardAPI represents downward API about the pod that should populate this volume

emptyDir

object

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

ephemeral

object

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.

fc

object

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

flexVolume

object

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.

flocker

object

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.

gcePersistentDisk

object

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

gitRepo

object

gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.

glusterfs

object

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.

hostPath

object

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

image

object

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) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.

iscsi

object

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi

name

string

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

nfs

object

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

persistentVolumeClaim

object

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

photonPersistentDisk

object

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.

portworxVolume

object

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.

projected

object

projected items for all in one resources secrets, configmaps, and downward API

quobyte

object

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.

rbd

object

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.

scaleIO

object

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.

secret

object

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

storageos

object

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.

vsphereVolume

object

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.

9.1.465. .spec.volumes[].awsElasticBlockStore

Description
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. 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
Type
object
Required
  • volumeID
Expand
PropertyTypeDescription

fsType

string

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

partition

integer

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).

readOnly

boolean

readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

string

volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

9.1.466. .spec.volumes[].azureDisk

Description
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.
Type
object
Required
  • diskName
  • diskURI
Expand
PropertyTypeDescription

cachingMode

string

cachingMode is the Host Caching mode: None, Read Only, Read Write.

diskName

string

diskName is the Name of the data disk in the blob storage

diskURI

string

diskURI is the URI of data disk in the blob storage

fsType

string

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.

kind

string

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

readOnly

boolean

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

9.1.467. .spec.volumes[].azureFile

Description
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.
Type
object
Required
  • secretName
  • shareName
Expand
PropertyTypeDescription

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretName

string

secretName is the name of secret that contains Azure Storage Account Name and Key

shareName

string

shareName is the azure share Name

9.1.468. .spec.volumes[].cephfs

Description
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.
Type
object
Required
  • monitors
Expand
PropertyTypeDescription

monitors

array (string)

monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

string

path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /

readOnly

boolean

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

secretFile

string

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

secretRef

object

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

user

string

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

9.1.469. .spec.volumes[].cephfs.secretRef

Description
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
Type
object
Expand
PropertyTypeDescription

name

string

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

9.1.470. .spec.volumes[].cinder

Description
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
Type
object
Required
  • volumeID
Expand
PropertyTypeDescription

fsType

string

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

readOnly

boolean

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

secretRef

object

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

volumeID

string

volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

9.1.471. .spec.volumes[].cinder.secretRef

Description
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
Type
object
Expand
PropertyTypeDescription

name

string

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

9.1.472. .spec.volumes[].configMap

Description
configMap represents a configMap that should populate this volume
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

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.

items

array

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 '..'.

items[]

object

Maps a string key to a path within a volume.

name

string

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

optional

boolean

optional specify whether the ConfigMap or its keys must be defined

9.1.473. .spec.volumes[].configMap.items

Description
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 '..'.
Type
array

9.1.474. .spec.volumes[].configMap.items[]

Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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 '..'.

9.1.475. .spec.volumes[].csi

Description
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
Type
object
Required
  • driver
Expand
PropertyTypeDescription

driver

string

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.

fsType

string

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.

nodePublishSecretRef

object

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.

readOnly

boolean

readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

volumeAttributes

object (string)

volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.

9.1.476. .spec.volumes[].csi.nodePublishSecretRef

Description
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
Type
object
Expand
PropertyTypeDescription

name

string

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

9.1.477. .spec.volumes[].downwardAPI

Description
downwardAPI represents downward API about the pod that should populate this volume
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

items

array

Items is a list of downward API volume file

items[]

object

DownwardAPIVolumeFile represents information to create the file containing the pod field

9.1.478. .spec.volumes[].downwardAPI.items

Description
Items is a list of downward API volume file
Type
array

9.1.479. .spec.volumes[].downwardAPI.items[]

Description
DownwardAPIVolumeFile represents information to create the file containing the pod field
Type
object
Required
  • path
Expand
PropertyTypeDescription

fieldRef

object

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

mode

integer

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.

path

string

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 '..'

resourceFieldRef

object

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Description
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
Type
object
Required
  • fieldPath
Expand
PropertyTypeDescription

apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPath

string

Path of the field to select in the specified API version.

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
Type
object
Required
  • resource
Expand
PropertyTypeDescription

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

Specifies the output format of the exposed resources, defaults to "1"

resource

string

Required: resource to select

9.1.482. .spec.volumes[].emptyDir

Description
emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
Type
object
Expand
PropertyTypeDescription

medium

string

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

sizeLimit

integer-or-string

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

9.1.483. .spec.volumes[].ephemeral

Description

ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Type
object
Expand
PropertyTypeDescription

volumeClaimTemplate

object

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.

Description

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Type
object
Required
  • spec
Expand
PropertyTypeDescription

metadata

object

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.

spec

object

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.

Description
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
Type
object
Description
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

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.

dataSourceRef

object

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.

resources

object

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

selector

object

selector is a label query over volumes to consider for binding.

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

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 or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

namespace

string

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.

Description
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
Type
object
Expand
PropertyTypeDescription

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

Description
selector is a label query over volumes to consider for binding.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

9.1.493. .spec.volumes[].fc

Description
fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
Type
object
Expand
PropertyTypeDescription

fsType

string

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.

lun

integer

lun is Optional: FC target lun number

readOnly

boolean

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

targetWWNs

array (string)

targetWWNs is Optional: FC target worldwide names (WWNs)

wwids

array (string)

wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

9.1.494. .spec.volumes[].flexVolume

Description
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
Type
object
Required
  • driver
Expand
PropertyTypeDescription

driver

string

driver is the name of the driver to use for this volume.

fsType

string

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.

options

object (string)

options is Optional: this field holds extra command options if any.

readOnly

boolean

readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretRef

object

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.

9.1.495. .spec.volumes[].flexVolume.secretRef

Description
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.
Type
object
Expand
PropertyTypeDescription

name

string

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

9.1.496. .spec.volumes[].flocker

Description
flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
Type
object
Expand
PropertyTypeDescription

datasetName

string

datasetName is Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

datasetUUID

string

datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

9.1.497. .spec.volumes[].gcePersistentDisk

Description
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. 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
Type
object
Required
  • pdName
Expand
PropertyTypeDescription

fsType

string

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

partition

integer

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

pdName

string

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

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

9.1.498. .spec.volumes[].gitRepo

Description
gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.
Type
object
Required
  • repository
Expand
PropertyTypeDescription

directory

string

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.

repository

string

repository is the URL

revision

string

revision is the commit hash for the specified revision.

9.1.499. .spec.volumes[].glusterfs

Description
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.
Type
object
Required
  • endpoints
  • path
Expand
PropertyTypeDescription

endpoints

string

endpoints is the endpoint name that details Glusterfs topology.

path

string

path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

boolean

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

9.1.500. .spec.volumes[].hostPath

Description
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
Type
object
Required
  • path
Expand
PropertyTypeDescription

path

string

path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

9.1.501. .spec.volumes[].image

Description

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) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.

Type
object
Expand
PropertyTypeDescription

pullPolicy

string

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.

reference

string

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.

9.1.502. .spec.volumes[].iscsi

Description
iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi
Type
object
Required
  • iqn
  • lun
  • targetPortal
Expand
PropertyTypeDescription

chapAuthDiscovery

boolean

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

chapAuthSession

boolean

chapAuthSession defines whether support iSCSI Session CHAP authentication

fsType

string

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

initiatorName

string

initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.

iqn

string

iqn is the target iSCSI Qualified Name.

iscsiInterface

string

iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).

lun

integer

lun represents iSCSI Target Lun number.

portals

array (string)

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).

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

secretRef

object

secretRef is the CHAP Secret for iSCSI target and initiator authentication

targetPortal

string

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).

9.1.503. .spec.volumes[].iscsi.secretRef

Description
secretRef is the CHAP Secret for iSCSI target and initiator authentication
Type
object
Expand
PropertyTypeDescription

name

string

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

9.1.504. .spec.volumes[].nfs

Description
nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
Type
object
Required
  • path
  • server
Expand
PropertyTypeDescription

path

string

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

boolean

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

string

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

9.1.505. .spec.volumes[].persistentVolumeClaim

Description
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
Type
object
Required
  • claimName
Expand
PropertyTypeDescription

claimName

string

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

readOnly

boolean

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

9.1.506. .spec.volumes[].photonPersistentDisk

Description
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.
Type
object
Required
  • pdID
Expand
PropertyTypeDescription

fsType

string

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.

pdID

string

pdID is the ID that identifies Photon Controller persistent disk

9.1.507. .spec.volumes[].portworxVolume

Description
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.
Type
object
Required
  • volumeID
Expand
PropertyTypeDescription

fsType

string

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.

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

volumeID

string

volumeID uniquely identifies a Portworx volume

9.1.508. .spec.volumes[].projected

Description
projected items for all in one resources secrets, configmaps, and downward API
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

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.

sources

array

sources is the list of volume projections. Each entry in this list handles one source.

sources[]

object

Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.

9.1.509. .spec.volumes[].projected.sources

Description
sources is the list of volume projections. Each entry in this list handles one source.
Type
array

9.1.510. .spec.volumes[].projected.sources[]

Description
Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
Type
object
Expand
PropertyTypeDescription

clusterTrustBundle

object

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.

configMap

object

configMap information about the configMap data to project

downwardAPI

object

downwardAPI information about the downwardAPI data to project

podCertificate

object

Projects an auto-rotating credential bundle (private key and certificate chain) that the pod can use either as a TLS client or server.

Kubelet generates a private key and uses it to send a PodCertificateRequest to the named signer. Once the signer approves the request and issues a certificate chain, Kubelet writes the key and certificate chain to the pod filesystem. The pod does not start until certificates have been issued for each podCertificate projected volume source in its spec.

Kubelet will begin trying to rotate the certificate at the time indicated by the signer using the PodCertificateRequest.Status.BeginRefreshAt timestamp.

Kubelet can write a single file, indicated by the credentialBundlePath field, or separate files, indicated by the keyPath and certificateChainPath fields.

The credential bundle is a single file in PEM format. The first PEM entry is the private key (in PKCS#8 format), and the remaining PEM entries are the certificate chain issued by the signer (typically, signers will return their certificate chain in leaf-to-root order).

Prefer using the credential bundle format, since your application code can read it atomically. If you use keyPath and certificateChainPath, your application must make two separate file reads. If these coincide with a certificate rotation, it is possible that the private key and leaf certificate you read may not correspond to each other. Your application will need to check for this condition, and re-read until they are consistent.

The named signer controls chooses the format of the certificate it issues; consult the signer implementation’s documentation to learn how to use the certificates it issues.

secret

object

secret information about the secret data to project

serviceAccountToken

object

serviceAccountToken is information about the serviceAccountToken data to project

Description

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.

Type
object
Required
  • path
Expand
PropertyTypeDescription

labelSelector

object

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".

name

string

Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.

optional

boolean

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.

path

string

Relative path from the volume root to write the bundle.

signerName

string

Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

Description
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".
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
configMap information about the configMap data to project
Type
object
Expand
PropertyTypeDescription

items

array

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 '..'.

items[]

object

Maps a string key to a path within a volume.

name

string

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

optional

boolean

optional specify whether the ConfigMap or its keys must be defined

Description
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 '..'.
Type
array
Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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 '..'.

Description
downwardAPI information about the downwardAPI data to project
Type
object
Expand
PropertyTypeDescription

items

array

Items is a list of DownwardAPIVolume file

items[]

object

DownwardAPIVolumeFile represents information to create the file containing the pod field

Description
Items is a list of DownwardAPIVolume file
Type
array
Description
DownwardAPIVolumeFile represents information to create the file containing the pod field
Type
object
Required
  • path
Expand
PropertyTypeDescription

fieldRef

object

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

mode

integer

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.

path

string

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 '..'

resourceFieldRef

object

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Description
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
Type
object
Required
  • fieldPath
Expand
PropertyTypeDescription

apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPath

string

Path of the field to select in the specified API version.

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
Type
object
Required
  • resource
Expand
PropertyTypeDescription

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

Specifies the output format of the exposed resources, defaults to "1"

resource

string

Required: resource to select

Description

Projects an auto-rotating credential bundle (private key and certificate chain) that the pod can use either as a TLS client or server.

Kubelet generates a private key and uses it to send a PodCertificateRequest to the named signer. Once the signer approves the request and issues a certificate chain, Kubelet writes the key and certificate chain to the pod filesystem. The pod does not start until certificates have been issued for each podCertificate projected volume source in its spec.

Kubelet will begin trying to rotate the certificate at the time indicated by the signer using the PodCertificateRequest.Status.BeginRefreshAt timestamp.

Kubelet can write a single file, indicated by the credentialBundlePath field, or separate files, indicated by the keyPath and certificateChainPath fields.

The credential bundle is a single file in PEM format. The first PEM entry is the private key (in PKCS#8 format), and the remaining PEM entries are the certificate chain issued by the signer (typically, signers will return their certificate chain in leaf-to-root order).

Prefer using the credential bundle format, since your application code can read it atomically. If you use keyPath and certificateChainPath, your application must make two separate file reads. If these coincide with a certificate rotation, it is possible that the private key and leaf certificate you read may not correspond to each other. Your application will need to check for this condition, and re-read until they are consistent.

The named signer controls chooses the format of the certificate it issues; consult the signer implementation’s documentation to learn how to use the certificates it issues.

Type
object
Required
  • keyType
  • signerName
Expand
PropertyTypeDescription

certificateChainPath

string

Write the certificate chain at this path in the projected volume.

Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.

credentialBundlePath

string

Write the credential bundle at this path in the projected volume.

The credential bundle is a single file that contains multiple PEM blocks. The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private key.

The remaining blocks are CERTIFICATE blocks, containing the issued certificate chain from the signer (leaf and any intermediates).

Using credentialBundlePath lets your Pod’s application code make a single atomic read that retrieves a consistent key and certificate chain. If you project them to separate files, your application code will need to additionally check that the leaf certificate was issued to the key.

keyPath

string

Write the key at this path in the projected volume.

Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.

keyType

string

The type of keypair Kubelet will generate for the pod.

Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521", and "ED25519".

maxExpirationSeconds

integer

maxExpirationSeconds is the maximum lifetime permitted for the certificate.

Kubelet copies this value verbatim into the PodCertificateRequests it generates for this projection.

If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver will reject values shorter than 3600 (1 hour). The maximum allowable value is 7862400 (91 days).

The signer implementation is then free to issue a certificate with any lifetime shorter than MaxExpirationSeconds, but no shorter than 3600 seconds (1 hour). This constraint is enforced by kube-apiserver. kubernetes.io signers will never issue certificates with a lifetime longer than 24 hours.

signerName

string

Kubelet’s generated CSRs will be addressed to this signer.

Description
secret information about the secret data to project
Type
object
Expand
PropertyTypeDescription

items

array

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 '..'.

items[]

object

Maps a string key to a path within a volume.

name

string

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

optional

boolean

optional field specify whether the Secret or its key must be defined

Description
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 '..'.
Type
array
Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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 '..'.

Description
serviceAccountToken is information about the serviceAccountToken data to project
Type
object
Required
  • path
Expand
PropertyTypeDescription

audience

string

audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.

expirationSeconds

integer

expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

path

string

path is the path relative to the mount point of the file to project the token into.

9.1.528. .spec.volumes[].quobyte

Description
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.
Type
object
Required
  • registry
  • volume
Expand
PropertyTypeDescription

group

string

group to map volume access to Default is no group

readOnly

boolean

readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

registry

string

registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

tenant

string

tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

user

string

user to map volume access to Defaults to serivceaccount user

volume

string

volume is a string that references an already created Quobyte volume by name.

9.1.529. .spec.volumes[].rbd

Description
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.
Type
object
Required
  • image
  • monitors
Expand
PropertyTypeDescription

fsType

string

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

image

string

image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

string

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

monitors

array (string)

monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

string

pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

object

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

user

string

user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

9.1.530. .spec.volumes[].rbd.secretRef

Description
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
Type
object
Expand
PropertyTypeDescription

name

string

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

9.1.531. .spec.volumes[].scaleIO

Description
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.
Type
object
Required
  • gateway
  • secretRef
  • system
Expand
PropertyTypeDescription

fsType

string

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".

gateway

string

gateway is the host address of the ScaleIO API Gateway.

protectionDomain

string

protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

readOnly

boolean

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretRef

object

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

sslEnabled

boolean

sslEnabled Flag enable/disable SSL communication with Gateway, default false

storageMode

string

storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

storagePool

string

storagePool is the ScaleIO Storage Pool associated with the protection domain.

system

string

system is the name of the storage system as configured in ScaleIO.

volumeName

string

volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

9.1.532. .spec.volumes[].scaleIO.secretRef

Description
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
Type
object
Expand
PropertyTypeDescription

name

string

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

9.1.533. .spec.volumes[].secret

Description
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

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.

items

array

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 '..'.

items[]

object

Maps a string key to a path within a volume.

optional

boolean

optional field specify whether the Secret or its keys must be defined

secretName

string

secretName is the name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

9.1.534. .spec.volumes[].secret.items

Description
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 '..'.
Type
array

9.1.535. .spec.volumes[].secret.items[]

Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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 '..'.

9.1.536. .spec.volumes[].storageos

Description
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.
Type
object
Expand
PropertyTypeDescription

fsType

string

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.

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretRef

object

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

volumeName

string

volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

volumeNamespace

string

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.

9.1.537. .spec.volumes[].storageos.secretRef

Description
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
Type
object
Expand
PropertyTypeDescription

name

string

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

9.1.538. .spec.volumes[].vsphereVolume

Description
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.
Type
object
Required
  • volumePath
Expand
PropertyTypeDescription

fsType

string

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.

storagePolicyID

string

storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

storagePolicyName

string

storagePolicyName is the storage Policy Based Management (SPBM) profile name.

volumePath

string

volumePath is the path that identifies vSphere volume vmdk

9.1.539. .spec.web

Description
web defines the configuration of the Prometheus web server.
Type
object
Expand
PropertyTypeDescription

httpConfig

object

httpConfig defines HTTP parameters for web server.

maxConnections

integer

maxConnections defines the maximum number of simultaneous connections A zero value means that Prometheus doesn’t accept any incoming connection.

pageTitle

string

pageTitle defines the prometheus web page title.

tlsConfig

object

tlsConfig defines the TLS parameters for HTTPS.

9.1.540. .spec.web.httpConfig

Description
httpConfig defines HTTP parameters for web server.
Type
object
Expand
PropertyTypeDescription

headers

object

headers defines a list of headers that can be added to HTTP responses.

http2

boolean

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.

9.1.541. .spec.web.httpConfig.headers

Description
headers defines a list of headers that can be added to HTTP responses.
Type
object
Expand
PropertyTypeDescription

contentSecurityPolicy

string

contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank.

strictTransportSecurity

string

strictTransportSecurity defines 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

xContentTypeOptions

string

xContentTypeOptions defines 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

xFrameOptions

string

xFrameOptions defines 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

xXSSProtection

string

xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection

9.1.542. .spec.web.tlsConfig

Description
tlsConfig defines the TLS parameters for HTTPS.
Type
object
Expand
PropertyTypeDescription

cert

object

cert defines the Secret or ConfigMap containing the TLS certificate for the web server.

Either keySecret or keyFile must be defined.

It is mutually exclusive with certFile.

certFile

string

certFile defines the 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.

cipherSuites

array (string)

cipherSuites defines the 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

clientAuthType

string

clientAuthType defines the server policy for client TLS authentication.

For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType

clientCAFile

string

clientCAFile defines the path to the CA certificate file for client certificate authentication to the server.

It is mutually exclusive with client_ca.

client_ca

object

client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server.

It is mutually exclusive with clientCAFile.

curvePreferences

array (string)

curvePreferences defines 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

keyFile

string

keyFile defines the 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.

keySecret

object

keySecret defines the secret containing the TLS private key for the web server.

Either cert or certFile must be defined.

It is mutually exclusive with keyFile.

maxVersion

string

maxVersion defines the Maximum TLS version that is acceptable.

minVersion

string

minVersion defines the minimum TLS version that is acceptable.

preferServerCipherSuites

boolean

preferServerCipherSuites defines 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.

9.1.543. .spec.web.tlsConfig.cert

Description

cert defines the Secret or ConfigMap containing the TLS certificate for the web server.

Either keySecret or keyFile must be defined.

It is mutually exclusive with certFile.

Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

9.1.544. .spec.web.tlsConfig.cert.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.545. .spec.web.tlsConfig.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.546. .spec.web.tlsConfig.client_ca

Description

client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server.

It is mutually exclusive with clientCAFile.

Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

9.1.547. .spec.web.tlsConfig.client_ca.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

9.1.548. .spec.web.tlsConfig.client_ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.549. .spec.web.tlsConfig.keySecret

Description

keySecret defines the secret containing the TLS private key for the web server.

Either cert or certFile must be defined.

It is mutually exclusive with keyFile.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

9.1.550. .status

Description
status defines the most recent observed status of the Prometheus cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Type
object
Expand
PropertyTypeDescription

availableReplicas

integer

availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this Prometheus deployment.

conditions

array

conditions defines the current state of the Prometheus deployment.

conditions[]

object

Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource.

paused

boolean

paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed.

replicas

integer

replicas defines the total number of non-terminated pods targeted by this Prometheus deployment (their labels match the selector).

selector

string

selector used to match the pods targeted by this Prometheus resource.

shardStatuses

array

shardStatuses defines the list has one entry per shard. Each entry provides a summary of the shard status.

shardStatuses[]

object

 

shards

integer

shards defines the most recently observed number of shards.

unavailableReplicas

integer

unavailableReplicas defines the total number of unavailable pods targeted by this Prometheus deployment.

updatedReplicas

integer

updatedReplicas defines the total number of non-terminated pods targeted by this Prometheus deployment that have the desired version spec.

9.1.551. .status.conditions

Description
conditions defines the current state of the Prometheus deployment.
Type
array

9.1.552. .status.conditions[]

Description
Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource.
Type
object
Required
  • lastTransitionTime
  • status
  • type
Expand
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime is the time of the last update to the current status property.

message

string

message defines human-readable message indicating details for the condition’s last transition.

observedGeneration

integer

observedGeneration defines 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.

reason

string

reason for the condition’s last transition.

status

string

status of the condition.

type

string

type of the condition being reported.

9.1.553. .status.shardStatuses

Description
shardStatuses defines the list has one entry per shard. Each entry provides a summary of the shard status.
Type
array

9.1.554. .status.shardStatuses[]

Description
Type
object
Required
  • availableReplicas
  • replicas
  • shardID
  • unavailableReplicas
  • updatedReplicas
Expand
PropertyTypeDescription

availableReplicas

integer

availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this shard.

replicas

integer

replicas defines the total number of pods targeted by this shard.

shardID

string

shardID defines the identifier of the shard.

unavailableReplicas

integer

unavailableReplicas defines the Total number of unavailable pods targeted by this shard.

updatedReplicas

integer

updatedReplicas defines the total number of non-terminated pods targeted by this shard that have the desired spec.

9.2. API endpoints

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1/prometheuses

    • GET: list objects of kind Prometheus
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses

    • DELETE: delete collection of Prometheus
    • GET: list objects of kind Prometheus
    • POST: create Prometheus
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name}

    • DELETE: delete Prometheus
    • GET: read the specified Prometheus
    • PATCH: partially update the specified Prometheus
    • PUT: replace the specified Prometheus
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name}/scale

    • GET: read scale of the specified Prometheus
    • PATCH: partially update scale of the specified Prometheus
    • PUT: replace scale of the specified Prometheus
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name}/status

    • GET: read status of the specified Prometheus
    • PATCH: partially update status of the specified Prometheus
    • PUT: replace status of the specified Prometheus

9.2.1. /apis/monitoring.coreos.com/v1/prometheuses

HTTP method
GET
Description
list objects of kind Prometheus
Expand
Table 9.1. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusList schema

401 - Unauthorized

Empty

HTTP method
DELETE
Description
delete collection of Prometheus
Expand
Table 9.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind Prometheus
Expand
Table 9.3. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create Prometheus
Expand
Table 9.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 9.5. Body parameters
ParameterTypeDescription

body

Prometheus schema

 
Expand
Table 9.6. HTTP responses
HTTP codeReponse body

200 - OK

Prometheus schema

201 - Created

Prometheus schema

202 - Accepted

Prometheus schema

401 - Unauthorized

Empty

Expand
Table 9.7. Global path parameters
ParameterTypeDescription

name

string

name of the Prometheus

HTTP method
DELETE
Description
delete Prometheus
Expand
Table 9.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 9.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified Prometheus
Expand
Table 9.10. HTTP responses
HTTP codeReponse body

200 - OK

Prometheus schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified Prometheus
Expand
Table 9.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 9.12. HTTP responses
HTTP codeReponse body

200 - OK

Prometheus schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified Prometheus
Expand
Table 9.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 9.14. Body parameters
ParameterTypeDescription

body

Prometheus schema

 
Expand
Table 9.15. HTTP responses
HTTP codeReponse body

200 - OK

Prometheus schema

201 - Created

Prometheus schema

401 - Unauthorized

Empty

Expand
Table 9.16. Global path parameters
ParameterTypeDescription

name

string

name of the Prometheus

HTTP method
GET
Description
read scale of the specified Prometheus
Expand
Table 9.17. HTTP responses
HTTP codeReponse body

200 - OK

Scale schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update scale of the specified Prometheus
Expand
Table 9.18. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 9.19. HTTP responses
HTTP codeReponse body

200 - OK

Scale schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace scale of the specified Prometheus
Expand
Table 9.20. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 9.21. Body parameters
ParameterTypeDescription

body

Scale schema

 
Expand
Table 9.22. HTTP responses
HTTP codeReponse body

200 - OK

Scale schema

201 - Created

Scale schema

401 - Unauthorized

Empty

Expand
Table 9.23. Global path parameters
ParameterTypeDescription

name

string

name of the Prometheus

HTTP method
GET
Description
read status of the specified Prometheus
Expand
Table 9.24. HTTP responses
HTTP codeReponse body

200 - OK

Prometheus schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified Prometheus
Expand
Table 9.25. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 9.26. HTTP responses
HTTP codeReponse body

200 - OK

Prometheus schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified Prometheus
Expand
Table 9.27. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 9.28. Body parameters
ParameterTypeDescription

body

Prometheus schema

 
Expand
Table 9.29. HTTP responses
HTTP codeReponse body

200 - OK

Prometheus schema

201 - Created

Prometheus schema

401 - Unauthorized

Empty

Description

The PrometheusRule custom resource definition (CRD) defines [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) and [recording](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/) rules to be evaluated by Prometheus or ThanosRuler objects.

Prometheus and ThanosRuler objects select PrometheusRule objects using label and namespace selectors.

Type
object
Required
  • spec

10.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec defines the specification of desired alerting rule definitions for Prometheus.

status

object

status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.

Most recent observed status of the PrometheusRule. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

10.1.1. .spec

Description
spec defines the specification of desired alerting rule definitions for Prometheus.
Type
object
Expand
PropertyTypeDescription

groups

array

groups defines the content of Prometheus rule file

groups[]

object

RuleGroup is a list of sequentially evaluated recording and alerting rules.

10.1.2. .spec.groups

Description
groups defines the content of Prometheus rule file
Type
array

10.1.3. .spec.groups[]

Description
RuleGroup is a list of sequentially evaluated recording and alerting rules.
Type
object
Required
  • name
Expand
PropertyTypeDescription

interval

string

interval defines how often rules in the group are evaluated.

labels

object (string)

labels define the labels to add or overwrite before storing the result for its rules. The labels defined at the rule level take precedence.

It requires Prometheus >= 3.0.0. The field is ignored for Thanos Ruler.

limit

integer

limit defines the number of alerts an alerting rule and series a recording rule can produce. Limit is supported starting with Prometheus >= 2.31 and Thanos Ruler >= 0.24.

name

string

name defines the name of the rule group.

partial_response_strategy

string

partial_response_strategy is only used by ThanosRuler and will be ignored by Prometheus instances. More info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response

query_offset

string

query_offset defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past.

It requires Prometheus >= v2.53.0. It is not supported for ThanosRuler.

rules

array

rules defines the list of alerting and recording rules.

rules[]

object

Rule describes an alerting or recording rule See Prometheus documentation: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) or [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) rule

10.1.4. .spec.groups[].rules

Description
rules defines the list of alerting and recording rules.
Type
array

10.1.5. .spec.groups[].rules[]

Description
Rule describes an alerting or recording rule See Prometheus documentation: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) or [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) rule
Type
object
Required
  • expr
Expand
PropertyTypeDescription

alert

string

alert defines the name of the alert. Must be a valid label value. Only one of record and alert must be set.

annotations

object (string)

annotations defines annotations to add to each alert. Only valid for alerting rules.

expr

integer-or-string

expr defines the PromQL expression to evaluate.

for

string

for defines how alerts are considered firing once they have been returned for this long.

keep_firing_for

string

keep_firing_for defines how long an alert will continue firing after the condition that triggered it has cleared.

labels

object (string)

labels defines labels to add or overwrite.

record

string

record defines the name of the time series to output to. Must be a valid metric name. Only one of record and alert must be set.

10.1.6. .status

Description

status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.

Most recent observed status of the PrometheusRule. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Type
object
Expand
PropertyTypeDescription

bindings

array

bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.

bindings[]

object

WorkloadBinding is a link between a configuration resource and a workload resource.

10.1.7. .status.bindings

Description
bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
Type
array

10.1.8. .status.bindings[]

Description
WorkloadBinding is a link between a configuration resource and a workload resource.
Type
object
Required
  • group
  • name
  • namespace
  • resource
Expand
PropertyTypeDescription

conditions

array

conditions defines the current state of the configuration resource when bound to the referenced Workload object.

conditions[]

object

ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.

group

string

group defines the group of the referenced resource.

name

string

name defines the name of the referenced object.

namespace

string

namespace defines the namespace of the referenced object.

resource

string

resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).

10.1.9. .status.bindings[].conditions

Description
conditions defines the current state of the configuration resource when bound to the referenced Workload object.
Type
array

10.1.10. .status.bindings[].conditions[]

Description
ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
Type
object
Required
  • lastTransitionTime
  • status
  • type
Expand
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime defines the time of the last update to the current status property.

message

string

message defines the human-readable message indicating details for the condition’s last transition.

observedGeneration

integer

observedGeneration defines 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 object.

reason

string

reason for the condition’s last transition.

status

string

status of the condition.

type

string

type of the condition being reported. Currently, only "Accepted" is supported.

10.2. API endpoints

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1/prometheusrules

    • GET: list objects of kind PrometheusRule
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules

    • DELETE: delete collection of PrometheusRule
    • GET: list objects of kind PrometheusRule
    • POST: create a PrometheusRule
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules/{name}

    • DELETE: delete a PrometheusRule
    • GET: read the specified PrometheusRule
    • PATCH: partially update the specified PrometheusRule
    • PUT: replace the specified PrometheusRule
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules/{name}/status

    • GET: read status of the specified PrometheusRule
    • PATCH: partially update status of the specified PrometheusRule
    • PUT: replace status of the specified PrometheusRule
HTTP method
GET
Description
list objects of kind PrometheusRule
Expand
Table 10.1. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusRuleList schema

401 - Unauthorized

Empty

HTTP method
DELETE
Description
delete collection of PrometheusRule
Expand
Table 10.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind PrometheusRule
Expand
Table 10.3. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusRuleList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a PrometheusRule
Expand
Table 10.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 10.5. Body parameters
ParameterTypeDescription

body

PrometheusRule schema

 
Expand
Table 10.6. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusRule schema

201 - Created

PrometheusRule schema

202 - Accepted

PrometheusRule schema

401 - Unauthorized

Empty

Expand
Table 10.7. Global path parameters
ParameterTypeDescription

name

string

name of the PrometheusRule

HTTP method
DELETE
Description
delete a PrometheusRule
Expand
Table 10.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 10.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified PrometheusRule
Expand
Table 10.10. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusRule schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified PrometheusRule
Expand
Table 10.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 10.12. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusRule schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified PrometheusRule
Expand
Table 10.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 10.14. Body parameters
ParameterTypeDescription

body

PrometheusRule schema

 
Expand
Table 10.15. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusRule schema

201 - Created

PrometheusRule schema

401 - Unauthorized

Empty

Expand
Table 10.16. Global path parameters
ParameterTypeDescription

name

string

name of the PrometheusRule

HTTP method
GET
Description
read status of the specified PrometheusRule
Expand
Table 10.17. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusRule schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified PrometheusRule
Expand
Table 10.18. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 10.19. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusRule schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified PrometheusRule
Expand
Table 10.20. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 10.21. Body parameters
ParameterTypeDescription

body

PrometheusRule schema

 
Expand
Table 10.22. HTTP responses
HTTP codeReponse body

200 - OK

PrometheusRule schema

201 - Created

PrometheusRule schema

401 - Unauthorized

Empty

Description

The ServiceMonitor custom resource definition (CRD) defines how Prometheus and PrometheusAgent can scrape metrics from a group of services. Among other things, it allows to specify: * The services to scrape via label selectors. * The container ports to scrape. * Authentication credentials to use. * Target and metric relabeling.

Prometheus and PrometheusAgent objects select ServiceMonitor objects using label and namespace selectors.

Type
object
Required
  • spec

11.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec defines the specification of desired Service selection for target discovery by Prometheus.

status

object

status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.

Most recent observed status of the ServiceMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

11.1.1. .spec

Description
spec defines the specification of desired Service selection for target discovery by Prometheus.
Type
object
Required
  • endpoints
  • selector
Expand
PropertyTypeDescription

attachMetadata

object

attachMetadata defines additional metadata which is added to the discovered targets.

It requires Prometheus >= v2.37.0.

bodySizeLimit

string

bodySizeLimit when defined, bodySizeLimit specifies a job level limit on the size of uncompressed response body that will be accepted by Prometheus.

It requires Prometheus >= v2.28.0.

convertClassicHistogramsToNHCB

boolean

convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.

endpoints

array

endpoints defines the list of endpoints part of this ServiceMonitor. Defines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects. In most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels.

endpoints[]

object

Endpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.

fallbackScrapeProtocol

string

fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.

It requires Prometheus >= v3.0.0.

jobLabel

string

jobLabel selects the label from the associated Kubernetes Service object which will be used as the job label for all metrics.

For example if jobLabel is set to foo and the Kubernetes Service object is labeled with foo: bar, then Prometheus adds the job="bar" label to all ingested metrics.

If the value of this field is empty or if the label doesn’t exist for the given Service, the job label of the metrics defaults to the name of the associated Kubernetes Service.

keepDroppedTargets

integer

keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.

It requires Prometheus >= v2.47.0.

labelLimit

integer

labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample.

It requires Prometheus >= v2.27.0.

labelNameLengthLimit

integer

labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample.

It requires Prometheus >= v2.27.0.

labelValueLengthLimit

integer

labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample.

It requires Prometheus >= v2.27.0.

namespaceSelector

object

namespaceSelector defines in which namespace(s) Prometheus should discover the services. By default, the services are discovered in the same namespace as the ServiceMonitor object but it is possible to select pods across different/all namespaces.

nativeHistogramBucketLimit

integer

nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0.

nativeHistogramMinBucketFactor

integer-or-string

nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0.

podTargetLabels

array (string)

podTargetLabels defines the labels which are transferred from the associated Kubernetes Pod object onto the ingested metrics.

sampleLimit

integer

sampleLimit defines a per-scrape limit on the number of scraped samples that will be accepted.

scrapeClass

string

scrapeClass defines the scrape class to apply.

scrapeClassicHistograms

boolean

scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.

Notice: scrapeClassicHistograms corresponds to the always_scrape_classic_histograms field in the Prometheus configuration.

scrapeProtocols

array (string)

scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred).

If unset, Prometheus uses its default value.

It requires Prometheus >= v2.49.0.

selector

object

selector defines the label selector to select the Kubernetes Endpoints objects to scrape metrics from.

selectorMechanism

string

selectorMechanism defines the mechanism used to select the endpoints to scrape. By default, the selection process relies on relabel configurations to filter the discovered targets. Alternatively, you can opt in for role selectors, which may offer better efficiency in large clusters. Which strategy is best for your use case needs to be carefully evaluated.

It requires Prometheus >= v2.17.0.

serviceDiscoveryRole

string

serviceDiscoveryRole defines the service discovery role used to discover targets.

If set, the value should be either "Endpoints" or "EndpointSlice". Otherwise it defaults to the value defined in the Prometheus/PrometheusAgent resource.

targetLabels

array (string)

targetLabels defines the labels which are transferred from the associated Kubernetes Service object onto the ingested metrics.

targetLimit

integer

targetLimit defines a limit on the number of scraped targets that will be accepted.

11.1.2. .spec.attachMetadata

Description

attachMetadata defines additional metadata which is added to the discovered targets.

It requires Prometheus >= v2.37.0.

Type
object
Expand
PropertyTypeDescription

node

boolean

node when set to true, Prometheus attaches node metadata to the discovered targets.

The Prometheus service account must have the list and watch permissions on the Nodes objects.

11.1.3. .spec.endpoints

Description
endpoints defines the list of endpoints part of this ServiceMonitor. Defines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects. In most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels.
Type
array

11.1.4. .spec.endpoints[]

Description
Endpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.
Type
object
Expand
PropertyTypeDescription

authorization

object

authorization configures the Authorization header credentials to use when scraping the target.

Cannot be set at the same time as basicAuth, or oauth2.

basicAuth

object

basicAuth defines the Basic Authentication credentials to use when scraping the target.

Cannot be set at the same time as authorization, or oauth2.

bearerTokenFile

string

bearerTokenFile defines the file to read bearer token for scraping the target.

Deprecated: use authorization instead.

bearerTokenSecret

object

bearerTokenSecret defines a key of a Secret containing the bearer token for scraping targets. The secret needs to be in the same namespace as the ServiceMonitor object and readable by the Prometheus Operator.

Deprecated: use authorization instead.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2 when scraping the target.

filterRunning

boolean

filterRunning when true, the pods which are not running (e.g. either in Failed or Succeeded state) are dropped during the target discovery.

If unset, the filtering is enabled.

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase

followRedirects

boolean

followRedirects defines whether the scrape requests should follow HTTP 3xx redirects.

honorLabels

boolean

honorLabels defines when true the metric’s labels when they collide with the target’s labels.

honorTimestamps

boolean

honorTimestamps defines whether Prometheus preserves the timestamps when exposed by the target.

interval

string

interval at which Prometheus scrapes the metrics from the target.

If empty, Prometheus uses the global scrape interval.

metricRelabelings

array

metricRelabelings defines the relabeling rules to apply to the samples before ingestion.

metricRelabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 defines the OAuth2 settings to use when scraping the target.

It requires Prometheus >= 2.27.0.

Cannot be set at the same time as authorization, or basicAuth.

params

object

params define optional HTTP URL parameters.

params{}

array (string)

 

path

string

path defines the HTTP path from which to scrape for metrics.

If empty, Prometheus uses the default value (e.g. /metrics).

port

string

port defines the name of the Service port which this endpoint refers to.

It takes precedence over targetPort.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

relabelings

array

relabelings defines the relabeling rules to apply the target’s metadata labels.

The Operator automatically adds relabelings for a few standard Kubernetes fields.

The original scrape job’s name is available via the \__tmp_prometheus_job_name label.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

scheme

string

scheme defines the HTTP scheme to use when scraping the metrics.

scrapeTimeout

string

scrapeTimeout defines the timeout after which Prometheus considers the scrape to be failed.

If empty, Prometheus uses the global scrape timeout unless it is less than the target’s scrape interval value in which the latter is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.

targetPort

integer-or-string

targetPort defines the name or number of the target port of the Pod object behind the Service. The port must be specified with the container’s port property.

tlsConfig

object

tlsConfig defines the TLS configuration to use when scraping the target.

trackTimestampsStaleness

boolean

trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if honorTimestamps is false.

It requires Prometheus >= v2.48.0.

11.1.5. .spec.endpoints[].authorization

Description

authorization configures the Authorization header credentials to use when scraping the target.

Cannot be set at the same time as basicAuth, or oauth2.

Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

type

string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.7. .spec.endpoints[].basicAuth

Description

basicAuth defines the Basic Authentication credentials to use when scraping the target.

Cannot be set at the same time as authorization, or oauth2.

Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

11.1.8. .spec.endpoints[].basicAuth.password

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.9. .spec.endpoints[].basicAuth.username

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.10. .spec.endpoints[].bearerTokenSecret

Description

bearerTokenSecret defines a key of a Secret containing the bearer token for scraping targets. The secret needs to be in the same namespace as the ServiceMonitor object and readable by the Prometheus Operator.

Deprecated: use authorization instead.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.11. .spec.endpoints[].metricRelabelings

Description
metricRelabelings defines the relabeling rules to apply to the samples before ingestion.
Type
array

11.1.12. .spec.endpoints[].metricRelabelings[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

11.1.13. .spec.endpoints[].oauth2

Description

oauth2 defines the OAuth2 settings to use when scraping the target.

It requires Prometheus >= 2.27.0.

Cannot be set at the same time as authorization, or basicAuth.

Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

endpointParams configures the HTTP parameters to append to the token URL.

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

11.1.14. .spec.endpoints[].oauth2.clientId

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

11.1.16. .spec.endpoints[].oauth2.clientId.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.17. .spec.endpoints[].oauth2.clientSecret

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.21. .spec.endpoints[].oauth2.tlsConfig

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

11.1.22. .spec.endpoints[].oauth2.tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.25. .spec.endpoints[].oauth2.tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.29. .spec.endpoints[].params

Description
params define optional HTTP URL parameters.
Type
object

11.1.30. .spec.endpoints[].proxyConnectHeader

Description

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.

Type
object

11.1.31. .spec.endpoints[].proxyConnectHeader{}

Description
Type
array

11.1.32. .spec.endpoints[].proxyConnectHeader{}[]

Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.33. .spec.endpoints[].relabelings

Description

relabelings defines the relabeling rules to apply the target’s metadata labels.

The Operator automatically adds relabelings for a few standard Kubernetes fields.

The original scrape job’s name is available via the \__tmp_prometheus_job_name label.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
array

11.1.34. .spec.endpoints[].relabelings[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

11.1.35. .spec.endpoints[].tlsConfig

Description
tlsConfig defines the TLS configuration to use when scraping the target.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

caFile

string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

cert

object

cert defines the Client certificate to present when doing client-authentication.

certFile

string

certFile defines the path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keyFile

string

keyFile defines the path to the client key file in the Prometheus container for the targets.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

11.1.36. .spec.endpoints[].tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

11.1.37. .spec.endpoints[].tlsConfig.ca.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

11.1.38. .spec.endpoints[].tlsConfig.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.39. .spec.endpoints[].tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

11.1.41. .spec.endpoints[].tlsConfig.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.42. .spec.endpoints[].tlsConfig.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

11.1.43. .spec.namespaceSelector

Description
namespaceSelector defines in which namespace(s) Prometheus should discover the services. By default, the services are discovered in the same namespace as the ServiceMonitor object but it is possible to select pods across different/all namespaces.
Type
object
Expand
PropertyTypeDescription

any

boolean

any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them.

matchNames

array (string)

matchNames defines the list of namespace names to select from.

11.1.44. .spec.selector

Description
selector defines the label selector to select the Kubernetes Endpoints objects to scrape metrics from.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

11.1.45. .spec.selector.matchExpressions

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array

11.1.46. .spec.selector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

11.1.47. .status

Description

status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.

Most recent observed status of the ServiceMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Type
object
Expand
PropertyTypeDescription

bindings

array

bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.

bindings[]

object

WorkloadBinding is a link between a configuration resource and a workload resource.

11.1.48. .status.bindings

Description
bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
Type
array

11.1.49. .status.bindings[]

Description
WorkloadBinding is a link between a configuration resource and a workload resource.
Type
object
Required
  • group
  • name
  • namespace
  • resource
Expand
PropertyTypeDescription

conditions

array

conditions defines the current state of the configuration resource when bound to the referenced Workload object.

conditions[]

object

ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.

group

string

group defines the group of the referenced resource.

name

string

name defines the name of the referenced object.

namespace

string

namespace defines the namespace of the referenced object.

resource

string

resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).

11.1.50. .status.bindings[].conditions

Description
conditions defines the current state of the configuration resource when bound to the referenced Workload object.
Type
array

11.1.51. .status.bindings[].conditions[]

Description
ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
Type
object
Required
  • lastTransitionTime
  • status
  • type
Expand
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime defines the time of the last update to the current status property.

message

string

message defines the human-readable message indicating details for the condition’s last transition.

observedGeneration

integer

observedGeneration defines 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 object.

reason

string

reason for the condition’s last transition.

status

string

status of the condition.

type

string

type of the condition being reported. Currently, only "Accepted" is supported.

11.2. API endpoints

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1/servicemonitors

    • GET: list objects of kind ServiceMonitor
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors

    • DELETE: delete collection of ServiceMonitor
    • GET: list objects of kind ServiceMonitor
    • POST: create a ServiceMonitor
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors/{name}

    • DELETE: delete a ServiceMonitor
    • GET: read the specified ServiceMonitor
    • PATCH: partially update the specified ServiceMonitor
    • PUT: replace the specified ServiceMonitor
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors/{name}/status

    • GET: read status of the specified ServiceMonitor
    • PATCH: partially update status of the specified ServiceMonitor
    • PUT: replace status of the specified ServiceMonitor
HTTP method
GET
Description
list objects of kind ServiceMonitor
Expand
Table 11.1. HTTP responses
HTTP codeReponse body

200 - OK

ServiceMonitorList schema

401 - Unauthorized

Empty

HTTP method
DELETE
Description
delete collection of ServiceMonitor
Expand
Table 11.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind ServiceMonitor
Expand
Table 11.3. HTTP responses
HTTP codeReponse body

200 - OK

ServiceMonitorList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a ServiceMonitor
Expand
Table 11.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 11.5. Body parameters
ParameterTypeDescription

body

ServiceMonitor schema

 
Expand
Table 11.6. HTTP responses
HTTP codeReponse body

200 - OK

ServiceMonitor schema

201 - Created

ServiceMonitor schema

202 - Accepted

ServiceMonitor schema

401 - Unauthorized

Empty

Expand
Table 11.7. Global path parameters
ParameterTypeDescription

name

string

name of the ServiceMonitor

HTTP method
DELETE
Description
delete a ServiceMonitor
Expand
Table 11.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 11.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified ServiceMonitor
Expand
Table 11.10. HTTP responses
HTTP codeReponse body

200 - OK

ServiceMonitor schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified ServiceMonitor
Expand
Table 11.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 11.12. HTTP responses
HTTP codeReponse body

200 - OK

ServiceMonitor schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified ServiceMonitor
Expand
Table 11.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 11.14. Body parameters
ParameterTypeDescription

body

ServiceMonitor schema

 
Expand
Table 11.15. HTTP responses
HTTP codeReponse body

200 - OK

ServiceMonitor schema

201 - Created

ServiceMonitor schema

401 - Unauthorized

Empty

Expand
Table 11.16. Global path parameters
ParameterTypeDescription

name

string

name of the ServiceMonitor

HTTP method
GET
Description
read status of the specified ServiceMonitor
Expand
Table 11.17. HTTP responses
HTTP codeReponse body

200 - OK

ServiceMonitor schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified ServiceMonitor
Expand
Table 11.18. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 11.19. HTTP responses
HTTP codeReponse body

200 - OK

ServiceMonitor schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified ServiceMonitor
Expand
Table 11.20. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 11.21. Body parameters
ParameterTypeDescription

body

ServiceMonitor schema

 
Expand
Table 11.22. HTTP responses
HTTP codeReponse body

200 - OK

ServiceMonitor schema

201 - Created

ServiceMonitor schema

401 - Unauthorized

Empty

Description

The ThanosRuler custom resource definition (CRD) defines a desired [Thanos Ruler](https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md) setup to run in a Kubernetes cluster.

A ThanosRuler instance requires at least one compatible Prometheus API endpoint (either Thanos Querier or Prometheus services).

The resource defines via label and namespace selectors which PrometheusRule objects should be associated to the deployed Thanos Ruler instances.

Type
object
Required
  • spec

12.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec defines the specification of the desired behavior of the ThanosRuler cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

status

object

status defines the most recent observed status of the ThanosRuler cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

12.1.1. .spec

Description
spec defines the specification of the desired behavior of the ThanosRuler cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Type
object
Expand
PropertyTypeDescription

additionalArgs

array

additionalArgs defines how to add additional arguments for the ThanosRuler 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 ThanosRuler container which may cause issues if they are invalid or not supported by the given ThanosRuler version. In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument the reconciliation will fail and an error will be logged.

additionalArgs[]

object

Argument as part of the AdditionalArgs list.

affinity

object

affinity defines when specified, the pod’s scheduling constraints.

alertDropLabels

array (string)

alertDropLabels defines the label names which should be dropped in Thanos Ruler alerts.

The replica label thanos_ruler_replica will always be dropped from the alerts.

alertQueryUrl

string

alertQueryUrl defines how Thanos Ruler will set in the 'Source' field of all alerts. Maps to the '--alert.query-url' CLI arg.

alertRelabelConfigFile

string

alertRelabelConfigFile defines the path to the alert relabeling configuration file.

Alert relabel configuration must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs

The operator performs no validation of the configuration file.

This field takes precedence over alertRelabelConfig.

alertRelabelConfigs

object

alertRelabelConfigs defines the alert relabeling in Thanos Ruler.

Alert relabel configuration must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs

The operator performs no validation of the configuration.

alertRelabelConfigFile takes precedence over this field.

alertmanagersConfig

object

alertmanagersConfig defines the list of Alertmanager endpoints to send alerts to.

The configuration format is defined at https://thanos.io/tip/components/rule.md/#alertmanager.

It requires Thanos >= v0.10.0.

The operator performs no validation of the configuration.

This field takes precedence over alertmanagersUrl.

alertmanagersUrl

array (string)

alertmanagersUrl defines the list of Alertmanager endpoints to send alerts to.

For Thanos >= v0.10.0, it is recommended to use alertmanagersConfig instead.

alertmanagersConfig takes precedence over this field.

containers

array

containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or to change the behavior of an operator generated container. 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: thanos-ruler 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.

containers[]

object

A single application container that you want to run within a pod.

dnsConfig

object

dnsConfig defines Defines the DNS configuration for the pods.

dnsPolicy

string

dnsPolicy defines the DNS policy for the pods.

enableFeatures

array (string)

enableFeatures defines how to setup Thanos Ruler 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.

For more information see https://thanos.io/tip/components/rule.md/

It requires Thanos >= 0.39.0.

enableServiceLinks

boolean

enableServiceLinks defines whether information about services should be injected into pod’s environment variables

enforcedNamespaceLabel

string

enforcedNamespaceLabel enforces adding a namespace label of origin for each alert and metric that is user created. The label value will always be the namespace of the object that is being created.

evaluationInterval

string

evaluationInterval defines the interval between consecutive evaluations.

excludedFromEnforcement

array

excludedFromEnforcement defines the list of references to PrometheusRule objects to be excluded from enforcing a namespace label of origin. Applies only if enforcedNamespaceLabel set to true.

excludedFromEnforcement[]

object

ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.

externalPrefix

string

externalPrefix defines the Thanos Ruler instances will be available under. This is necessary to generate correct URLs. This is necessary if Thanos Ruler is not served from root of a DNS name.

grpcServerTlsConfig

object

grpcServerTlsConfig defines the gRPC server from which Thanos Querier reads recorded rule data. Note: Currently only the CAFile, CertFile, and KeyFile fields are supported. Maps to the '--grpc-server-tls-*' CLI args.

hostAliases

array

hostAliases defines pods' hostAliases configuration

hostAliases[]

object

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.

hostUsers

boolean

hostUsers supports the user space in Kubernetes.

More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/

The feature requires at least Kubernetes 1.28 with the UserNamespacesSupport feature gate enabled. Starting Kubernetes 1.33, the feature is enabled by default.

image

string

image defines Thanos container image URL.

imagePullPolicy

string

imagePullPolicy defines for the 'thanos', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.

imagePullSecrets

array

imagePullSecrets defines an optional list of references to secrets in the same namespace to use for pulling thanos images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

imagePullSecrets[]

object

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

initContainers

array

initContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the ThanosRuler 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/ Using initContainers for any use case other then secret fetching 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.

initContainers[]

object

A single application container that you want to run within a pod.

labels

object (string)

labels defines the external label pairs of the ThanosRuler resource.

A default replica label thanos_ruler_replica will be always added as a label with the value of the pod’s name.

listenLocal

boolean

listenLocal defines the Thanos ruler listen on loopback, so that it does not bind against the Pod IP.

logFormat

string

logFormat for ThanosRuler to be configured with.

logLevel

string

logLevel for ThanosRuler to be configured with.

minReadySeconds

integer

minReadySeconds defines the 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.

If unset, pods will be considered available as soon as they are ready.

nodeSelector

object (string)

nodeSelector defines which Nodes the Pods are scheduled on.

objectStorageConfig

object

objectStorageConfig defines the configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage

The operator performs no validation of the configuration.

objectStorageConfigFile takes precedence over this field.

objectStorageConfigFile

string

objectStorageConfigFile defines the path of the object storage configuration file.

The configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage

The operator performs no validation of the configuration file.

This field takes precedence over objectStorageConfig.

paused

boolean

paused defines when a ThanosRuler deployment is paused, no actions except for deletion will be performed on the underlying objects.

podMetadata

object

podMetadata defines labels and annotations which are propagated to the ThanosRuler pods.

The following items are reserved and cannot be overridden: * "app.kubernetes.io/name" label, set to "thanos-ruler". * "app.kubernetes.io/managed-by" label, set to "prometheus-operator". * "app.kubernetes.io/instance" label, set to the name of the ThanosRuler instance. * "thanos-ruler" label, set to the name of the ThanosRuler instance. * "kubectl.kubernetes.io/default-container" annotation, set to "thanos-ruler".

portName

string

portName defines the port name used for the pods and governing service. Defaults to web.

priorityClassName

string

priorityClassName defines the priority class assigned to the Pods

prometheusRulesExcludedFromEnforce

array

prometheusRulesExcludedFromEnforce defines a list of Prometheus rules to be excluded from enforcing of adding namespace labels. Works only if enforcedNamespaceLabel set to true. Make sure both ruleNamespace and ruleName are set for each pair Deprecated: use excludedFromEnforcement instead.

prometheusRulesExcludedFromEnforce[]

object

PrometheusRuleExcludeConfig enables users to configure excluded PrometheusRule names and their namespaces to be ignored while enforcing namespace label for alerts and metrics.

queryConfig

object

queryConfig defines the list of Thanos Query endpoints from which to query metrics.

The configuration format is defined at https://thanos.io/tip/components/rule.md/#query-api

It requires Thanos >= v0.11.0.

The operator performs no validation of the configuration.

This field takes precedence over queryEndpoints.

queryEndpoints

array (string)

queryEndpoints defines the list of Thanos Query endpoints from which to query metrics.

For Thanos >= v0.11.0, it is recommended to use queryConfig instead.

queryConfig takes precedence over this field.

remoteWrite

array

remoteWrite defines the list of remote write configurations.

When the list isn’t empty, the ruler is configured with stateless mode.

It requires Thanos >= 0.24.0.

remoteWrite[]

object

RemoteWriteSpec defines the configuration to write samples from Prometheus to a remote endpoint.

replicas

integer

replicas defines the number of thanos ruler instances to deploy.

resendDelay

string

resendDelay defines the minimum amount of time to wait before resending an alert to Alertmanager.

resources

object

resources defines the resource requirements for single Pods. If not provided, no requests/limits will be set

retention

string

retention defines the time duration ThanosRuler shall retain data for. Default is '24h', and must match the regular expression [0-9]+(ms|s|m|h|d|w|y) (milliseconds seconds minutes hours days weeks years).

The field has no effect when remote-write is configured since the Ruler operates in stateless mode.

routePrefix

string

routePrefix defines the route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path.

ruleConcurrentEval

integer

ruleConcurrentEval defines how many rules can be evaluated concurrently. It requires Thanos >= v0.37.0.

ruleGracePeriod

string

ruleGracePeriod defines the minimum duration between alert and restored "for" state. This is maintained only for alerts with configured "for" time greater than grace period. It requires Thanos >= v0.30.0.

ruleNamespaceSelector

object

ruleNamespaceSelector defines the namespaces to be selected for Rules discovery. If unspecified, only the same namespace as the ThanosRuler object is in is used.

ruleOutageTolerance

string

ruleOutageTolerance defines the max time to tolerate prometheus outage for restoring "for" state of alert. It requires Thanos >= v0.30.0.

ruleQueryOffset

string

ruleQueryOffset defines the default rule group’s query offset duration to use. It requires Thanos >= v0.38.0.

ruleSelector

object

ruleSelector defines the PrometheusRule objects to be selected for rule evaluation. An empty label selector matches all objects. A null label selector matches no objects.

securityContext

object

securityContext defines the pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.

serviceAccountName

string

serviceAccountName defines the name of the ServiceAccount to use to run the Thanos Ruler Pods.

serviceName

string

serviceName defines 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 ThanosRuler 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 thanos-ruler-operated for ThanosRuler resources. When deploying multiple ThanosRuler 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.

storage

object

storage defines the specification of how storage shall be used.

terminationGracePeriodSeconds

integer

terminationGracePeriodSeconds defines the 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.

tolerations

array

tolerations defines when specified, the pod’s tolerations.

tolerations[]

object

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

topologySpreadConstraints

array

topologySpreadConstraints defines the pod’s topology spread constraints.

topologySpreadConstraints[]

object

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

tracingConfig

object

tracingConfig defines the tracing configuration.

The configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration

This is an experimental feature, it may change in any upcoming release in a breaking way.

The operator performs no validation of the configuration.

tracingConfigFile takes precedence over this field.

tracingConfigFile

string

tracingConfigFile defines the path of the tracing configuration file.

The configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration

This is an experimental feature, it may change in any upcoming release in a breaking way.

The operator performs no validation of the configuration file.

This field takes precedence over tracingConfig.

version

string

version of Thanos to be deployed.

volumeMounts

array

volumeMounts defines how the configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the ruler container, that are generated as a result of StorageSpec objects.

volumeMounts[]

object

VolumeMount describes a mounting of a Volume within a container.

volumes

array

volumes defines how 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.

volumes[]

object

Volume represents a named volume in a pod that may be accessed by any container in the pod.

web

object

web defines the configuration of the ThanosRuler web server.

12.1.2. .spec.additionalArgs

Description
additionalArgs defines how to add additional arguments for the ThanosRuler 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 ThanosRuler container which may cause issues if they are invalid or not supported by the given ThanosRuler version. In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument the reconciliation will fail and an error will be logged.
Type
array

12.1.3. .spec.additionalArgs[]

Description
Argument as part of the AdditionalArgs list.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name of the argument, e.g. "scrape.discovery-reload-interval".

value

string

value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)

12.1.4. .spec.affinity

Description
affinity defines when specified, the pod’s scheduling constraints.
Type
object
Expand
PropertyTypeDescription

nodeAffinity

object

Describes node affinity scheduling rules for the pod.

podAffinity

object

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

podAntiAffinity

object

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

12.1.5. .spec.affinity.nodeAffinity

Description
Describes node affinity scheduling rules for the pod.
Type
object
Expand
PropertyTypeDescription

preferredDuringSchedulingIgnoredDuringExecution

array

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.

preferredDuringSchedulingIgnoredDuringExecution[]

object

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

requiredDuringSchedulingIgnoredDuringExecution

object

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.

Description
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
Type
array
Description
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Type
object
Required
  • preference
  • weight
Expand
PropertyTypeDescription

preference

object

A node selector term, associated with the corresponding weight.

weight

integer

Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

Description
A node selector term, associated with the corresponding weight.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

A list of node selector requirements by node’s labels.

matchExpressions[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchFields

array

A list of node selector requirements by node’s fields.

matchFields[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Description
A list of node selector requirements by node’s labels.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values

array (string)

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.

Description
A list of node selector requirements by node’s fields.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values

array (string)

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.

Description
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
Type
object
Required
  • nodeSelectorTerms
Expand
PropertyTypeDescription

nodeSelectorTerms

array

Required. A list of node selector terms. The terms are ORed.

nodeSelectorTerms[]

object

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Description
Required. A list of node selector terms. The terms are ORed.
Type
array
Description
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

A list of node selector requirements by node’s labels.

matchExpressions[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchFields

array

A list of node selector requirements by node’s fields.

matchFields[]

object

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Description
A list of node selector requirements by node’s labels.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values

array (string)

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.

Description
A list of node selector requirements by node’s fields.
Type
array
Description
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

The label key that the selector applies to.

operator

string

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

values

array (string)

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.

12.1.20. .spec.affinity.podAffinity

Description
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Type
object
Expand
PropertyTypeDescription

preferredDuringSchedulingIgnoredDuringExecution

array

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.

preferredDuringSchedulingIgnoredDuringExecution[]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

requiredDuringSchedulingIgnoredDuringExecution

array

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.

requiredDuringSchedulingIgnoredDuringExecution[]

object

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

Description
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
Type
array
Description
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Type
object
Required
  • podAffinityTerm
  • weight
Expand
PropertyTypeDescription

podAffinityTerm

object

Required. A pod affinity term, associated with the corresponding weight.

weight

integer

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

Description
Required. A pod affinity term, associated with the corresponding weight.
Type
object
Required
  • topologyKey
Expand
PropertyTypeDescription

labelSelector

object

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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".

topologyKey

string

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.

Description
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Type
array
Description
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
Type
object
Required
  • topologyKey
Expand
PropertyTypeDescription

labelSelector

object

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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".

topologyKey

string

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.

Description
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

12.1.38. .spec.affinity.podAntiAffinity

Description
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Type
object
Expand
PropertyTypeDescription

preferredDuringSchedulingIgnoredDuringExecution

array

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 subtracting "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

preferredDuringSchedulingIgnoredDuringExecution[]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

requiredDuringSchedulingIgnoredDuringExecution

array

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.

requiredDuringSchedulingIgnoredDuringExecution[]

object

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

Description
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and subtracting "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
Type
array
Description
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Type
object
Required
  • podAffinityTerm
  • weight
Expand
PropertyTypeDescription

podAffinityTerm

object

Required. A pod affinity term, associated with the corresponding weight.

weight

integer

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

Description
Required. A pod affinity term, associated with the corresponding weight.
Type
object
Required
  • topologyKey
Expand
PropertyTypeDescription

labelSelector

object

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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".

topologyKey

string

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.

Description
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Type
array
Description
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
Type
object
Required
  • topologyKey
Expand
PropertyTypeDescription

labelSelector

object

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

matchLabelKeys

array (string)

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.

mismatchLabelKeys

array (string)

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.

namespaceSelector

object

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.

namespaces

array (string)

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".

topologyKey

string

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.

Description
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

12.1.56. .spec.alertRelabelConfigs

Description

alertRelabelConfigs defines the alert relabeling in Thanos Ruler.

Alert relabel configuration must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs

The operator performs no validation of the configuration.

alertRelabelConfigFile takes precedence over this field.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.57. .spec.alertmanagersConfig

Description

alertmanagersConfig defines the list of Alertmanager endpoints to send alerts to.

The configuration format is defined at https://thanos.io/tip/components/rule.md/#alertmanager.

It requires Thanos >= v0.10.0.

The operator performs no validation of the configuration.

This field takes precedence over alertmanagersUrl.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.58. .spec.containers

Description
containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or to change the behavior of an operator generated container. 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: thanos-ruler 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.
Type
array

12.1.59. .spec.containers[]

Description
A single application container that you want to run within a pod.
Type
object
Required
  • name
Expand
PropertyTypeDescription

args

array (string)

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

command

array (string)

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

env

array

List of environment variables to set in the container. Cannot be updated.

env[]

object

EnvVar represents an environment variable present in a Container.

envFrom

array

List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. 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.

envFrom[]

object

EnvFromSource represents the source of a set of ConfigMaps or Secrets

image

string

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.

imagePullPolicy

string

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

object

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

livenessProbe

object

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

name

string

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

ports

array

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.

ports[]

object

ContainerPort represents a network port in a single container.

readinessProbe

object

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

resizePolicy

array

Resources resize policy for the container.

resizePolicy[]

object

ContainerResizePolicy represents resource resize policy for the container.

resources

object

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

restartPolicy

string

RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Additionally, 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.

restartPolicyRules

array

Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.

restartPolicyRules[]

object

ContainerRestartRule describes how a container exit is handled.

securityContext

object

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbe

object

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

stdin

boolean

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.

stdinOnce

boolean

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

terminationMessagePath

string

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.

terminationMessagePolicy

string

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.

tty

boolean

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

volumeDevices

array

volumeDevices is the list of block devices to be used by the container.

volumeDevices[]

object

volumeDevice describes a mapping of a raw block device within a container.

volumeMounts

array

Pod volumes to mount into the container’s filesystem. Cannot be updated.

volumeMounts[]

object

VolumeMount describes a mounting of a Volume within a container.

workingDir

string

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.

12.1.60. .spec.containers[].env

Description
List of environment variables to set in the container. Cannot be updated.
Type
array

12.1.61. .spec.containers[].env[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

Name of the environment variable. May consist of any printable ASCII characters except '='.

value

string

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 "".

valueFrom

object

Source for the environment variable’s value. Cannot be used if value is not empty.

12.1.62. .spec.containers[].env[].valueFrom

Description
Source for the environment variable’s value. Cannot be used if value is not empty.
Type
object
Expand
PropertyTypeDescription

configMapKeyRef

object

Selects a key of a ConfigMap.

fieldRef

object

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.

fileKeyRef

object

FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.

resourceFieldRef

object

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.

secretKeyRef

object

Selects a key of a secret in the pod’s namespace

Description
Selects a key of a ConfigMap.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
  • fieldPath
Expand
PropertyTypeDescription

apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPath

string

Path of the field to select in the specified API version.

Description
FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
Type
object
Required
  • key
  • path
  • volumeName
Expand
PropertyTypeDescription

key

string

The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

optional

boolean

Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod’s containers.

If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.

path

string

The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.

volumeName

string

The name of the volume mount containing the env file.

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
  • resource
Expand
PropertyTypeDescription

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

Specifies the output format of the exposed resources, defaults to "1"

resource

string

Required: resource to select

Description
Selects a key of a secret in the pod’s namespace
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.68. .spec.containers[].envFrom

Description
List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
Type
array

12.1.69. .spec.containers[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps or Secrets
Type
object
Expand
PropertyTypeDescription

configMapRef

object

The ConfigMap to select from

prefix

string

Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.

secretRef

object

The Secret to select from

12.1.70. .spec.containers[].envFrom[].configMapRef

Description
The ConfigMap to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the ConfigMap must be defined

12.1.71. .spec.containers[].envFrom[].secretRef

Description
The Secret to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the Secret must be defined

12.1.72. .spec.containers[].lifecycle

Description
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Type
object
Expand
PropertyTypeDescription

postStart

object

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStop

object

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

stopSignal

string

StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name

12.1.73. .spec.containers[].lifecycle.postStart

Description
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

12.1.80. .spec.containers[].lifecycle.preStop

Description
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

12.1.81. .spec.containers[].lifecycle.preStop.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

12.1.87. .spec.containers[].livenessProbe

Description
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

12.1.88. .spec.containers[].livenessProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

12.1.89. .spec.containers[].livenessProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

12.1.90. .spec.containers[].livenessProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

12.1.94. .spec.containers[].ports

Description
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.
Type
array

12.1.95. .spec.containers[].ports[]

Description
ContainerPort represents a network port in a single container.
Type
object
Required
  • containerPort
Expand
PropertyTypeDescription

containerPort

integer

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

hostIP

string

What host IP to bind the external port to.

hostPort

integer

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.

name

string

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

protocol

string

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

12.1.96. .spec.containers[].readinessProbe

Description
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

12.1.97. .spec.containers[].readinessProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

12.1.98. .spec.containers[].readinessProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

12.1.99. .spec.containers[].readinessProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

12.1.103. .spec.containers[].resizePolicy

Description
Resources resize policy for the container.
Type
array

12.1.104. .spec.containers[].resizePolicy[]

Description
ContainerResizePolicy represents resource resize policy for the container.
Type
object
Required
  • resourceName
  • restartPolicy
Expand
PropertyTypeDescription

resourceName

string

Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.

restartPolicy

string

Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

12.1.105. .spec.containers[].resources

Description
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object
Expand
PropertyTypeDescription

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

12.1.106. .spec.containers[].resources.claims

Description

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Type
array

12.1.107. .spec.containers[].resources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

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.

request

string

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.

12.1.108. .spec.containers[].restartPolicyRules

Description
Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.
Type
array

12.1.109. .spec.containers[].restartPolicyRules[]

Description
ContainerRestartRule describes how a container exit is handled.
Type
object
Required
  • action
Expand
PropertyTypeDescription

action

string

Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container.

exitCodes

object

Represents the exit codes to check on container exits.

Description
Represents the exit codes to check on container exits.
Type
object
Required
  • operator
Expand
PropertyTypeDescription

operator

string

Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values. - NotIn: the requirement is satisfied if the container exit code is not in the set of specified values.

values

array (integer)

Specifies the set of values to check for container exit codes. At most 255 elements are allowed.

12.1.111. .spec.containers[].securityContext

Description
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Type
object
Expand
PropertyTypeDescription

allowPrivilegeEscalation

boolean

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.

appArmorProfile

object

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.

capabilities

object

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.

privileged

boolean

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.

procMount

string

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.

readOnlyRootFilesystem

boolean

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.

runAsGroup

integer

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.

runAsNonRoot

boolean

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.

runAsUser

integer

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.

seLinuxOptions

object

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.

seccompProfile

object

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.

windowsOptions

object

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.

Description
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.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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".

type

string

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.

Description
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.
Type
object
Expand
PropertyTypeDescription

add

array (string)

Added capabilities

drop

array (string)

Removed capabilities

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Type
object
Expand
PropertyTypeDescription

level

string

Level is SELinux level label that applies to the container.

role

string

Role is a SELinux role label that applies to the container.

type

string

Type is a SELinux type label that applies to the container.

user

string

User is a SELinux user label that applies to the container.

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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.

type

string

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.

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
Expand
PropertyTypeDescription

gmsaCredentialSpec

string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcess

boolean

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.

runAsUserName

string

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.

12.1.117. .spec.containers[].startupProbe

Description
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

12.1.118. .spec.containers[].startupProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

12.1.119. .spec.containers[].startupProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

12.1.120. .spec.containers[].startupProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

12.1.124. .spec.containers[].volumeDevices

Description
volumeDevices is the list of block devices to be used by the container.
Type
array

12.1.125. .spec.containers[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
  • devicePath
  • name
Expand
PropertyTypeDescription

devicePath

string

devicePath is the path inside of the container that the device will be mapped to.

name

string

name must match the name of a persistentVolumeClaim in the pod

12.1.126. .spec.containers[].volumeMounts

Description
Pod volumes to mount into the container’s filesystem. Cannot be updated.
Type
array

12.1.127. .spec.containers[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
  • mountPath
  • name
Expand
PropertyTypeDescription

mountPath

string

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation

string

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).

name

string

This must match the Name of a Volume.

readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly

string

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.

subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

subPathExpr

string

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.

12.1.128. .spec.dnsConfig

Description
dnsConfig defines Defines the DNS configuration for the pods.
Type
object
Expand
PropertyTypeDescription

nameservers

array (string)

nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy.

options

array

options defines the 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.

options[]

object

PodDNSConfigOption defines DNS resolver options of a pod.

searches

array (string)

searches defines the list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy.

12.1.129. .spec.dnsConfig.options

Description
options defines the 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.
Type
array

12.1.130. .spec.dnsConfig.options[]

Description
PodDNSConfigOption defines DNS resolver options of a pod.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

name is required and must be unique.

value

string

value is optional.

12.1.131. .spec.excludedFromEnforcement

Description
excludedFromEnforcement defines the list of references to PrometheusRule objects to be excluded from enforcing a namespace label of origin. Applies only if enforcedNamespaceLabel set to true.
Type
array

12.1.132. .spec.excludedFromEnforcement[]

Description
ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.
Type
object
Required
  • namespace
  • resource
Expand
PropertyTypeDescription

group

string

group of the referent. When not specified, it defaults to monitoring.coreos.com

name

string

name of the referent. When not set, all resources in the namespace are matched.

namespace

string

namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resource

string

resource of the referent.

12.1.133. .spec.grpcServerTlsConfig

Description
grpcServerTlsConfig defines the gRPC server from which Thanos Querier reads recorded rule data. Note: Currently only the CAFile, CertFile, and KeyFile fields are supported. Maps to the '--grpc-server-tls-*' CLI args.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

caFile

string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

cert

object

cert defines the Client certificate to present when doing client-authentication.

certFile

string

certFile defines the path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keyFile

string

keyFile defines the path to the client key file in the Prometheus container for the targets.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

12.1.134. .spec.grpcServerTlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

12.1.135. .spec.grpcServerTlsConfig.ca.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

12.1.136. .spec.grpcServerTlsConfig.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.137. .spec.grpcServerTlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

12.1.138. .spec.grpcServerTlsConfig.cert.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

12.1.139. .spec.grpcServerTlsConfig.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.140. .spec.grpcServerTlsConfig.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.141. .spec.hostAliases

Description
hostAliases defines pods' hostAliases configuration
Type
array

12.1.142. .spec.hostAliases[]

Description
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
Type
object
Required
  • hostnames
  • ip
Expand
PropertyTypeDescription

hostnames

array (string)

hostnames defines hostnames for the above IP address.

ip

string

ip defines the IP address of the host file entry.

12.1.143. .spec.imagePullSecrets

Description
imagePullSecrets defines an optional list of references to secrets in the same namespace to use for pulling thanos images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
Type
array

12.1.144. .spec.imagePullSecrets[]

Description
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Type
object
Expand
PropertyTypeDescription

name

string

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

12.1.145. .spec.initContainers

Description
initContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the ThanosRuler 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/ Using initContainers for any use case other then secret fetching 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.
Type
array

12.1.146. .spec.initContainers[]

Description
A single application container that you want to run within a pod.
Type
object
Required
  • name
Expand
PropertyTypeDescription

args

array (string)

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

command

array (string)

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

env

array

List of environment variables to set in the container. Cannot be updated.

env[]

object

EnvVar represents an environment variable present in a Container.

envFrom

array

List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. 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.

envFrom[]

object

EnvFromSource represents the source of a set of ConfigMaps or Secrets

image

string

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.

imagePullPolicy

string

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

object

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

livenessProbe

object

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

name

string

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

ports

array

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.

ports[]

object

ContainerPort represents a network port in a single container.

readinessProbe

object

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

resizePolicy

array

Resources resize policy for the container.

resizePolicy[]

object

ContainerResizePolicy represents resource resize policy for the container.

resources

object

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

restartPolicy

string

RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Additionally, 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.

restartPolicyRules

array

Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.

restartPolicyRules[]

object

ContainerRestartRule describes how a container exit is handled.

securityContext

object

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbe

object

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

stdin

boolean

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.

stdinOnce

boolean

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

terminationMessagePath

string

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.

terminationMessagePolicy

string

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.

tty

boolean

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

volumeDevices

array

volumeDevices is the list of block devices to be used by the container.

volumeDevices[]

object

volumeDevice describes a mapping of a raw block device within a container.

volumeMounts

array

Pod volumes to mount into the container’s filesystem. Cannot be updated.

volumeMounts[]

object

VolumeMount describes a mounting of a Volume within a container.

workingDir

string

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.

12.1.147. .spec.initContainers[].env

Description
List of environment variables to set in the container. Cannot be updated.
Type
array

12.1.148. .spec.initContainers[].env[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

Name of the environment variable. May consist of any printable ASCII characters except '='.

value

string

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 "".

valueFrom

object

Source for the environment variable’s value. Cannot be used if value is not empty.

12.1.149. .spec.initContainers[].env[].valueFrom

Description
Source for the environment variable’s value. Cannot be used if value is not empty.
Type
object
Expand
PropertyTypeDescription

configMapKeyRef

object

Selects a key of a ConfigMap.

fieldRef

object

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.

fileKeyRef

object

FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.

resourceFieldRef

object

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.

secretKeyRef

object

Selects a key of a secret in the pod’s namespace

Description
Selects a key of a ConfigMap.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
  • fieldPath
Expand
PropertyTypeDescription

apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPath

string

Path of the field to select in the specified API version.

Description
FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
Type
object
Required
  • key
  • path
  • volumeName
Expand
PropertyTypeDescription

key

string

The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

optional

boolean

Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod’s containers.

If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.

path

string

The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.

volumeName

string

The name of the volume mount containing the env file.

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
  • resource
Expand
PropertyTypeDescription

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

Specifies the output format of the exposed resources, defaults to "1"

resource

string

Required: resource to select

Description
Selects a key of a secret in the pod’s namespace
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.155. .spec.initContainers[].envFrom

Description
List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
Type
array

12.1.156. .spec.initContainers[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps or Secrets
Type
object
Expand
PropertyTypeDescription

configMapRef

object

The ConfigMap to select from

prefix

string

Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.

secretRef

object

The Secret to select from

Description
The ConfigMap to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the ConfigMap must be defined

Description
The Secret to select from
Type
object
Expand
PropertyTypeDescription

name

string

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

optional

boolean

Specify whether the Secret must be defined

12.1.159. .spec.initContainers[].lifecycle

Description
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Type
object
Expand
PropertyTypeDescription

postStart

object

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStop

object

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

stopSignal

string

StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name

Description
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

12.1.167. .spec.initContainers[].lifecycle.preStop

Description
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

sleep

object

Sleep represents a duration that the container should sleep.

tcpSocket

object

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.

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
  • seconds
Expand
PropertyTypeDescription

seconds

integer

Seconds is the number of seconds to sleep.

Description
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.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

12.1.174. .spec.initContainers[].livenessProbe

Description
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

12.1.181. .spec.initContainers[].ports

Description
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.
Type
array

12.1.182. .spec.initContainers[].ports[]

Description
ContainerPort represents a network port in a single container.
Type
object
Required
  • containerPort
Expand
PropertyTypeDescription

containerPort

integer

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

hostIP

string

What host IP to bind the external port to.

hostPort

integer

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.

name

string

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

protocol

string

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

12.1.183. .spec.initContainers[].readinessProbe

Description
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

12.1.190. .spec.initContainers[].resizePolicy

Description
Resources resize policy for the container.
Type
array

12.1.191. .spec.initContainers[].resizePolicy[]

Description
ContainerResizePolicy represents resource resize policy for the container.
Type
object
Required
  • resourceName
  • restartPolicy
Expand
PropertyTypeDescription

resourceName

string

Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.

restartPolicy

string

Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

12.1.192. .spec.initContainers[].resources

Description
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object
Expand
PropertyTypeDescription

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

12.1.193. .spec.initContainers[].resources.claims

Description

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Type
array
Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

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.

request

string

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.

Description
Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod’s RestartPolicy.
Type
array
Description
ContainerRestartRule describes how a container exit is handled.
Type
object
Required
  • action
Expand
PropertyTypeDescription

action

string

Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container.

exitCodes

object

Represents the exit codes to check on container exits.

Description
Represents the exit codes to check on container exits.
Type
object
Required
  • operator
Expand
PropertyTypeDescription

operator

string

Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values. - NotIn: the requirement is satisfied if the container exit code is not in the set of specified values.

values

array (integer)

Specifies the set of values to check for container exit codes. At most 255 elements are allowed.

12.1.198. .spec.initContainers[].securityContext

Description
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Type
object
Expand
PropertyTypeDescription

allowPrivilegeEscalation

boolean

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.

appArmorProfile

object

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.

capabilities

object

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.

privileged

boolean

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.

procMount

string

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.

readOnlyRootFilesystem

boolean

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.

runAsGroup

integer

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.

runAsNonRoot

boolean

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.

runAsUser

integer

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.

seLinuxOptions

object

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.

seccompProfile

object

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.

windowsOptions

object

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.

Description
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.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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".

type

string

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.

Description
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.
Type
object
Expand
PropertyTypeDescription

add

array (string)

Added capabilities

drop

array (string)

Removed capabilities

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Type
object
Expand
PropertyTypeDescription

level

string

Level is SELinux level label that applies to the container.

role

string

Role is a SELinux role label that applies to the container.

type

string

Type is a SELinux type label that applies to the container.

user

string

User is a SELinux user label that applies to the container.

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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.

type

string

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.

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
Expand
PropertyTypeDescription

gmsaCredentialSpec

string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcess

boolean

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.

runAsUserName

string

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.

12.1.204. .spec.initContainers[].startupProbe

Description
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
Expand
PropertyTypeDescription

exec

object

Exec specifies a command to execute in the container.

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpc

object

GRPC specifies a GRPC HealthCheckRequest.

httpGet

object

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds

integer

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

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocket

object

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds

integer

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.

timeoutSeconds

integer

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

12.1.205. .spec.initContainers[].startupProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
Expand
PropertyTypeDescription

command

array (string)

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.

12.1.206. .spec.initContainers[].startupProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
  • port
Expand
PropertyTypeDescription

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

service

string

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.

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

httpHeaders[]

object

HTTPHeader describes a custom header to be used in HTTP probes

path

string

Path to access on the HTTP server.

port

integer-or-string

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array
Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

value

string

The header field value

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
  • port
Expand
PropertyTypeDescription

host

string

Optional: Host name to connect to, defaults to the pod IP.

port

integer-or-string

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.

12.1.211. .spec.initContainers[].volumeDevices

Description
volumeDevices is the list of block devices to be used by the container.
Type
array

12.1.212. .spec.initContainers[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
  • devicePath
  • name
Expand
PropertyTypeDescription

devicePath

string

devicePath is the path inside of the container that the device will be mapped to.

name

string

name must match the name of a persistentVolumeClaim in the pod

12.1.213. .spec.initContainers[].volumeMounts

Description
Pod volumes to mount into the container’s filesystem. Cannot be updated.
Type
array

12.1.214. .spec.initContainers[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
  • mountPath
  • name
Expand
PropertyTypeDescription

mountPath

string

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation

string

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).

name

string

This must match the Name of a Volume.

readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly

string

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.

subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

subPathExpr

string

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.

12.1.215. .spec.objectStorageConfig

Description

objectStorageConfig defines the configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage

The operator performs no validation of the configuration.

objectStorageConfigFile takes precedence over this field.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.216. .spec.podMetadata

Description

podMetadata defines labels and annotations which are propagated to the ThanosRuler pods.

The following items are reserved and cannot be overridden: * "app.kubernetes.io/name" label, set to "thanos-ruler". * "app.kubernetes.io/managed-by" label, set to "prometheus-operator". * "app.kubernetes.io/instance" label, set to the name of the ThanosRuler instance. * "thanos-ruler" label, set to the name of the ThanosRuler instance. * "kubectl.kubernetes.io/default-container" annotation, set to "thanos-ruler".

Type
object
Expand
PropertyTypeDescription

annotations

object (string)

annotations defines 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

labels

object (string)

labels define the 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

name

string

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

12.1.217. .spec.prometheusRulesExcludedFromEnforce

Description
prometheusRulesExcludedFromEnforce defines a list of Prometheus rules to be excluded from enforcing of adding namespace labels. Works only if enforcedNamespaceLabel set to true. Make sure both ruleNamespace and ruleName are set for each pair Deprecated: use excludedFromEnforcement instead.
Type
array
Description
PrometheusRuleExcludeConfig enables users to configure excluded PrometheusRule names and their namespaces to be ignored while enforcing namespace label for alerts and metrics.
Type
object
Required
  • ruleName
  • ruleNamespace
Expand
PropertyTypeDescription

ruleName

string

ruleName defines the name of the excluded PrometheusRule object.

ruleNamespace

string

ruleNamespace defines the namespace of the excluded PrometheusRule object.

12.1.219. .spec.queryConfig

Description

queryConfig defines the list of Thanos Query endpoints from which to query metrics.

The configuration format is defined at https://thanos.io/tip/components/rule.md/#query-api

It requires Thanos >= v0.11.0.

The operator performs no validation of the configuration.

This field takes precedence over queryEndpoints.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.220. .spec.remoteWrite

Description

remoteWrite defines the list of remote write configurations.

When the list isn’t empty, the ruler is configured with stateless mode.

It requires Thanos >= 0.24.0.

Type
array

12.1.221. .spec.remoteWrite[]

Description
RemoteWriteSpec defines the configuration to write samples from Prometheus to a remote endpoint.
Type
object
Required
  • url
Expand
PropertyTypeDescription

authorization

object

authorization section for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as sigv4, basicAuth, oauth2, or azureAd.

azureAd

object

azureAd for the URL.

It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.

Cannot be set at the same time as authorization, basicAuth, oauth2, or sigv4.

basicAuth

object

basicAuth configuration for the URL.

Cannot be set at the same time as sigv4, authorization, oauth2, or azureAd.

bearerToken

string

bearerToken is deprecated: this will be removed in a future release. Warning: this field shouldn’t be used because the token value appears in clear-text. Prefer using authorization.

bearerTokenFile

string

bearerTokenFile defines the file from which to read bearer token for the URL.

Deprecated: this will be removed in a future release. Prefer using authorization.

enableHTTP2

boolean

enableHTTP2 defines whether to enable HTTP2.

followRedirects

boolean

followRedirects defines whether HTTP requests follow HTTP 3xx redirects.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

headers

object (string)

headers defines the custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can’t be overwritten.

It requires Prometheus >= v2.25.0 or Thanos >= v0.24.0.

messageVersion

string

messageVersion defines the Remote Write message’s version to use when writing to the endpoint.

Version1.0 corresponds to the prometheus.WriteRequest protobuf message introduced in Remote Write 1.0. Version2.0 corresponds to the io.prometheus.write.v2.Request protobuf message introduced in Remote Write 2.0.

When Version2.0 is selected, Prometheus will automatically be configured to append the metadata of scraped metrics to the WAL.

Before setting this field, consult with your remote storage provider what message version it supports.

It requires Prometheus >= v2.54.0 or Thanos >= v0.37.0.

metadataConfig

object

metadataConfig defines how to send a series metadata to the remote storage.

When the field is empty, no metadata is sent. But when the field is null, metadata is sent.

name

string

name of the remote write queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate queues.

It requires Prometheus >= v2.15.0 or Thanos >= 0.24.0.

noProxy

string

noProxy defines 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.

oauth2

object

oauth2 configuration for the URL.

It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.

Cannot be set at the same time as sigv4, authorization, basicAuth, or azureAd.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

queueConfig

object

queueConfig allows tuning of the remote write queue parameters.

remoteTimeout

string

remoteTimeout defines the timeout for requests to the remote write endpoint.

roundRobinDNS

boolean

roundRobinDNS controls the DNS resolution behavior for remote-write connections. When enabled: - The remote-write mechanism will resolve the hostname via DNS. - It will randomly select one of the resolved IP addresses and connect to it.

When disabled (default behavior): - The Go standard library will handle hostname resolution. - It will attempt connections to each resolved IP address sequentially.

Note: The connection timeout applies to the entire resolution and connection process.

If disabled, the timeout is distributed across all connection attempts.

It requires Prometheus >= v3.1.0 or Thanos >= v0.38.0.

sendExemplars

boolean

sendExemplars enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the spec.enableFeatures option for exemplars to be scraped in the first place.

It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.

sendNativeHistograms

boolean

sendNativeHistograms enables sending of native histograms, also known as sparse histograms over remote write.

It requires Prometheus >= v2.40.0 or Thanos >= v0.30.0.

sigv4

object

sigv4 defines the AWS’s Signature Verification 4 for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as authorization, basicAuth, oauth2, or azureAd.

tlsConfig

object

tlsConfig to use for the URL.

url

string

url defines the URL of the endpoint to send samples to.

writeRelabelConfigs

array

writeRelabelConfigs defines the list of remote write relabel configurations.

writeRelabelConfigs[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

12.1.222. .spec.remoteWrite[].authorization

Description

authorization section for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as sigv4, basicAuth, oauth2, or azureAd.

Type
object
Expand
PropertyTypeDescription

credentials

object

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

credentialsFile

string

credentialsFile defines the file to read a secret from, mutually exclusive with credentials.

type

string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.224. .spec.remoteWrite[].azureAd

Description

azureAd for the URL.

It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.

Cannot be set at the same time as authorization, basicAuth, oauth2, or sigv4.

Type
object
Expand
PropertyTypeDescription

cloud

string

cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.

managedIdentity

object

managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as oauth or sdk.

oauth

object

oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as managedIdentity or sdk.

It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.

sdk

object

sdk defines the Azure SDK config that is being used to authenticate. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication Cannot be set at the same time as oauth or managedIdentity.

It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.

Description
managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as oauth or sdk.
Type
object
Expand
PropertyTypeDescription

clientId

string

clientId defines the Azure User-assigned Managed identity.

For Prometheus >= 3.5.0 and Thanos >= 0.40.0, this field is allowed to be empty to support system-assigned managed identities.

12.1.226. .spec.remoteWrite[].azureAd.oauth

Description

oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as managedIdentity or sdk.

It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.

Type
object
Required
  • clientId
  • clientSecret
  • tenantId
Expand
PropertyTypeDescription

clientId

string

clientId defines the clientId of the Azure Active Directory application that is being used to authenticate.

clientSecret

object

clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.

tenantId

string

tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate.

Description
clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.228. .spec.remoteWrite[].azureAd.sdk

Description

sdk defines the Azure SDK config that is being used to authenticate. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication Cannot be set at the same time as oauth or managedIdentity.

It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.

Type
object
Expand
PropertyTypeDescription

tenantId

string

tenantId defines the tenant ID of the azure active directory application that is being used to authenticate.

12.1.229. .spec.remoteWrite[].basicAuth

Description

basicAuth configuration for the URL.

Cannot be set at the same time as sigv4, authorization, oauth2, or azureAd.

Type
object
Expand
PropertyTypeDescription

password

object

password defines a key of a Secret containing the password for authentication.

username

object

username defines a key of a Secret containing the username for authentication.

12.1.230. .spec.remoteWrite[].basicAuth.password

Description
password defines a key of a Secret containing the password for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.231. .spec.remoteWrite[].basicAuth.username

Description
username defines a key of a Secret containing the username for authentication.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.232. .spec.remoteWrite[].metadataConfig

Description

metadataConfig defines how to send a series metadata to the remote storage.

When the field is empty, no metadata is sent. But when the field is null, metadata is sent.

Type
object
Expand
PropertyTypeDescription

maxSamplesPerSend

integer

maxSamplesPerSend defines the maximum number of metadata samples per send.

It requires Prometheus >= v2.29.0.

send

boolean

send defines whether metric metadata is sent to the remote storage or not.

sendInterval

string

sendInterval defines how frequently metric metadata is sent to the remote storage.

12.1.233. .spec.remoteWrite[].oauth2

Description

oauth2 configuration for the URL.

It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.

Cannot be set at the same time as sigv4, authorization, basicAuth, or azureAd.

Type
object
Required
  • clientId
  • clientSecret
  • tokenUrl
Expand
PropertyTypeDescription

clientId

object

clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.

clientSecret

object

clientSecret defines a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

endpointParams configures the HTTP parameters to append to the token URL.

noProxy

string

noProxy defines 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.

proxyConnectHeader

object

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.

proxyConnectHeader{}

array

 

proxyConnectHeader{}[]

object

SecretKeySelector selects a key of a Secret.

proxyFromEnvironment

boolean

proxyFromEnvironment defines 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.

proxyUrl

string

proxyUrl defines the HTTP proxy server to use.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tlsConfig

object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.

tokenUrl

string

tokenUrl defines the URL to fetch the token from.

12.1.234. .spec.remoteWrite[].oauth2.clientId

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.237. .spec.remoteWrite[].oauth2.clientSecret

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description

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.

Type
object
Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.241. .spec.remoteWrite[].oauth2.tlsConfig

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

cert

object

cert defines the Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

12.1.242. .spec.remoteWrite[].oauth2.tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.249. .spec.remoteWrite[].proxyConnectHeader

Description

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.

Type
object

12.1.250. .spec.remoteWrite[].proxyConnectHeader{}

Description
Type
array
Description
SecretKeySelector selects a key of a Secret.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.252. .spec.remoteWrite[].queueConfig

Description
queueConfig allows tuning of the remote write queue parameters.
Type
object
Expand
PropertyTypeDescription

batchSendDeadline

string

batchSendDeadline defines the maximum time a sample will wait in buffer.

capacity

integer

capacity defines the number of samples to buffer per shard before we start dropping them.

maxBackoff

string

maxBackoff defines the maximum retry delay.

maxRetries

integer

maxRetries defines the maximum number of times to retry a batch on recoverable errors.

maxSamplesPerSend

integer

maxSamplesPerSend defines the maximum number of samples per send.

maxShards

integer

maxShards defines the maximum number of shards, i.e. amount of concurrency.

minBackoff

string

minBackoff defines the initial retry delay. Gets doubled for every retry.

minShards

integer

minShards defines the minimum number of shards, i.e. amount of concurrency.

retryOnRateLimit

boolean

retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage.

This is an experimental feature, it may change in any upcoming release in a breaking way.

sampleAgeLimit

string

sampleAgeLimit drops samples older than the limit. It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0.

12.1.253. .spec.remoteWrite[].sigv4

Description

sigv4 defines the AWS’s Signature Verification 4 for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as authorization, basicAuth, oauth2, or azureAd.

Type
object
Expand
PropertyTypeDescription

accessKey

object

accessKey defines the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID is used.

profile

string

profile defines the named AWS profile used to authenticate.

region

string

region defines the AWS region. If blank, the region from the default credentials chain used.

roleArn

string

roleArn defines the named AWS profile used to authenticate.

secretKey

object

secretKey defines the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY is used.

useFIPSSTSEndpoint

boolean

useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. It requires Prometheus >= v2.54.0.

12.1.254. .spec.remoteWrite[].sigv4.accessKey

Description
accessKey defines the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID is used.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.255. .spec.remoteWrite[].sigv4.secretKey

Description
secretKey defines the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY is used.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.256. .spec.remoteWrite[].tlsConfig

Description
tlsConfig to use for the URL.
Type
object
Expand
PropertyTypeDescription

ca

object

ca defines the Certificate authority used when verifying server certificates.

caFile

string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

cert

object

cert defines the Client certificate to present when doing client-authentication.

certFile

string

certFile defines the path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

insecureSkipVerify defines how to disable target certificate validation.

keyFile

string

keyFile defines the path to the client key file in the Prometheus container for the targets.

keySecret

object

keySecret defines the Secret containing the client key file for the targets.

maxVersion

string

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

minVersion

string

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

serverName

string

serverName is used to verify the hostname for the targets.

12.1.257. .spec.remoteWrite[].tlsConfig.ca

Description
ca defines the Certificate authority used when verifying server certificates.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

12.1.259. .spec.remoteWrite[].tlsConfig.ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.260. .spec.remoteWrite[].tlsConfig.cert

Description
cert defines the Client certificate to present when doing client-authentication.
Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.263. .spec.remoteWrite[].tlsConfig.keySecret

Description
keySecret defines the Secret containing the client key file for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.264. .spec.remoteWrite[].writeRelabelConfigs

Description
writeRelabelConfigs defines the list of remote write relabel configurations.
Type
array
Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
object
Expand
PropertyTypeDescription

action

string

action to perform based on the regex matching.

Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.

Default: "Replace"

modulus

integer

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

regex

string

regex defines the regular expression against which the extracted value is matched.

replacement

string

replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

separator

string

separator defines the string between concatenated SourceLabels.

sourceLabels

array (string)

sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.

Regex capture groups are available.

12.1.266. .spec.resources

Description
resources defines the resource requirements for single Pods. If not provided, no requests/limits will be set
Type
object
Expand
PropertyTypeDescription

claims

array

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

claims[]

object

ResourceClaim references one entry in PodSpec.ResourceClaims.

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

12.1.267. .spec.resources.claims

Description

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This field depends on the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Type
array

12.1.268. .spec.resources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
  • name
Expand
PropertyTypeDescription

name

string

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.

request

string

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.

12.1.269. .spec.ruleNamespaceSelector

Description
ruleNamespaceSelector defines the namespaces to be selected for Rules discovery. If unspecified, only the same namespace as the ThanosRuler object is in is used.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

12.1.272. .spec.ruleSelector

Description
ruleSelector defines the PrometheusRule objects to be selected for rule evaluation. An empty label selector matches all objects. A null label selector matches no objects.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

12.1.273. .spec.ruleSelector.matchExpressions

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array

12.1.274. .spec.ruleSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

12.1.275. .spec.securityContext

Description
securityContext defines the pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
Type
object
Expand
PropertyTypeDescription

appArmorProfile

object

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.

fsGroup

integer

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.

fsGroupChangePolicy

string

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.

runAsGroup

integer

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.

runAsNonRoot

boolean

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.

runAsUser

integer

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.

seLinuxChangePolicy

string

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.

seLinuxOptions

object

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.

seccompProfile

object

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

supplementalGroups

array (integer)

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.

supplementalGroupsPolicy

string

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.

sysctls

array

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.

sysctls[]

object

Sysctl defines a kernel parameter to be set

windowsOptions

object

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.

12.1.276. .spec.securityContext.appArmorProfile

Description
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.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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".

type

string

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.

12.1.277. .spec.securityContext.seLinuxOptions

Description
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
Type
object
Expand
PropertyTypeDescription

level

string

Level is SELinux level label that applies to the container.

role

string

Role is a SELinux role label that applies to the container.

type

string

Type is a SELinux type label that applies to the container.

user

string

User is a SELinux user label that applies to the container.

12.1.278. .spec.securityContext.seccompProfile

Description
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
  • type
Expand
PropertyTypeDescription

localhostProfile

string

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.

type

string

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.

12.1.279. .spec.securityContext.sysctls

Description
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
Type
array

12.1.280. .spec.securityContext.sysctls[]

Description
Sysctl defines a kernel parameter to be set
Type
object
Required
  • name
  • value
Expand
PropertyTypeDescription

name

string

Name of a property to set

value

string

Value of a property to set

12.1.281. .spec.securityContext.windowsOptions

Description
The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
Expand
PropertyTypeDescription

gmsaCredentialSpec

string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcess

boolean

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.

runAsUserName

string

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.

12.1.282. .spec.storage

Description
storage defines the specification of how storage shall be used.
Type
object
Expand
PropertyTypeDescription

disableMountSubPath

boolean

disableMountSubPath deprecated: subPath usage will be removed in a future release.

emptyDir

object

emptyDir 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

ephemeral

object

ephemeral 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

volumeClaimTemplate

object

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.

12.1.283. .spec.storage.emptyDir

Description
emptyDir 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
Type
object
Expand
PropertyTypeDescription

medium

string

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

sizeLimit

integer-or-string

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

12.1.284. .spec.storage.ephemeral

Description
ephemeral 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
Type
object
Expand
PropertyTypeDescription

volumeClaimTemplate

object

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.

Description

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Type
object
Required
  • spec
Expand
PropertyTypeDescription

metadata

object

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.

spec

object

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.

Description
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
Type
object
Description
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

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.

dataSourceRef

object

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.

resources

object

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

selector

object

selector is a label query over volumes to consider for binding.

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

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 or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

namespace

string

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.

Description
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
Type
object
Expand
PropertyTypeDescription

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

Description
selector is a label query over volumes to consider for binding.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

12.1.294. .spec.storage.volumeClaimTemplate

Description
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.
Type
object
Expand
PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

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

metadata

object

metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.

spec

object

spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

status

object

status is deprecated: this field is never set.

Description
metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
Type
object
Expand
PropertyTypeDescription

annotations

object (string)

annotations defines 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

labels

object (string)

labels define the 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

name

string

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

12.1.296. .spec.storage.volumeClaimTemplate.spec

Description
spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

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.

dataSourceRef

object

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.

resources

object

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

selector

object

selector is a label query over volumes to consider for binding.

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

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 or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

namespace

string

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.

Description
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
Type
object
Expand
PropertyTypeDescription

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

Description
selector is a label query over volumes to consider for binding.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

12.1.303. .spec.storage.volumeClaimTemplate.status

Description
status is deprecated: this field is never set.
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

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

allocatedResourceStatuses

object (string)

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.

allocatedResources

integer-or-string

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.

capacity

integer-or-string

capacity represents the actual resources of the underlying volume.

conditions

array

conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.

conditions[]

object

PersistentVolumeClaimCondition contains details about state of pvc

currentVolumeAttributesClassName

string

currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim

modifyVolumeStatus

object

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.

phase

string

phase represents the current phase of PersistentVolumeClaim.

Description
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
Type
array
Description
PersistentVolumeClaimCondition contains details about state of pvc
Type
object
Required
  • status
  • type
Expand
PropertyTypeDescription

lastProbeTime

string

lastProbeTime is the time we probed the condition.

lastTransitionTime

string

lastTransitionTime is the time the condition transitioned from one status to another.

message

string

message is the human-readable message indicating details about last transition.

reason

string

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.

status

string

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

type

string

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

Description
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.
Type
object
Required
  • status
Expand
PropertyTypeDescription

status

string

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.

targetVolumeAttributesClassName

string

targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled

12.1.307. .spec.tolerations

Description
tolerations defines when specified, the pod’s tolerations.
Type
array

12.1.308. .spec.tolerations[]

Description
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
Type
object
Expand
PropertyTypeDescription

effect

string

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

key

string

Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

operator

string

Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

tolerationSeconds

integer

TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

value

string

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

12.1.309. .spec.topologySpreadConstraints

Description
topologySpreadConstraints defines the pod’s topology spread constraints.
Type
array

12.1.310. .spec.topologySpreadConstraints[]

Description
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
Type
object
Required
  • maxSkew
  • topologyKey
  • whenUnsatisfiable
Expand
PropertyTypeDescription

labelSelector

object

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.

matchLabelKeys

array (string)

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).

maxSkew

integer

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.

minDomains

integer

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.

nodeAffinityPolicy

string

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.

nodeTaintsPolicy

string

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.

topologyKey

string

TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It’s a required field.

whenUnsatisfiable

string

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.

Description
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

12.1.314. .spec.tracingConfig

Description

tracingConfig defines the tracing configuration.

The configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration

This is an experimental feature, it may change in any upcoming release in a breaking way.

The operator performs no validation of the configuration.

tracingConfigFile takes precedence over this field.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.315. .spec.volumeMounts

Description
volumeMounts defines how the configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the ruler container, that are generated as a result of StorageSpec objects.
Type
array

12.1.316. .spec.volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
  • mountPath
  • name
Expand
PropertyTypeDescription

mountPath

string

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation

string

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).

name

string

This must match the Name of a Volume.

readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly

string

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.

subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

subPathExpr

string

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.

12.1.317. .spec.volumes

Description
volumes defines how 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.
Type
array

12.1.318. .spec.volumes[]

Description
Volume represents a named volume in a pod that may be accessed by any container in the pod.
Type
object
Required
  • name
Expand
PropertyTypeDescription

awsElasticBlockStore

object

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

azureDisk

object

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.

azureFile

object

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.

cephfs

object

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.

cinder

object

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

configMap

object

configMap represents a configMap that should populate this volume

csi

object

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.

downwardAPI

object

downwardAPI represents downward API about the pod that should populate this volume

emptyDir

object

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

ephemeral

object

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.

fc

object

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

flexVolume

object

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.

flocker

object

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.

gcePersistentDisk

object

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

gitRepo

object

gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.

glusterfs

object

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.

hostPath

object

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

image

object

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) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.

iscsi

object

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi

name

string

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

nfs

object

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

persistentVolumeClaim

object

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

photonPersistentDisk

object

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.

portworxVolume

object

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.

projected

object

projected items for all in one resources secrets, configmaps, and downward API

quobyte

object

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.

rbd

object

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.

scaleIO

object

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.

secret

object

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

storageos

object

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.

vsphereVolume

object

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.

12.1.319. .spec.volumes[].awsElasticBlockStore

Description
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. 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
Type
object
Required
  • volumeID
Expand
PropertyTypeDescription

fsType

string

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

partition

integer

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).

readOnly

boolean

readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

string

volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

12.1.320. .spec.volumes[].azureDisk

Description
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.
Type
object
Required
  • diskName
  • diskURI
Expand
PropertyTypeDescription

cachingMode

string

cachingMode is the Host Caching mode: None, Read Only, Read Write.

diskName

string

diskName is the Name of the data disk in the blob storage

diskURI

string

diskURI is the URI of data disk in the blob storage

fsType

string

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.

kind

string

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

readOnly

boolean

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

12.1.321. .spec.volumes[].azureFile

Description
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.
Type
object
Required
  • secretName
  • shareName
Expand
PropertyTypeDescription

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretName

string

secretName is the name of secret that contains Azure Storage Account Name and Key

shareName

string

shareName is the azure share Name

12.1.322. .spec.volumes[].cephfs

Description
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.
Type
object
Required
  • monitors
Expand
PropertyTypeDescription

monitors

array (string)

monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

string

path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /

readOnly

boolean

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

secretFile

string

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

secretRef

object

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

user

string

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

12.1.323. .spec.volumes[].cephfs.secretRef

Description
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
Type
object
Expand
PropertyTypeDescription

name

string

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

12.1.324. .spec.volumes[].cinder

Description
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
Type
object
Required
  • volumeID
Expand
PropertyTypeDescription

fsType

string

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

readOnly

boolean

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

secretRef

object

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

volumeID

string

volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

12.1.325. .spec.volumes[].cinder.secretRef

Description
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
Type
object
Expand
PropertyTypeDescription

name

string

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

12.1.326. .spec.volumes[].configMap

Description
configMap represents a configMap that should populate this volume
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

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.

items

array

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 '..'.

items[]

object

Maps a string key to a path within a volume.

name

string

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

optional

boolean

optional specify whether the ConfigMap or its keys must be defined

12.1.327. .spec.volumes[].configMap.items

Description
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 '..'.
Type
array

12.1.328. .spec.volumes[].configMap.items[]

Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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 '..'.

12.1.329. .spec.volumes[].csi

Description
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
Type
object
Required
  • driver
Expand
PropertyTypeDescription

driver

string

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.

fsType

string

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.

nodePublishSecretRef

object

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.

readOnly

boolean

readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

volumeAttributes

object (string)

volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.

12.1.330. .spec.volumes[].csi.nodePublishSecretRef

Description
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
Type
object
Expand
PropertyTypeDescription

name

string

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

12.1.331. .spec.volumes[].downwardAPI

Description
downwardAPI represents downward API about the pod that should populate this volume
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

items

array

Items is a list of downward API volume file

items[]

object

DownwardAPIVolumeFile represents information to create the file containing the pod field

12.1.332. .spec.volumes[].downwardAPI.items

Description
Items is a list of downward API volume file
Type
array

12.1.333. .spec.volumes[].downwardAPI.items[]

Description
DownwardAPIVolumeFile represents information to create the file containing the pod field
Type
object
Required
  • path
Expand
PropertyTypeDescription

fieldRef

object

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

mode

integer

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.

path

string

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 '..'

resourceFieldRef

object

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Description
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
Type
object
Required
  • fieldPath
Expand
PropertyTypeDescription

apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPath

string

Path of the field to select in the specified API version.

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
Type
object
Required
  • resource
Expand
PropertyTypeDescription

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

Specifies the output format of the exposed resources, defaults to "1"

resource

string

Required: resource to select

12.1.336. .spec.volumes[].emptyDir

Description
emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
Type
object
Expand
PropertyTypeDescription

medium

string

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

sizeLimit

integer-or-string

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

12.1.337. .spec.volumes[].ephemeral

Description

ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Type
object
Expand
PropertyTypeDescription

volumeClaimTemplate

object

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.

Description

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Type
object
Required
  • spec
Expand
PropertyTypeDescription

metadata

object

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.

spec

object

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.

Description
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
Type
object
Description
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
Type
object
Expand
PropertyTypeDescription

accessModes

array (string)

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

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.

dataSourceRef

object

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.

resources

object

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

selector

object

selector is a label query over volumes to consider for binding.

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

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 or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. 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/

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

Description
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.
Type
object
Required
  • kind
  • name
Expand
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

namespace

string

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.

Description
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
Type
object
Expand
PropertyTypeDescription

limits

integer-or-string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

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/

Description
selector is a label query over volumes to consider for binding.
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

12.1.347. .spec.volumes[].fc

Description
fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
Type
object
Expand
PropertyTypeDescription

fsType

string

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.

lun

integer

lun is Optional: FC target lun number

readOnly

boolean

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

targetWWNs

array (string)

targetWWNs is Optional: FC target worldwide names (WWNs)

wwids

array (string)

wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

12.1.348. .spec.volumes[].flexVolume

Description
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
Type
object
Required
  • driver
Expand
PropertyTypeDescription

driver

string

driver is the name of the driver to use for this volume.

fsType

string

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.

options

object (string)

options is Optional: this field holds extra command options if any.

readOnly

boolean

readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretRef

object

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.

12.1.349. .spec.volumes[].flexVolume.secretRef

Description
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.
Type
object
Expand
PropertyTypeDescription

name

string

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

12.1.350. .spec.volumes[].flocker

Description
flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
Type
object
Expand
PropertyTypeDescription

datasetName

string

datasetName is Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

datasetUUID

string

datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

12.1.351. .spec.volumes[].gcePersistentDisk

Description
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. 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
Type
object
Required
  • pdName
Expand
PropertyTypeDescription

fsType

string

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

partition

integer

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

pdName

string

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

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

12.1.352. .spec.volumes[].gitRepo

Description
gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.
Type
object
Required
  • repository
Expand
PropertyTypeDescription

directory

string

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.

repository

string

repository is the URL

revision

string

revision is the commit hash for the specified revision.

12.1.353. .spec.volumes[].glusterfs

Description
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.
Type
object
Required
  • endpoints
  • path
Expand
PropertyTypeDescription

endpoints

string

endpoints is the endpoint name that details Glusterfs topology.

path

string

path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

boolean

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

12.1.354. .spec.volumes[].hostPath

Description
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
Type
object
Required
  • path
Expand
PropertyTypeDescription

path

string

path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

12.1.355. .spec.volumes[].image

Description

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) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.

Type
object
Expand
PropertyTypeDescription

pullPolicy

string

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.

reference

string

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.

12.1.356. .spec.volumes[].iscsi

Description
iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi
Type
object
Required
  • iqn
  • lun
  • targetPortal
Expand
PropertyTypeDescription

chapAuthDiscovery

boolean

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

chapAuthSession

boolean

chapAuthSession defines whether support iSCSI Session CHAP authentication

fsType

string

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

initiatorName

string

initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.

iqn

string

iqn is the target iSCSI Qualified Name.

iscsiInterface

string

iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).

lun

integer

lun represents iSCSI Target Lun number.

portals

array (string)

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).

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

secretRef

object

secretRef is the CHAP Secret for iSCSI target and initiator authentication

targetPortal

string

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).

12.1.357. .spec.volumes[].iscsi.secretRef

Description
secretRef is the CHAP Secret for iSCSI target and initiator authentication
Type
object
Expand
PropertyTypeDescription

name

string

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

12.1.358. .spec.volumes[].nfs

Description
nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
Type
object
Required
  • path
  • server
Expand
PropertyTypeDescription

path

string

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

boolean

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

string

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

12.1.359. .spec.volumes[].persistentVolumeClaim

Description
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
Type
object
Required
  • claimName
Expand
PropertyTypeDescription

claimName

string

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

readOnly

boolean

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

12.1.360. .spec.volumes[].photonPersistentDisk

Description
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.
Type
object
Required
  • pdID
Expand
PropertyTypeDescription

fsType

string

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.

pdID

string

pdID is the ID that identifies Photon Controller persistent disk

12.1.361. .spec.volumes[].portworxVolume

Description
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.
Type
object
Required
  • volumeID
Expand
PropertyTypeDescription

fsType

string

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.

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

volumeID

string

volumeID uniquely identifies a Portworx volume

12.1.362. .spec.volumes[].projected

Description
projected items for all in one resources secrets, configmaps, and downward API
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

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.

sources

array

sources is the list of volume projections. Each entry in this list handles one source.

sources[]

object

Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.

12.1.363. .spec.volumes[].projected.sources

Description
sources is the list of volume projections. Each entry in this list handles one source.
Type
array

12.1.364. .spec.volumes[].projected.sources[]

Description
Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
Type
object
Expand
PropertyTypeDescription

clusterTrustBundle

object

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.

configMap

object

configMap information about the configMap data to project

downwardAPI

object

downwardAPI information about the downwardAPI data to project

podCertificate

object

Projects an auto-rotating credential bundle (private key and certificate chain) that the pod can use either as a TLS client or server.

Kubelet generates a private key and uses it to send a PodCertificateRequest to the named signer. Once the signer approves the request and issues a certificate chain, Kubelet writes the key and certificate chain to the pod filesystem. The pod does not start until certificates have been issued for each podCertificate projected volume source in its spec.

Kubelet will begin trying to rotate the certificate at the time indicated by the signer using the PodCertificateRequest.Status.BeginRefreshAt timestamp.

Kubelet can write a single file, indicated by the credentialBundlePath field, or separate files, indicated by the keyPath and certificateChainPath fields.

The credential bundle is a single file in PEM format. The first PEM entry is the private key (in PKCS#8 format), and the remaining PEM entries are the certificate chain issued by the signer (typically, signers will return their certificate chain in leaf-to-root order).

Prefer using the credential bundle format, since your application code can read it atomically. If you use keyPath and certificateChainPath, your application must make two separate file reads. If these coincide with a certificate rotation, it is possible that the private key and leaf certificate you read may not correspond to each other. Your application will need to check for this condition, and re-read until they are consistent.

The named signer controls chooses the format of the certificate it issues; consult the signer implementation’s documentation to learn how to use the certificates it issues.

secret

object

secret information about the secret data to project

serviceAccountToken

object

serviceAccountToken is information about the serviceAccountToken data to project

Description

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.

Type
object
Required
  • path
Expand
PropertyTypeDescription

labelSelector

object

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".

name

string

Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.

optional

boolean

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.

path

string

Relative path from the volume root to write the bundle.

signerName

string

Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

Description
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".
Type
object
Expand
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
Expand
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

Description
configMap information about the configMap data to project
Type
object
Expand
PropertyTypeDescription

items

array

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 '..'.

items[]

object

Maps a string key to a path within a volume.

name

string

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

optional

boolean

optional specify whether the ConfigMap or its keys must be defined

Description
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 '..'.
Type
array
Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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 '..'.

Description
downwardAPI information about the downwardAPI data to project
Type
object
Expand
PropertyTypeDescription

items

array

Items is a list of DownwardAPIVolume file

items[]

object

DownwardAPIVolumeFile represents information to create the file containing the pod field

Description
Items is a list of DownwardAPIVolume file
Type
array
Description
DownwardAPIVolumeFile represents information to create the file containing the pod field
Type
object
Required
  • path
Expand
PropertyTypeDescription

fieldRef

object

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

mode

integer

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.

path

string

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 '..'

resourceFieldRef

object

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Description
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
Type
object
Required
  • fieldPath
Expand
PropertyTypeDescription

apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPath

string

Path of the field to select in the specified API version.

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
Type
object
Required
  • resource
Expand
PropertyTypeDescription

containerName

string

Container name: required for volumes, optional for env vars

divisor

integer-or-string

Specifies the output format of the exposed resources, defaults to "1"

resource

string

Required: resource to select

Description

Projects an auto-rotating credential bundle (private key and certificate chain) that the pod can use either as a TLS client or server.

Kubelet generates a private key and uses it to send a PodCertificateRequest to the named signer. Once the signer approves the request and issues a certificate chain, Kubelet writes the key and certificate chain to the pod filesystem. The pod does not start until certificates have been issued for each podCertificate projected volume source in its spec.

Kubelet will begin trying to rotate the certificate at the time indicated by the signer using the PodCertificateRequest.Status.BeginRefreshAt timestamp.

Kubelet can write a single file, indicated by the credentialBundlePath field, or separate files, indicated by the keyPath and certificateChainPath fields.

The credential bundle is a single file in PEM format. The first PEM entry is the private key (in PKCS#8 format), and the remaining PEM entries are the certificate chain issued by the signer (typically, signers will return their certificate chain in leaf-to-root order).

Prefer using the credential bundle format, since your application code can read it atomically. If you use keyPath and certificateChainPath, your application must make two separate file reads. If these coincide with a certificate rotation, it is possible that the private key and leaf certificate you read may not correspond to each other. Your application will need to check for this condition, and re-read until they are consistent.

The named signer controls chooses the format of the certificate it issues; consult the signer implementation’s documentation to learn how to use the certificates it issues.

Type
object
Required
  • keyType
  • signerName
Expand
PropertyTypeDescription

certificateChainPath

string

Write the certificate chain at this path in the projected volume.

Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.

credentialBundlePath

string

Write the credential bundle at this path in the projected volume.

The credential bundle is a single file that contains multiple PEM blocks. The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private key.

The remaining blocks are CERTIFICATE blocks, containing the issued certificate chain from the signer (leaf and any intermediates).

Using credentialBundlePath lets your Pod’s application code make a single atomic read that retrieves a consistent key and certificate chain. If you project them to separate files, your application code will need to additionally check that the leaf certificate was issued to the key.

keyPath

string

Write the key at this path in the projected volume.

Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.

keyType

string

The type of keypair Kubelet will generate for the pod.

Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521", and "ED25519".

maxExpirationSeconds

integer

maxExpirationSeconds is the maximum lifetime permitted for the certificate.

Kubelet copies this value verbatim into the PodCertificateRequests it generates for this projection.

If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver will reject values shorter than 3600 (1 hour). The maximum allowable value is 7862400 (91 days).

The signer implementation is then free to issue a certificate with any lifetime shorter than MaxExpirationSeconds, but no shorter than 3600 seconds (1 hour). This constraint is enforced by kube-apiserver. kubernetes.io signers will never issue certificates with a lifetime longer than 24 hours.

signerName

string

Kubelet’s generated CSRs will be addressed to this signer.

Description
secret information about the secret data to project
Type
object
Expand
PropertyTypeDescription

items

array

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 '..'.

items[]

object

Maps a string key to a path within a volume.

name

string

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

optional

boolean

optional field specify whether the Secret or its key must be defined

Description
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 '..'.
Type
array
Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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 '..'.

Description
serviceAccountToken is information about the serviceAccountToken data to project
Type
object
Required
  • path
Expand
PropertyTypeDescription

audience

string

audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.

expirationSeconds

integer

expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

path

string

path is the path relative to the mount point of the file to project the token into.

12.1.382. .spec.volumes[].quobyte

Description
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.
Type
object
Required
  • registry
  • volume
Expand
PropertyTypeDescription

group

string

group to map volume access to Default is no group

readOnly

boolean

readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

registry

string

registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

tenant

string

tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

user

string

user to map volume access to Defaults to serivceaccount user

volume

string

volume is a string that references an already created Quobyte volume by name.

12.1.383. .spec.volumes[].rbd

Description
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.
Type
object
Required
  • image
  • monitors
Expand
PropertyTypeDescription

fsType

string

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

image

string

image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

string

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

monitors

array (string)

monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

string

pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

object

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

user

string

user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

12.1.384. .spec.volumes[].rbd.secretRef

Description
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
Type
object
Expand
PropertyTypeDescription

name

string

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

12.1.385. .spec.volumes[].scaleIO

Description
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.
Type
object
Required
  • gateway
  • secretRef
  • system
Expand
PropertyTypeDescription

fsType

string

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".

gateway

string

gateway is the host address of the ScaleIO API Gateway.

protectionDomain

string

protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

readOnly

boolean

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretRef

object

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

sslEnabled

boolean

sslEnabled Flag enable/disable SSL communication with Gateway, default false

storageMode

string

storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

storagePool

string

storagePool is the ScaleIO Storage Pool associated with the protection domain.

system

string

system is the name of the storage system as configured in ScaleIO.

volumeName

string

volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

12.1.386. .spec.volumes[].scaleIO.secretRef

Description
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
Type
object
Expand
PropertyTypeDescription

name

string

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

12.1.387. .spec.volumes[].secret

Description
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
Type
object
Expand
PropertyTypeDescription

defaultMode

integer

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.

items

array

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 '..'.

items[]

object

Maps a string key to a path within a volume.

optional

boolean

optional field specify whether the Secret or its keys must be defined

secretName

string

secretName is the name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

12.1.388. .spec.volumes[].secret.items

Description
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 '..'.
Type
array

12.1.389. .spec.volumes[].secret.items[]

Description
Maps a string key to a path within a volume.
Type
object
Required
  • key
  • path
Expand
PropertyTypeDescription

key

string

key is the key to project.

mode

integer

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.

path

string

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 '..'.

12.1.390. .spec.volumes[].storageos

Description
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.
Type
object
Expand
PropertyTypeDescription

fsType

string

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.

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

secretRef

object

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

volumeName

string

volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

volumeNamespace

string

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.

12.1.391. .spec.volumes[].storageos.secretRef

Description
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
Type
object
Expand
PropertyTypeDescription

name

string

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

12.1.392. .spec.volumes[].vsphereVolume

Description
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.
Type
object
Required
  • volumePath
Expand
PropertyTypeDescription

fsType

string

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.

storagePolicyID

string

storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

storagePolicyName

string

storagePolicyName is the storage Policy Based Management (SPBM) profile name.

volumePath

string

volumePath is the path that identifies vSphere volume vmdk

12.1.393. .spec.web

Description
web defines the configuration of the ThanosRuler web server.
Type
object
Expand
PropertyTypeDescription

httpConfig

object

httpConfig defines HTTP parameters for web server.

tlsConfig

object

tlsConfig defines the TLS parameters for HTTPS.

12.1.394. .spec.web.httpConfig

Description
httpConfig defines HTTP parameters for web server.
Type
object
Expand
PropertyTypeDescription

headers

object

headers defines a list of headers that can be added to HTTP responses.

http2

boolean

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.

12.1.395. .spec.web.httpConfig.headers

Description
headers defines a list of headers that can be added to HTTP responses.
Type
object
Expand
PropertyTypeDescription

contentSecurityPolicy

string

contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank.

strictTransportSecurity

string

strictTransportSecurity defines 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

xContentTypeOptions

string

xContentTypeOptions defines 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

xFrameOptions

string

xFrameOptions defines 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

xXSSProtection

string

xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection

12.1.396. .spec.web.tlsConfig

Description
tlsConfig defines the TLS parameters for HTTPS.
Type
object
Expand
PropertyTypeDescription

cert

object

cert defines the Secret or ConfigMap containing the TLS certificate for the web server.

Either keySecret or keyFile must be defined.

It is mutually exclusive with certFile.

certFile

string

certFile defines the 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.

cipherSuites

array (string)

cipherSuites defines the 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

clientAuthType

string

clientAuthType defines the server policy for client TLS authentication.

For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType

clientCAFile

string

clientCAFile defines the path to the CA certificate file for client certificate authentication to the server.

It is mutually exclusive with client_ca.

client_ca

object

client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server.

It is mutually exclusive with clientCAFile.

curvePreferences

array (string)

curvePreferences defines 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

keyFile

string

keyFile defines the 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.

keySecret

object

keySecret defines the secret containing the TLS private key for the web server.

Either cert or certFile must be defined.

It is mutually exclusive with keyFile.

maxVersion

string

maxVersion defines the Maximum TLS version that is acceptable.

minVersion

string

minVersion defines the minimum TLS version that is acceptable.

preferServerCipherSuites

boolean

preferServerCipherSuites defines 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.

12.1.397. .spec.web.tlsConfig.cert

Description

cert defines the Secret or ConfigMap containing the TLS certificate for the web server.

Either keySecret or keyFile must be defined.

It is mutually exclusive with certFile.

Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

12.1.398. .spec.web.tlsConfig.cert.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

12.1.399. .spec.web.tlsConfig.cert.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.400. .spec.web.tlsConfig.client_ca

Description

client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server.

It is mutually exclusive with clientCAFile.

Type
object
Expand
PropertyTypeDescription

configMap

object

configMap defines the ConfigMap containing data to use for the targets.

secret

object

secret defines the Secret containing data to use for the targets.

12.1.401. .spec.web.tlsConfig.client_ca.configMap

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key to select.

name

string

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

optional

boolean

Specify whether the ConfigMap or its key must be defined

12.1.402. .spec.web.tlsConfig.client_ca.secret

Description
secret defines the Secret containing data to use for the targets.
Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.403. .spec.web.tlsConfig.keySecret

Description

keySecret defines the secret containing the TLS private key for the web server.

Either cert or certFile must be defined.

It is mutually exclusive with keyFile.

Type
object
Required
  • key
Expand
PropertyTypeDescription

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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

optional

boolean

Specify whether the Secret or its key must be defined

12.1.404. .status

Description
status defines the most recent observed status of the ThanosRuler cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Type
object
Expand
PropertyTypeDescription

availableReplicas

integer

availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this ThanosRuler deployment.

conditions

array

conditions defines the current state of the ThanosRuler object.

conditions[]

object

Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource.

paused

boolean

paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed.

replicas

integer

replicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment (their labels match the selector).

unavailableReplicas

integer

unavailableReplicas defines the total number of unavailable pods targeted by this ThanosRuler deployment.

updatedReplicas

integer

updatedReplicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment that have the desired version spec.

12.1.405. .status.conditions

Description
conditions defines the current state of the ThanosRuler object.
Type
array

12.1.406. .status.conditions[]

Description
Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource.
Type
object
Required
  • lastTransitionTime
  • status
  • type
Expand
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime is the time of the last update to the current status property.

message

string

message defines human-readable message indicating details for the condition’s last transition.

observedGeneration

integer

observedGeneration defines 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.

reason

string

reason for the condition’s last transition.

status

string

status of the condition.

type

string

type of the condition being reported.

12.2. API endpoints

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1/thanosrulers

    • GET: list objects of kind ThanosRuler
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers

    • DELETE: delete collection of ThanosRuler
    • GET: list objects of kind ThanosRuler
    • POST: create a ThanosRuler
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers/{name}

    • DELETE: delete a ThanosRuler
    • GET: read the specified ThanosRuler
    • PATCH: partially update the specified ThanosRuler
    • PUT: replace the specified ThanosRuler
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers/{name}/status

    • GET: read status of the specified ThanosRuler
    • PATCH: partially update status of the specified ThanosRuler
    • PUT: replace status of the specified ThanosRuler
HTTP method
GET
Description
list objects of kind ThanosRuler
Expand
Table 12.1. HTTP responses
HTTP codeReponse body

200 - OK

ThanosRulerList schema

401 - Unauthorized

Empty

HTTP method
DELETE
Description
delete collection of ThanosRuler
Expand
Table 12.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind ThanosRuler
Expand
Table 12.3. HTTP responses
HTTP codeReponse body

200 - OK

ThanosRulerList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a ThanosRuler
Expand
Table 12.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 12.5. Body parameters
ParameterTypeDescription

body

ThanosRuler schema

 
Expand
Table 12.6. HTTP responses
HTTP codeReponse body

200 - OK

ThanosRuler schema

201 - Created

ThanosRuler schema

202 - Accepted

ThanosRuler schema

401 - Unauthorized

Empty

Expand
Table 12.7. Global path parameters
ParameterTypeDescription

name

string

name of the ThanosRuler

HTTP method
DELETE
Description
delete a ThanosRuler
Expand
Table 12.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 12.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified ThanosRuler
Expand
Table 12.10. HTTP responses
HTTP codeReponse body

200 - OK

ThanosRuler schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified ThanosRuler
Expand
Table 12.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 12.12. HTTP responses
HTTP codeReponse body

200 - OK

ThanosRuler schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified ThanosRuler
Expand
Table 12.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 12.14. Body parameters
ParameterTypeDescription

body

ThanosRuler schema

 
Expand
Table 12.15. HTTP responses
HTTP codeReponse body

200 - OK

ThanosRuler schema

201 - Created

ThanosRuler schema

401 - Unauthorized

Empty

Expand
Table 12.16. Global path parameters
ParameterTypeDescription

name

string

name of the ThanosRuler

HTTP method
GET
Description
read status of the specified ThanosRuler
Expand
Table 12.17. HTTP responses
HTTP codeReponse body

200 - OK

ThanosRuler schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified ThanosRuler
Expand
Table 12.18. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 12.19. HTTP responses
HTTP codeReponse body

200 - OK

ThanosRuler schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified ThanosRuler
Expand
Table 12.20. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 12.21. Body parameters
ParameterTypeDescription

body

ThanosRuler schema

 
Expand
Table 12.22. HTTP responses
HTTP codeReponse body

200 - OK

ThanosRuler schema

201 - Created

ThanosRuler schema

401 - Unauthorized

Empty

Chapter 13. NodeMetrics [metrics.k8s.io/v1beta1]

Description
NodeMetrics sets resource usage metrics of a node.
Type
object
Required
  • timestamp
  • window
  • usage

13.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

timestamp

Time

The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp].

usage

object (Quantity)

The memory usage is the memory working set.

window

Duration

 

13.2. API endpoints

The following API endpoints are available:

  • /apis/metrics.k8s.io/v1beta1/nodes

    • GET: list objects of kind NodeMetrics
  • /apis/metrics.k8s.io/v1beta1/nodes/{name}

    • GET: read the specified NodeMetrics

13.2.1. /apis/metrics.k8s.io/v1beta1/nodes

HTTP method
GET
Description
list objects of kind NodeMetrics
Expand
Table 13.1. HTTP responses
HTTP codeReponse body

200 - OK

NodeMetricsList schema

13.2.2. /apis/metrics.k8s.io/v1beta1/nodes/{name}

Expand
Table 13.2. Global path parameters
ParameterTypeDescription

name

string

name of the NodeMetrics

HTTP method
GET
Description
read the specified NodeMetrics
Expand
Table 13.3. HTTP responses
HTTP codeReponse body

200 - OK

NodeMetrics schema

Chapter 14. PodMetrics [metrics.k8s.io/v1beta1]

Description
PodMetrics sets resource usage metrics of a pod.
Type
object
Required
  • timestamp
  • window
  • containers

14.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

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

containers

array

Metrics for all containers are collected within the same time window.

containers[]

object

ContainerMetrics sets resource usage metrics of a container.

kind

string

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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

timestamp

Time

The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp].

window

Duration

 

14.1.1. .containers

Description
Metrics for all containers are collected within the same time window.
Type
array

14.1.2. .containers[]

Description
ContainerMetrics sets resource usage metrics of a container.
Type
object
Required
  • name
  • usage
Expand
PropertyTypeDescription

name

string

Container name corresponding to the one from pod.spec.containers.

usage

object (Quantity)

The memory usage is the memory working set.

14.2. API endpoints

The following API endpoints are available:

  • /apis/metrics.k8s.io/v1beta1/pods

    • GET: list objects of kind PodMetrics
  • /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods

    • GET: list objects of kind PodMetrics
  • /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods/{name}

    • GET: read the specified PodMetrics

14.2.1. /apis/metrics.k8s.io/v1beta1/pods

HTTP method
GET
Description
list objects of kind PodMetrics
Expand
Table 14.1. HTTP responses
HTTP codeReponse body

200 - OK

PodMetricsList schema

HTTP method
GET
Description
list objects of kind PodMetrics
Expand
Table 14.2. HTTP responses
HTTP codeReponse body

200 - OK

PodMetricsList schema

Expand
Table 14.3. Global path parameters
ParameterTypeDescription

name

string

name of the PodMetrics

HTTP method
GET
Description
read the specified PodMetrics
Expand
Table 14.4. HTTP responses
HTTP codeReponse body

200 - OK

PodMetrics schema

Legal Notice

Copyright © Red Hat

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of the OpenJS Foundation.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red Hat
Back to top