Monitoring APIs
Reference guide for monitoring APIs
Abstract
Chapter 1. Monitoring APIs Copy linkLink copied to clipboard!
1.1. Alertmanager [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
Alertmanagercustom 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
Alertmanagerresource, the Operator deploys aStatefulSetin 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
AlertmanagerConfigobjects should be associated to the deployed Alertmanager instances.- Type
-
object
1.2. AlertmanagerConfig [monitoring.coreos.com/v1beta1] Copy linkLink copied to clipboard!
- Description
The
AlertmanagerConfigcustom resource definition (CRD) defines howAlertmanagerobjects process Prometheus alerts. It allows to specify alert grouping and routing, notification receivers and inhibition rules.Alertmanagerobjects selectAlertmanagerConfigobjects using label and namespace selectors.- Type
-
object
1.3. AlertRelabelConfig [monitoring.openshift.io/v1] Copy linkLink copied to clipboard!
- 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] Copy linkLink copied to clipboard!
- 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] Copy linkLink copied to clipboard!
- 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] Copy linkLink copied to clipboard!
- Description
The
PodMonitorcustom resource definition (CRD) defines howPrometheusandPrometheusAgentcan 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.PrometheusandPrometheusAgentobjects selectPodMonitorobjects using label and namespace selectors.- Type
-
object
1.7. Probe [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
Probecustom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).The
Proberesource 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.PrometheusandPrometheusAgentobjects selectProbeobjects using label and namespace selectors.- Type
-
object
1.8. Prometheus [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
Prometheuscustom 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
Prometheusresource, the Operator deploys one or severalStatefulSetobjects 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,ProbeandPrometheusRuleobjects 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] Copy linkLink copied to clipboard!
- Description
The
PrometheusRulecustom 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 byPrometheusorThanosRulerobjects.PrometheusandThanosRulerobjects selectPrometheusRuleobjects using label and namespace selectors.- Type
-
object
1.10. ServiceMonitor [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
ServiceMonitorcustom resource definition (CRD) defines howPrometheusandPrometheusAgentcan 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.PrometheusandPrometheusAgentobjects selectServiceMonitorobjects using label and namespace selectors.- Type
-
object
1.11. ThanosRuler [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
ThanosRulercustom 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
ThanosRulerinstance requires at least one compatible Prometheus API endpoint (either Thanos Querier or Prometheus services).The resource defines via label and namespace selectors which
PrometheusRuleobjects should be associated to the deployed Thanos Ruler instances.- Type
-
object
1.12. NodeMetrics [metrics.k8s.io/v1beta1] Copy linkLink copied to clipboard!
- Description
- NodeMetrics sets resource usage metrics of a node.
- Type
-
object
1.13. PodMetrics [metrics.k8s.io/v1beta1] Copy linkLink copied to clipboard!
- Description
- PodMetrics sets resource usage metrics of a pod.
- Type
-
object
Chapter 2. Alertmanager [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
Alertmanagercustom 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
Alertmanagerresource, the Operator deploys aStatefulSetin 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
AlertmanagerConfigobjects should be associated to the deployed Alertmanager instances.- Type
-
object - Required
-
spec
-
2.1. Specification Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | 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. |
|
|
| Argument as part of the AdditionalArgs list. |
|
|
| additionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster. |
|
|
| affinity defines the pod’s scheduling constraints. |
|
|
| alertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects process incoming alerts. |
|
|
| alertmanagerConfigNamespaceSelector defines the namespaces to be selected for AlertmanagerConfig discovery. If nil, only check own namespace. |
|
|
| alertmanagerConfigSelector defines the selector to be used for to merge and configure Alertmanager with. |
|
|
| alertmanagerConfiguration defines the configuration of Alertmanager.
If defined, it takes precedence over the This is an experimental feature, it may change in any upcoming release in a breaking way. |
|
|
|
automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod. If the service account has |
|
|
| baseImage that is used to deploy pods, without tag. Deprecated: use 'image' instead. |
|
|
| 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 defines the interval between gossip attempts. |
|
|
|
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 |
|
|
| clusterPeerTimeout defines the timeout for cluster peering. |
|
|
| clusterPushpullInterval defines the interval between pushpull attempts. |
|
|
| clusterTLS defines the mutual TLS configuration for the Alertmanager cluster’s gossip protocol. It requires Alertmanager >= 0.24.0. |
|
|
|
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 |
|
|
|
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
The Alertmanager configuration should be available under the
If either the secret or the |
|
|
|
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: |
|
|
| A single application container that you want to run within a pod. |
|
|
| dnsConfig defines the DNS configuration for the pods. |
|
|
| dnsPolicy defines the DNS policy for the pods. |
|
|
| 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 defines whether information about services should be injected into pod’s environment variables |
|
|
| 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 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 Pods configuration |
|
|
| HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file. |
|
|
| 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 |
|
|
| 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 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 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/ |
|
|
| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. |
|
|
|
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: |
|
|
| A single application container that you want to run within a pod. |
|
|
| limits defines the limits command line flags when starting Alertmanager. |
|
|
| 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 for Alertmanager to be configured with. |
|
|
| logLevel for Alertmanager to be configured with. |
|
|
| 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 defines which Nodes the Pods are scheduled on. |
|
|
| paused if set to true all actions on the underlying managed objects are not going to be performed, except for delete actions. |
|
|
| 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 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 defines the port’s name for the pods and governing service. Defaults to |
|
|
| priorityClassName assigned to the Pods |
|
|
| 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 defines the resource requests and limits of the Pods. |
|
|
|
retention defines the time duration Alertmanager shall retain data for. Default is '120h', and must match the regular expression |
|
|
|
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 |
|
|
|
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 |
|
|
| securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext. |
|
|
| serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods. |
|
|
|
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 |
|
|
|
sha of Alertmanager container image to be deployed. Defaults to the value of |
|
|
| storage defines the definition of how storage will be used by the Alertmanager instances. |
|
|
|
tag of Alertmanager container image to be deployed. Defaults to the value of |
|
|
| 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 defines the pod’s tolerations. |
|
|
| The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. |
|
|
| topologySpreadConstraints defines the Pod’s topology spread constraints. |
|
|
| TopologySpreadConstraint specifies how to spread matching pods among the given topology. |
|
|
| version the cluster should be on. |
|
|
| volumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the alertmanager container, that are generated as a result of StorageSpec objects. |
|
|
| VolumeMount describes a mounting of a Volume within a container. |
|
|
| volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects. |
|
|
| Volume represents a named volume in a pod that may be accessed by any container in the pod. |
|
|
| web defines the web command line flags when starting Alertmanager. |
2.1.2. .spec.additionalArgs Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Argument as part of the AdditionalArgs list.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| name of the argument, e.g. "scrape.discovery-reload-interval". |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- affinity defines the pod’s scheduling constraints.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Describes node affinity scheduling rules for the pod. |
|
|
| Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
|
|
| Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |
2.1.5. .spec.affinity.nodeAffinity Copy linkLink copied to clipboard!
- Description
- Describes node affinity scheduling rules for the pod.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
|
|
| An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). |
|
|
| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
2.1.6. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
2.1.7. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
- Type
-
object - Required
-
preference -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
| A node selector term, associated with the corresponding weight. |
|
|
| Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |
2.1.8. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference Copy linkLink copied to clipboard!
- Description
- A node selector term, associated with the corresponding weight.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| A list of node selector requirements by node’s labels. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| A list of node selector requirements by node’s fields. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
2.1.9. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s labels.
- Type
-
array
2.1.10. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
2.1.11. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s fields.
- Type
-
array
2.1.12. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
2.1.13. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- Description
- If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
- Type
-
object - Required
-
nodeSelectorTerms
-
| Property | Type | Description |
|---|---|---|
|
|
| Required. A list of node selector terms. The terms are ORed. |
|
|
| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. |
2.1.14. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Copy linkLink copied to clipboard!
- Description
- Required. A list of node selector terms. The terms are ORed.
- Type
-
array
2.1.15. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] Copy linkLink copied to clipboard!
- Description
- A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| A list of node selector requirements by node’s labels. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| A list of node selector requirements by node’s fields. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
2.1.16. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s labels.
- Type
-
array
2.1.17. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
2.1.18. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s fields.
- Type
-
array
2.1.19. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
2.1.20. .spec.affinity.podAffinity Copy linkLink copied to clipboard!
- Description
- Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
|
|
| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) |
|
|
| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
|
|
| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running |
2.1.21. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
2.1.22. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- Type
-
object - Required
-
podAffinityTerm -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
| Required. A pod affinity term, associated with the corresponding weight. |
|
|
| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
2.1.23. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Copy linkLink copied to clipboard!
- Description
- Required. A pod affinity term, associated with the corresponding weight.
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
2.1.24. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.25. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.26. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.27. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.28. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.30. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
2.1.31. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
2.1.32. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.33. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.34. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.35. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.36. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.37. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.38. .spec.affinity.podAntiAffinity Copy linkLink copied to clipboard!
- Description
- Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and 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. |
|
|
| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) |
|
|
| If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
|
|
| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running |
2.1.39. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
2.1.40. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- Type
-
object - Required
-
podAffinityTerm -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
| Required. A pod affinity term, associated with the corresponding weight. |
|
|
| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
2.1.41. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Copy linkLink copied to clipboard!
- Description
- Required. A pod affinity term, associated with the corresponding weight.
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
2.1.42. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.43. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.45. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.48. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
2.1.49. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
2.1.50. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.51. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.53. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.54. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.55. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.56. .spec.alertmanagerConfigMatcherStrategy Copy linkLink copied to clipboard!
- Description
- alertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects process incoming alerts.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| type defines the strategy used by AlertmanagerConfig objects to match alerts in the routes and inhibition rules.
The default value is |
2.1.57. .spec.alertmanagerConfigNamespaceSelector Copy linkLink copied to clipboard!
- Description
- alertmanagerConfigNamespaceSelector defines the namespaces to be selected for AlertmanagerConfig discovery. If nil, only check own namespace.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.58. .spec.alertmanagerConfigNamespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.59. .spec.alertmanagerConfigNamespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.60. .spec.alertmanagerConfigSelector Copy linkLink copied to clipboard!
- Description
- alertmanagerConfigSelector defines the selector to be used for to merge and configure Alertmanager with.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.61. .spec.alertmanagerConfigSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.62. .spec.alertmanagerConfigSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.63. .spec.alertmanagerConfiguration Copy linkLink copied to clipboard!
- Description
alertmanagerConfiguration defines the configuration of Alertmanager.
If defined, it takes precedence over the
configSecretfield.This is an experimental feature, it may change in any upcoming release in a breaking way.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| global defines the global parameters of the Alertmanager configuration. |
|
|
|
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 |
|
|
| templates defines the custom notification templates. |
|
|
| SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive. |
2.1.64. .spec.alertmanagerConfiguration.global Copy linkLink copied to clipboard!
- Description
- global defines the global parameters of the Alertmanager configuration.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| httpConfig defines the default HTTP configuration. |
|
|
| jira defines the default configuration for Jira. |
|
|
| opsGenieApiKey defines the default OpsGenie API Key. |
|
|
| opsGenieApiUrl defines the default OpsGenie API URL. |
|
|
| pagerdutyUrl defines the default Pagerduty URL. |
|
|
| 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 defines the default configuration for Rocket Chat. |
|
|
| slackApiUrl defines the default Slack API URL. |
|
|
| smtp defines global SMTP parameters. |
|
|
| telegram defines the default Telegram config |
|
|
| victorops defines the default configuration for VictorOps. |
|
|
| webex defines the default configuration for Jira. |
|
|
| wechat defines the default WeChat Config |
2.1.65. .spec.alertmanagerConfiguration.global.httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the default HTTP configuration.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| authorization configures the Authorization header credentials used by the client.
Cannot be set at the same time as |
|
|
| basicAuth defines the Basic Authentication credentials used by the client.
Cannot be set at the same time as |
|
|
| 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
Deprecated: use |
|
|
| enableHttp2 can be used to disable HTTP2. |
|
|
| followRedirects defines whether the client should follow HTTP 3xx redirects. |
|
|
| 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 defines the OAuth2 settings used by the client. It requires Prometheus >= 2.27.0.
Cannot be set at the same time as |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration used by the client. |
2.1.66. .spec.alertmanagerConfiguration.global.httpConfig.authorization Copy linkLink copied to clipboard!
- Description
authorization configures the Authorization header credentials used by the client.
Cannot be set at the same time as
basicAuth,bearerTokenSecretoroauth2.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
2.1.67. .spec.alertmanagerConfiguration.global.httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.68. .spec.alertmanagerConfiguration.global.httpConfig.basicAuth Copy linkLink copied to clipboard!
- Description
basicAuth defines the Basic Authentication credentials used by the client.
Cannot be set at the same time as
authorization,bearerTokenSecretoroauth2.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
2.1.69. .spec.alertmanagerConfiguration.global.httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.70. .spec.alertmanagerConfiguration.global.httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.71. .spec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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,basicAuthoroauth2.Deprecated: use
authorizationinstead.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.72. .spec.alertmanagerConfiguration.global.httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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,basicAuthorbearerTokenSecret.- Type
-
object - Required
-
clientId -
clientSecret -
tokenUrl
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
2.1.73. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.74. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.75. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.76. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.77. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
2.1.78. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
2.1.79. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.80. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
2.1.81. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.82. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.83. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.84. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.85. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.86. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.87. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.88. .spec.alertmanagerConfiguration.global.httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
2.1.89. .spec.alertmanagerConfiguration.global.httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
2.1.90. .spec.alertmanagerConfiguration.global.httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.91. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration used by the client.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
2.1.92. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.93. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.94. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.95. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.96. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.97. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.98. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.99. .spec.alertmanagerConfiguration.global.jira Copy linkLink copied to clipboard!
- Description
- jira defines the default configuration for Jira.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| apiURL defines the default Jira API URL. It requires Alertmanager >= v0.28.0. |
2.1.100. .spec.alertmanagerConfiguration.global.opsGenieApiKey Copy linkLink copied to clipboard!
- Description
- opsGenieApiKey defines the default OpsGenie API Key.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.101. .spec.alertmanagerConfiguration.global.opsGenieApiUrl Copy linkLink copied to clipboard!
- Description
- opsGenieApiUrl defines the default OpsGenie API URL.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.102. .spec.alertmanagerConfiguration.global.rocketChat Copy linkLink copied to clipboard!
- Description
- rocketChat defines the default configuration for Rocket Chat.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| apiURL defines the default Rocket Chat API URL. It requires Alertmanager >= v0.28.0. |
|
|
| token defines the default Rocket Chat token. It requires Alertmanager >= v0.28.0. |
|
|
| tokenID defines the default Rocket Chat Token ID. It requires Alertmanager >= v0.28.0. |
2.1.103. .spec.alertmanagerConfiguration.global.rocketChat.token Copy linkLink copied to clipboard!
- Description
token defines the default Rocket Chat token.
It requires Alertmanager >= v0.28.0.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.104. .spec.alertmanagerConfiguration.global.rocketChat.tokenID Copy linkLink copied to clipboard!
- Description
tokenID defines the default Rocket Chat Token ID.
It requires Alertmanager >= v0.28.0.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.105. .spec.alertmanagerConfiguration.global.slackApiUrl Copy linkLink copied to clipboard!
- Description
- slackApiUrl defines the default Slack API URL.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.106. .spec.alertmanagerConfiguration.global.smtp Copy linkLink copied to clipboard!
- Description
- smtp defines global SMTP parameters.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| authIdentity represents SMTP Auth using PLAIN |
|
|
| authPassword represents SMTP Auth using LOGIN and PLAIN. |
|
|
| authSecret represents SMTP Auth using CRAM-MD5. |
|
|
| authUsername represents SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn’t authenticate to the SMTP server. |
|
|
| from defines the default SMTP From header field. |
|
|
| hello defines the default hostname to identify to the SMTP server. |
|
|
| requireTLS defines the default SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints. |
|
|
| smartHost defines the default SMTP smarthost used for sending emails. |
|
|
| tlsConfig defines the default TLS configuration for SMTP receivers |
2.1.107. .spec.alertmanagerConfiguration.global.smtp.authPassword Copy linkLink copied to clipboard!
- Description
- authPassword represents SMTP Auth using LOGIN and PLAIN.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.108. .spec.alertmanagerConfiguration.global.smtp.authSecret Copy linkLink copied to clipboard!
- Description
- authSecret represents SMTP Auth using CRAM-MD5.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.109. .spec.alertmanagerConfiguration.global.smtp.smartHost Copy linkLink copied to clipboard!
- Description
- smartHost defines the default SMTP smarthost used for sending emails.
- Type
-
object - Required
-
host -
port
-
| Property | Type | Description |
|---|---|---|
|
|
| host defines the host’s address, it can be a DNS name or a literal IP address. |
|
|
| port defines the host’s port, it can be a literal port number or a port name. |
2.1.110. .spec.alertmanagerConfiguration.global.smtp.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the default TLS configuration for SMTP receivers
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
2.1.111. .spec.alertmanagerConfiguration.global.smtp.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.112. .spec.alertmanagerConfiguration.global.smtp.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.113. .spec.alertmanagerConfiguration.global.smtp.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.114. .spec.alertmanagerConfiguration.global.smtp.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.115. .spec.alertmanagerConfiguration.global.smtp.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.116. .spec.alertmanagerConfiguration.global.smtp.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.117. .spec.alertmanagerConfiguration.global.smtp.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.118. .spec.alertmanagerConfiguration.global.telegram Copy linkLink copied to clipboard!
- Description
- telegram defines the default Telegram config
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| apiURL defines he default Telegram API URL. It requires Alertmanager >= v0.24.0. |
2.1.119. .spec.alertmanagerConfiguration.global.victorops Copy linkLink copied to clipboard!
- Description
- victorops defines the default configuration for VictorOps.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| apiKey defines the default VictorOps API Key. |
|
|
| apiURL defines the default VictorOps API URL. |
2.1.120. .spec.alertmanagerConfiguration.global.victorops.apiKey Copy linkLink copied to clipboard!
- Description
- apiKey defines the default VictorOps API Key.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.121. .spec.alertmanagerConfiguration.global.webex Copy linkLink copied to clipboard!
- Description
- webex defines the default configuration for Jira.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| apiURL defines the is the default Webex API URL. It requires Alertmanager >= v0.25.0. |
2.1.122. .spec.alertmanagerConfiguration.global.wechat Copy linkLink copied to clipboard!
- Description
- wechat defines the default WeChat Config
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| apiCorpID defines the default WeChat API Corporate ID. |
|
|
| apiSecret defines the default WeChat API Secret. |
|
|
| apiURL defines he default WeChat API URL. The default value is "https://qyapi.weixin.qq.com/cgi-bin/" |
2.1.123. .spec.alertmanagerConfiguration.global.wechat.apiSecret Copy linkLink copied to clipboard!
- Description
- apiSecret defines the default WeChat API Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.124. .spec.alertmanagerConfiguration.templates Copy linkLink copied to clipboard!
- Description
- templates defines the custom notification templates.
- Type
-
array
2.1.125. .spec.alertmanagerConfiguration.templates[] Copy linkLink copied to clipboard!
- Description
- SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.126. .spec.alertmanagerConfiguration.templates[].configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.127. .spec.alertmanagerConfiguration.templates[].secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.128. .spec.clusterTLS Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| client defines the client-side configuration for mutual TLS. |
|
|
| server defines the server-side configuration for mutual TLS. |
2.1.129. .spec.clusterTLS.client Copy linkLink copied to clipboard!
- Description
- client defines the client-side configuration for mutual TLS.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
2.1.130. .spec.clusterTLS.client.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.131. .spec.clusterTLS.client.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.132. .spec.clusterTLS.client.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.133. .spec.clusterTLS.client.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.134. .spec.clusterTLS.client.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.135. .spec.clusterTLS.client.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.136. .spec.clusterTLS.client.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.137. .spec.clusterTLS.server Copy linkLink copied to clipboard!
- Description
- server defines the server-side configuration for mutual TLS.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| cert defines the Secret or ConfigMap containing the TLS certificate for the web server.
Either
It is mutually exclusive with |
|
|
| certFile defines the path to the TLS certificate file in the container for the web server.
Either
It is mutually exclusive with |
|
|
| 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 defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType |
|
|
| clientCAFile defines the path to the CA certificate file for client certificate authentication to the server.
It is mutually exclusive with |
|
|
| client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server.
It is mutually exclusive with |
|
|
| 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 defines the path to the TLS private key file in the container for the web server.
If defined, either
It is mutually exclusive with |
|
|
| keySecret defines the secret containing the TLS private key for the web server.
Either
It is mutually exclusive with |
|
|
| maxVersion defines the Maximum TLS version that is acceptable. |
|
|
| minVersion defines the minimum TLS version that is acceptable. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
cert defines the Secret or ConfigMap containing the TLS certificate for the web server.
Either
keySecretorkeyFilemust be defined.It is mutually exclusive with
certFile.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.139. .spec.clusterTLS.server.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.140. .spec.clusterTLS.server.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.141. .spec.clusterTLS.server.client_ca Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.142. .spec.clusterTLS.server.client_ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.143. .spec.clusterTLS.server.client_ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.144. .spec.clusterTLS.server.keySecret Copy linkLink copied to clipboard!
- Description
keySecret defines the secret containing the TLS private key for the web server.
Either
certorcertFilemust be defined.It is mutually exclusive with
keyFile.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.145. .spec.containers Copy linkLink copied to clipboard!
- 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:
alertmanagerandconfig-reloader. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. - Type
-
array
2.1.146. .spec.containers[] Copy linkLink copied to clipboard!
- Description
- A single application container that you want to run within a pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Arguments to the entrypoint. The 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 |
|
|
| 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 |
|
|
| List of environment variables to set in the container. Cannot be updated. |
|
|
| EnvVar represents an environment variable present in a Container. |
|
|
| List of sources to populate environment variables in the container. The keys defined within a source 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. |
|
|
| EnvFromSource represents the source of a set of ConfigMaps or Secrets |
|
|
| 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. |
|
|
| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
|
| Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
|
|
| Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
|
|
| List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. |
|
|
| ContainerPort represents a network port in a single container. |
|
|
| 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 |
|
|
| Resources resize policy for the container. |
|
|
| ContainerResizePolicy represents resource resize policy for the container. |
|
|
| Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| 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. |
|
|
| 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. |
|
|
| ContainerRestartRule describes how a container exit is handled. |
|
|
| SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
|
|
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
|
|
| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
|
|
| Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
|
|
| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
|
|
| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
|
| volumeDevices is the list of block devices to be used by the container. |
|
|
| volumeDevice describes a mapping of a raw block device within a container. |
|
|
| Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
| VolumeMount describes a mounting of a Volume within a container. |
|
|
| Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. |
2.1.147. .spec.containers[].env Copy linkLink copied to clipboard!
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
-
array
2.1.148. .spec.containers[].env[] Copy linkLink copied to clipboard!
- Description
- EnvVar represents an environment variable present in a Container.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the environment variable. May consist of any printable ASCII characters except '='. |
|
|
| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
|
|
| Source for the environment variable’s value. Cannot be used if value is not empty. |
2.1.149. .spec.containers[].env[].valueFrom Copy linkLink copied to clipboard!
- Description
- Source for the environment variable’s value. Cannot be used if value is not empty.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Selects a key of a ConfigMap. |
|
|
|
Selects a field of the pod: supports metadata.name, metadata.namespace, |
|
|
| FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled. |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
| Selects a key of a secret in the pod’s namespace |
2.1.150. .spec.containers[].env[].valueFrom.configMapKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a ConfigMap.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.151. .spec.containers[].env[].valueFrom.fieldRef Copy linkLink copied to clipboard!
- Description
-
Selects a field of the pod: supports metadata.name, metadata.namespace,
metadata.labels['<KEY>'],metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
2.1.152. .spec.containers[].env[].valueFrom.fileKeyRef Copy linkLink copied to clipboard!
- Description
- FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
- Type
-
object - Required
-
key -
path -
volumeName
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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. |
|
|
| The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'. |
|
|
| The name of the volume mount containing the env file. |
2.1.153. .spec.containers[].env[].valueFrom.resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
2.1.154. .spec.containers[].env[].valueFrom.secretKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a secret in the pod’s namespace
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.155. .spec.containers[].envFrom Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- EnvFromSource represents the source of a set of ConfigMaps or Secrets
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The ConfigMap to select from |
|
|
| Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='. |
|
|
| The Secret to select from |
2.1.157. .spec.containers[].envFrom[].configMapRef Copy linkLink copied to clipboard!
- Description
- The ConfigMap to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap must be defined |
2.1.158. .spec.containers[].envFrom[].secretRef Copy linkLink copied to clipboard!
- Description
- The Secret to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret must be defined |
2.1.159. .spec.containers[].lifecycle Copy linkLink copied to clipboard!
- Description
- Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
|
|
| PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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 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 Copy linkLink copied to clipboard!
- Description
- PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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.161. .spec.containers[].lifecycle.postStart.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
2.1.162. .spec.containers[].lifecycle.postStart.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
2.1.163. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
2.1.164. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
2.1.165. .spec.containers[].lifecycle.postStart.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
2.1.166. .spec.containers[].lifecycle.postStart.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
2.1.167. .spec.containers[].lifecycle.preStop Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
2.1.169. .spec.containers[].lifecycle.preStop.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
2.1.170. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
2.1.171. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
2.1.172. .spec.containers[].lifecycle.preStop.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
2.1.173. .spec.containers[].lifecycle.preStop.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
2.1.174. .spec.containers[].livenessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
2.1.175. .spec.containers[].livenessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
2.1.176. .spec.containers[].livenessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
2.1.178. .spec.containers[].livenessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
2.1.179. .spec.containers[].livenessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
2.1.180. .spec.containers[].livenessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
2.1.181. .spec.containers[].ports Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ContainerPort represents a network port in a single container.
- Type
-
object - Required
-
containerPort
-
| Property | Type | Description |
|---|---|---|
|
|
| Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
|
|
| What host IP to bind the external port to. |
|
|
| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. |
|
|
| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
|
|
| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |
2.1.183. .spec.containers[].readinessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
2.1.184. .spec.containers[].readinessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
2.1.185. .spec.containers[].readinessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
2.1.187. .spec.containers[].readinessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
2.1.188. .spec.containers[].readinessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
2.1.189. .spec.containers[].readinessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
2.1.190. .spec.containers[].resizePolicy Copy linkLink copied to clipboard!
- Description
- Resources resize policy for the container.
- Type
-
array
2.1.191. .spec.containers[].resizePolicy[] Copy linkLink copied to clipboard!
- Description
- ContainerResizePolicy represents resource resize policy for the container.
- Type
-
object - Required
-
resourceName -
restartPolicy
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. |
|
|
| Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. |
2.1.192. .spec.containers[].resources Copy linkLink copied to clipboard!
- Description
- Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| ResourceClaim references one entry in PodSpec.ResourceClaims. |
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
2.1.193. .spec.containers[].resources.claims Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ContainerRestartRule describes how a container exit is handled.
- Type
-
object - Required
-
action
-
| Property | Type | Description |
|---|---|---|
|
|
| Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container. |
|
|
| Represents the exit codes to check on container exits. |
2.1.197. .spec.containers[].restartPolicyRules[].exitCodes Copy linkLink copied to clipboard!
- Description
- Represents the exit codes to check on container exits.
- Type
-
object - Required
-
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| Specifies the set of values to check for container exit codes. At most 255 elements are allowed. |
2.1.198. .spec.containers[].securityContext Copy linkLink copied to clipboard!
- Description
- SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
2.1.199. .spec.containers[].securityContext.appArmorProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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.200. .spec.containers[].securityContext.capabilities Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Added capabilities |
|
|
| Removed capabilities |
2.1.201. .spec.containers[].securityContext.seLinuxOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Level is SELinux level label that applies to the container. |
|
|
| Role is a SELinux role label that applies to the container. |
|
|
| Type is a SELinux type label that applies to the container. |
|
|
| User is a SELinux user label that applies to the container. |
2.1.202. .spec.containers[].securityContext.seccompProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. |
|
|
| type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
2.1.203. .spec.containers[].securityContext.windowsOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
| GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
| HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
|
|
| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
2.1.204. .spec.containers[].startupProbe Copy linkLink copied to clipboard!
- Description
- StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
2.1.205. .spec.containers[].startupProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
2.1.206. .spec.containers[].startupProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
2.1.208. .spec.containers[].startupProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
2.1.209. .spec.containers[].startupProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
2.1.210. .spec.containers[].startupProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
2.1.211. .spec.containers[].volumeDevices Copy linkLink copied to clipboard!
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
-
array
2.1.212. .spec.containers[].volumeDevices[] Copy linkLink copied to clipboard!
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
-
object - Required
-
devicePath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| devicePath is the path inside of the container that the device will be mapped to. |
|
|
| name must match the name of a persistentVolumeClaim in the pod |
2.1.213. .spec.containers[].volumeMounts Copy linkLink copied to clipboard!
- Description
- Pod volumes to mount into the container’s filesystem. Cannot be updated.
- Type
-
array
2.1.214. .spec.containers[].volumeMounts[] Copy linkLink copied to clipboard!
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). |
|
|
| This must match the Name of a Volume. |
|
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
| 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. |
|
|
| Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
| Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
2.1.215. .spec.dnsConfig Copy linkLink copied to clipboard!
- Description
- dnsConfig defines the DNS configuration for the pods.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. |
|
|
| 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. |
|
|
| PodDNSConfigOption defines DNS resolver options of a pod. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- PodDNSConfigOption defines DNS resolver options of a pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| name is required and must be unique. |
|
|
| value is optional. |
2.1.218. .spec.hostAliases Copy linkLink copied to clipboard!
- Description
- hostAliases Pods configuration
- Type
-
array
2.1.219. .spec.hostAliases[] Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| hostnames defines hostnames for the above IP address. |
|
|
| ip defines the IP address of the host file entry. |
2.1.220. .spec.imagePullSecrets Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- A single application container that you want to run within a pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Arguments to the entrypoint. The 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 |
|
|
| 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 |
|
|
| List of environment variables to set in the container. Cannot be updated. |
|
|
| EnvVar represents an environment variable present in a Container. |
|
|
| List of sources to populate environment variables in the container. The keys defined within a source 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. |
|
|
| EnvFromSource represents the source of a set of ConfigMaps or Secrets |
|
|
| 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. |
|
|
| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
|
| Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
|
|
| Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
|
|
| List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. |
|
|
| ContainerPort represents a network port in a single container. |
|
|
| 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 |
|
|
| Resources resize policy for the container. |
|
|
| ContainerResizePolicy represents resource resize policy for the container. |
|
|
| Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| 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. |
|
|
| 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. |
|
|
| ContainerRestartRule describes how a container exit is handled. |
|
|
| SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
|
|
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
|
|
| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
|
|
| Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
|
|
| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
|
|
| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
|
| volumeDevices is the list of block devices to be used by the container. |
|
|
| volumeDevice describes a mapping of a raw block device within a container. |
|
|
| Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
| VolumeMount describes a mounting of a Volume within a container. |
|
|
| Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. |
2.1.224. .spec.initContainers[].env Copy linkLink copied to clipboard!
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
-
array
2.1.225. .spec.initContainers[].env[] Copy linkLink copied to clipboard!
- Description
- EnvVar represents an environment variable present in a Container.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the environment variable. May consist of any printable ASCII characters except '='. |
|
|
| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
|
|
| Source for the environment variable’s value. Cannot be used if value is not empty. |
2.1.226. .spec.initContainers[].env[].valueFrom Copy linkLink copied to clipboard!
- Description
- Source for the environment variable’s value. Cannot be used if value is not empty.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Selects a key of a ConfigMap. |
|
|
|
Selects a field of the pod: supports metadata.name, metadata.namespace, |
|
|
| FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled. |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
| Selects a key of a secret in the pod’s namespace |
2.1.227. .spec.initContainers[].env[].valueFrom.configMapKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a ConfigMap.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.228. .spec.initContainers[].env[].valueFrom.fieldRef Copy linkLink copied to clipboard!
- Description
-
Selects a field of the pod: supports metadata.name, metadata.namespace,
metadata.labels['<KEY>'],metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
2.1.229. .spec.initContainers[].env[].valueFrom.fileKeyRef Copy linkLink copied to clipboard!
- Description
- FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
- Type
-
object - Required
-
key -
path -
volumeName
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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. |
|
|
| The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'. |
|
|
| The name of the volume mount containing the env file. |
2.1.230. .spec.initContainers[].env[].valueFrom.resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
2.1.231. .spec.initContainers[].env[].valueFrom.secretKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a secret in the pod’s namespace
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.232. .spec.initContainers[].envFrom Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- EnvFromSource represents the source of a set of ConfigMaps or Secrets
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The ConfigMap to select from |
|
|
| Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='. |
|
|
| The Secret to select from |
2.1.234. .spec.initContainers[].envFrom[].configMapRef Copy linkLink copied to clipboard!
- Description
- The ConfigMap to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap must be defined |
2.1.235. .spec.initContainers[].envFrom[].secretRef Copy linkLink copied to clipboard!
- Description
- The Secret to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret must be defined |
2.1.236. .spec.initContainers[].lifecycle Copy linkLink copied to clipboard!
- Description
- Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
|
|
| PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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 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.237. .spec.initContainers[].lifecycle.postStart Copy linkLink copied to clipboard!
- Description
- PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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.238. .spec.initContainers[].lifecycle.postStart.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
2.1.239. .spec.initContainers[].lifecycle.postStart.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
2.1.240. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
2.1.241. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
2.1.242. .spec.initContainers[].lifecycle.postStart.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
2.1.243. .spec.initContainers[].lifecycle.postStart.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
2.1.244. .spec.initContainers[].lifecycle.preStop Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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.245. .spec.initContainers[].lifecycle.preStop.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
2.1.246. .spec.initContainers[].lifecycle.preStop.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
2.1.247. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
2.1.248. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
2.1.249. .spec.initContainers[].lifecycle.preStop.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
2.1.250. .spec.initContainers[].lifecycle.preStop.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
2.1.251. .spec.initContainers[].livenessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
2.1.252. .spec.initContainers[].livenessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
2.1.253. .spec.initContainers[].livenessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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.254. .spec.initContainers[].livenessProbe.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
2.1.255. .spec.initContainers[].livenessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
2.1.256. .spec.initContainers[].livenessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
2.1.257. .spec.initContainers[].livenessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
2.1.258. .spec.initContainers[].ports Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ContainerPort represents a network port in a single container.
- Type
-
object - Required
-
containerPort
-
| Property | Type | Description |
|---|---|---|
|
|
| Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
|
|
| What host IP to bind the external port to. |
|
|
| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. |
|
|
| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
|
|
| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |
2.1.260. .spec.initContainers[].readinessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
2.1.261. .spec.initContainers[].readinessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
2.1.262. .spec.initContainers[].readinessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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.263. .spec.initContainers[].readinessProbe.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
2.1.264. .spec.initContainers[].readinessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
2.1.265. .spec.initContainers[].readinessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
2.1.266. .spec.initContainers[].readinessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
2.1.267. .spec.initContainers[].resizePolicy Copy linkLink copied to clipboard!
- Description
- Resources resize policy for the container.
- Type
-
array
2.1.268. .spec.initContainers[].resizePolicy[] Copy linkLink copied to clipboard!
- Description
- ContainerResizePolicy represents resource resize policy for the container.
- Type
-
object - Required
-
resourceName -
restartPolicy
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. |
|
|
| Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. |
2.1.269. .spec.initContainers[].resources Copy linkLink copied to clipboard!
- Description
- Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| ResourceClaim references one entry in PodSpec.ResourceClaims. |
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
2.1.270. .spec.initContainers[].resources.claims Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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.273. .spec.initContainers[].restartPolicyRules[] Copy linkLink copied to clipboard!
- Description
- ContainerRestartRule describes how a container exit is handled.
- Type
-
object - Required
-
action
-
| Property | Type | Description |
|---|---|---|
|
|
| Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container. |
|
|
| Represents the exit codes to check on container exits. |
2.1.274. .spec.initContainers[].restartPolicyRules[].exitCodes Copy linkLink copied to clipboard!
- Description
- Represents the exit codes to check on container exits.
- Type
-
object - Required
-
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| Specifies the set of values to check for container exit codes. At most 255 elements are allowed. |
2.1.275. .spec.initContainers[].securityContext Copy linkLink copied to clipboard!
- Description
- SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
2.1.276. .spec.initContainers[].securityContext.appArmorProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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.277. .spec.initContainers[].securityContext.capabilities Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Added capabilities |
|
|
| Removed capabilities |
2.1.278. .spec.initContainers[].securityContext.seLinuxOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Level is SELinux level label that applies to the container. |
|
|
| Role is a SELinux role label that applies to the container. |
|
|
| Type is a SELinux type label that applies to the container. |
|
|
| User is a SELinux user label that applies to the container. |
2.1.279. .spec.initContainers[].securityContext.seccompProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. |
|
|
| type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
2.1.280. .spec.initContainers[].securityContext.windowsOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
| GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
| HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
|
|
| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
2.1.281. .spec.initContainers[].startupProbe Copy linkLink copied to clipboard!
- Description
- StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
2.1.282. .spec.initContainers[].startupProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
2.1.283. .spec.initContainers[].startupProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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.284. .spec.initContainers[].startupProbe.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
2.1.285. .spec.initContainers[].startupProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
2.1.286. .spec.initContainers[].startupProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
2.1.287. .spec.initContainers[].startupProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
2.1.288. .spec.initContainers[].volumeDevices Copy linkLink copied to clipboard!
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
-
array
2.1.289. .spec.initContainers[].volumeDevices[] Copy linkLink copied to clipboard!
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
-
object - Required
-
devicePath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| devicePath is the path inside of the container that the device will be mapped to. |
|
|
| name must match the name of a persistentVolumeClaim in the pod |
2.1.290. .spec.initContainers[].volumeMounts Copy linkLink copied to clipboard!
- Description
- Pod volumes to mount into the container’s filesystem. Cannot be updated.
- Type
-
array
2.1.291. .spec.initContainers[].volumeMounts[] Copy linkLink copied to clipboard!
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). |
|
|
| This must match the Name of a Volume. |
|
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
| 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. |
|
|
| Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
| Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
2.1.292. .spec.limits Copy linkLink copied to clipboard!
- Description
- limits defines the limits command line flags when starting Alertmanager.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
maxPerSilenceBytes defines the maximum size of an individual silence as stored on disk. This corresponds to the Alertmanager’s |
|
|
|
maxSilences defines the maximum number active and pending silences. This corresponds to the Alertmanager’s |
2.1.293. .spec.persistentVolumeClaimRetentionPolicy Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
|
WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of |
|
|
|
WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of |
2.1.294. .spec.podMetadata Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 Copy linkLink copied to clipboard!
- Description
- resources defines the resource requests and limits of the Pods.
- Type
-
object
| Property | Type | 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. |
|
|
| ResourceClaim references one entry in PodSpec.ResourceClaims. |
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
2.1.296. .spec.resources.claims Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- Description
- securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
- Type
-
object
| Property | Type | 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. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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 hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows. |
|
|
| Sysctl defines a kernel parameter to be set |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Level is SELinux level label that applies to the container. |
|
|
| Role is a SELinux role label that applies to the container. |
|
|
| Type is a SELinux type label that applies to the container. |
|
|
| User is a SELinux user label that applies to the container. |
2.1.301. .spec.securityContext.seccompProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. |
|
|
| type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
2.1.302. .spec.securityContext.sysctls Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Sysctl defines a kernel parameter to be set
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of a property to set |
|
|
| Value of a property to set |
2.1.304. .spec.securityContext.windowsOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
| GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
| HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
|
|
| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
2.1.305. .spec.storage Copy linkLink copied to clipboard!
- Description
- storage defines the definition of how storage will be used by the Alertmanager instances.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| disableMountSubPath deprecated: subPath usage will be removed in a future release. |
|
|
|
emptyDir to be used by the StatefulSet. If specified, it takes precedence over |
|
|
| 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 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 Copy linkLink copied to clipboard!
- Description
-
emptyDir to be used by the StatefulSet. If specified, it takes precedence over
ephemeralandvolumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
|
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be 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. |
2.1.308. .spec.storage.ephemeral.volumeClaimTemplate Copy linkLink copied to clipboard!
- Description
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be
<pod name>-<volume name>where<volume name>is the name from thePodSpec.Volumesarray entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
- Type
-
object - Required
-
spec
-
| Property | Type | Description |
|---|---|---|
|
|
| May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. |
|
|
| The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. |
2.1.309. .spec.storage.ephemeral.volumeClaimTemplate.metadata Copy linkLink copied to clipboard!
- 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
2.1.310. .spec.storage.ephemeral.volumeClaimTemplate.spec Copy linkLink copied to clipboard!
- Description
- The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
| 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 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 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 is a label query over volumes to consider for binding. |
|
|
| storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| 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 defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
| volumeName is the binding reference to the PersistentVolume backing this claim. |
2.1.311. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
2.1.312. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
|
|
| 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. |
2.1.313. .spec.storage.ephemeral.volumeClaimTemplate.spec.resources Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
2.1.314. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector Copy linkLink copied to clipboard!
- Description
- selector is a label query over volumes to consider for binding.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.315. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.316. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.317. .spec.storage.volumeClaimTemplate Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. |
|
|
| 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 is deprecated: this field is never set. |
2.1.318. .spec.storage.volumeClaimTemplate.metadata Copy linkLink copied to clipboard!
- Description
- metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
| 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 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 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 is a label query over volumes to consider for binding. |
|
|
| storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| 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 defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
| volumeName is the binding reference to the PersistentVolume backing this claim. |
2.1.320. .spec.storage.volumeClaimTemplate.spec.dataSource Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
2.1.321. .spec.storage.volumeClaimTemplate.spec.dataSourceRef Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
|
|
| 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. |
2.1.322. .spec.storage.volumeClaimTemplate.spec.resources Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
2.1.323. .spec.storage.volumeClaimTemplate.spec.selector Copy linkLink copied to clipboard!
- Description
- selector is a label query over volumes to consider for binding.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.324. .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.325. .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.326. .spec.storage.volumeClaimTemplate.status Copy linkLink copied to clipboard!
- Description
- status is deprecated: this field is never set.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 represents the actual resources of the underlying volume. |
|
|
| conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'. |
|
|
| PersistentVolumeClaimCondition contains details about state of pvc |
|
|
| currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim |
|
|
| ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. |
|
|
| phase represents the current phase of PersistentVolumeClaim. |
2.1.327. .spec.storage.volumeClaimTemplate.status.conditions Copy linkLink copied to clipboard!
- 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
2.1.328. .spec.storage.volumeClaimTemplate.status.conditions[] Copy linkLink copied to clipboard!
- Description
- PersistentVolumeClaimCondition contains details about state of pvc
- Type
-
object - Required
-
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastProbeTime is the time we probed the condition. |
|
|
| lastTransitionTime is the time the condition transitioned from one status to another. |
|
|
| message is the human-readable message indicating details about last transition. |
|
|
| 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 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 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 |
2.1.329. .spec.storage.volumeClaimTemplate.status.modifyVolumeStatus Copy linkLink copied to clipboard!
- Description
- ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.
- Type
-
object - Required
-
status
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the name of the VolumeAttributesClass the PVC currently being reconciled |
2.1.330. .spec.tolerations Copy linkLink copied to clipboard!
- Description
- tolerations defines the pod’s tolerations.
- Type
-
array
2.1.331. .spec.tolerations[] Copy linkLink copied to clipboard!
- Description
- The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
|
|
| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
|
|
| Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
|
|
| TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
|
|
| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
2.1.332. .spec.topologySpreadConstraints Copy linkLink copied to clipboard!
- Description
- topologySpreadConstraints defines the Pod’s topology spread constraints.
- Type
-
array
2.1.333. .spec.topologySpreadConstraints[] Copy linkLink copied to clipboard!
- Description
- TopologySpreadConstraint specifies how to spread matching pods among the given topology.
- Type
-
object - Required
-
maxSkew -
topologyKey -
whenUnsatisfiable
-
| Property | Type | Description |
|---|---|---|
|
|
| LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. |
|
|
| 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 describes the degree to which pods may be unevenly distributed. When |
|
|
| 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 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 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 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 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. |
2.1.334. .spec.topologySpreadConstraints[].labelSelector Copy linkLink copied to clipboard!
- Description
- LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.335. .spec.topologySpreadConstraints[].labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.336. .spec.topologySpreadConstraints[].labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.337. .spec.volumeMounts Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). |
|
|
| This must match the Name of a Volume. |
|
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
| 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. |
|
|
| Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
| Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
2.1.339. .spec.volumes Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Volume represents a named volume in a pod that may be accessed by any container in the pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. 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 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 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 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 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 represents a configMap that should populate this volume |
|
|
| csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers. |
|
|
| downwardAPI represents downward API about the pod that should populate this volume |
|
|
| emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
|
| ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. |
|
|
| fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
|
|
| flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. |
|
|
| 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 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 represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container. |
|
|
| glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. |
|
|
| 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 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 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 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 represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
| photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. |
|
|
| 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 items for all in one resources secrets, configmaps, and downward API |
|
|
| quobyte represents a Quobyte mount on the host that shares a pod’s lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. |
|
|
| 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 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 represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
|
| storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| cachingMode is the Host Caching mode: None, Read Only, Read Write. |
|
|
| diskName is the Name of the data disk in the blob storage |
|
|
| diskURI is the URI of data disk in the blob storage |
|
|
| 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 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 Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
2.1.343. .spec.volumes[].azureFile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| secretName is the name of secret that contains Azure Storage Account Name and Key |
|
|
| shareName is the azure share Name |
2.1.344. .spec.volumes[].cephfs Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
|
|
| 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 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 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 is optional: points to a secret object containing parameters used to connect to OpenStack. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- configMap represents a configMap that should populate this volume
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| optional specify whether the ConfigMap or its keys must be defined |
2.1.349. .spec.volumes[].configMap.items Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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 Copy linkLink copied to clipboard!
- Description
- csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
- Type
-
object - Required
-
driver
-
| Property | Type | Description |
|---|---|---|
|
|
| driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. |
|
|
| 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 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 specifies a read-only configuration for the volume. Defaults to false (read/write). |
|
|
| volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values. |
2.1.352. .spec.volumes[].csi.nodePublishSecretRef Copy linkLink copied to clipboard!
- Description
- nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- downwardAPI represents downward API about the pod that should populate this volume
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
| Items is a list of downward API volume file |
|
|
| DownwardAPIVolumeFile represents information to create the file containing the pod field |
2.1.354. .spec.volumes[].downwardAPI.items Copy linkLink copied to clipboard!
- Description
- Items is a list of downward API volume file
- Type
-
array
2.1.355. .spec.volumes[].downwardAPI.items[] Copy linkLink copied to clipboard!
- Description
- DownwardAPIVolumeFile represents information to create the file containing the pod field
- Type
-
object - Required
-
path
-
| Property | Type | Description |
|---|---|---|
|
|
| Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. |
|
|
| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
2.1.356. .spec.volumes[].downwardAPI.items[].fieldRef Copy linkLink copied to clipboard!
- Description
- Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
2.1.357. .spec.volumes[].downwardAPI.items[].resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
2.1.358. .spec.volumes[].emptyDir Copy linkLink copied to clipboard!
- Description
- emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
|
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be 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. |
2.1.360. .spec.volumes[].ephemeral.volumeClaimTemplate Copy linkLink copied to clipboard!
- Description
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be
<pod name>-<volume name>where<volume name>is the name from thePodSpec.Volumesarray entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
- Type
-
object - Required
-
spec
-
| Property | Type | Description |
|---|---|---|
|
|
| May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. |
|
|
| The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. |
2.1.361. .spec.volumes[].ephemeral.volumeClaimTemplate.metadata Copy linkLink copied to clipboard!
- 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
2.1.362. .spec.volumes[].ephemeral.volumeClaimTemplate.spec Copy linkLink copied to clipboard!
- Description
- The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
| 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 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 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 is a label query over volumes to consider for binding. |
|
|
| storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| 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 defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
| volumeName is the binding reference to the PersistentVolume backing this claim. |
2.1.363. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
2.1.364. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
|
|
| 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. |
2.1.365. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
2.1.366. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector Copy linkLink copied to clipboard!
- Description
- selector is a label query over volumes to consider for binding.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.367. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.368. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.369. .spec.volumes[].fc Copy linkLink copied to clipboard!
- Description
- fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 is Optional: FC target lun number |
|
|
| readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| targetWWNs is Optional: FC target worldwide names (WWNs) |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| driver is the name of the driver to use for this volume. |
|
|
| 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 is Optional: this field holds extra command options if any. |
|
|
| readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| datasetName is Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated |
|
|
| datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset |
2.1.373. .spec.volumes[].gcePersistentDisk Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 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 Copy linkLink copied to clipboard!
- Description
- gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.
- Type
-
object - Required
-
repository
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the URL |
|
|
| revision is the commit hash for the specified revision. |
2.1.375. .spec.volumes[].glusterfs Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| endpoints is the endpoint name that details Glusterfs topology. |
|
|
| path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
|
| readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
2.1.376. .spec.volumes[].hostPath Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
|
| type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
2.1.377. .spec.volumes[].image Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication |
|
|
| chapAuthSession defines whether support iSCSI Session CHAP authentication |
|
|
| 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 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 is the target iSCSI Qualified Name. |
|
|
| iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). |
|
|
| lun represents iSCSI Target Lun number. |
|
|
| 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 here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
|
|
| secretRef is the CHAP Secret for iSCSI target and initiator authentication |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef is the CHAP Secret for iSCSI target and initiator authentication
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- Type
-
object - Required
-
path -
server
-
| Property | Type | Description |
|---|---|---|
|
|
| path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
2.1.381. .spec.volumes[].persistentVolumeClaim Copy linkLink copied to clipboard!
- Description
- persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- Type
-
object - Required
-
claimName
-
| Property | Type | Description |
|---|---|---|
|
|
| claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
| readOnly Will force the ReadOnly setting in VolumeMounts. Default false. |
2.1.382. .spec.volumes[].photonPersistentDisk Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the ID that identifies Photon Controller persistent disk |
2.1.383. .spec.volumes[].portworxVolume Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
| readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| volumeID uniquely identifies a Portworx volume |
2.1.384. .spec.volumes[].projected Copy linkLink copied to clipboard!
- Description
- projected items for all in one resources secrets, configmaps, and downward API
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the list of volume projections. Each entry in this list handles one source. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
ClusterTrustBundle allows a pod to access the 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 information about the configMap data to project |
|
|
| downwardAPI information about the downwardAPI data to project |
|
|
| 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 information about the secret data to project |
|
|
| serviceAccountToken is information about the serviceAccountToken data to project |
2.1.387. .spec.volumes[].projected.sources[].clusterTrustBundle Copy linkLink copied to clipboard!
- Description
ClusterTrustBundle allows a pod to access the
.spec.trustBundlefield 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
-
| Property | Type | 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". |
|
|
| Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector. |
|
|
| 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. |
|
|
| Relative path from the volume root to write the bundle. |
|
|
| Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated. |
2.1.388. .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
2.1.389. .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
2.1.390. .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
2.1.391. .spec.volumes[].projected.sources[].configMap Copy linkLink copied to clipboard!
- Description
- configMap information about the configMap data to project
- Type
-
object
| Property | Type | 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 '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| optional specify whether the ConfigMap or its keys must be defined |
2.1.392. .spec.volumes[].projected.sources[].configMap.items Copy linkLink copied to clipboard!
- 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.393. .spec.volumes[].projected.sources[].configMap.items[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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.394. .spec.volumes[].projected.sources[].downwardAPI Copy linkLink copied to clipboard!
- Description
- downwardAPI information about the downwardAPI data to project
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Items is a list of DownwardAPIVolume file |
|
|
| DownwardAPIVolumeFile represents information to create the file containing the pod field |
2.1.395. .spec.volumes[].projected.sources[].downwardAPI.items Copy linkLink copied to clipboard!
- Description
- Items is a list of DownwardAPIVolume file
- Type
-
array
2.1.396. .spec.volumes[].projected.sources[].downwardAPI.items[] Copy linkLink copied to clipboard!
- Description
- DownwardAPIVolumeFile represents information to create the file containing the pod field
- Type
-
object - Required
-
path
-
| Property | Type | Description |
|---|---|---|
|
|
| Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. |
|
|
| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
2.1.397. .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef Copy linkLink copied to clipboard!
- Description
- Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
2.1.398. .spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
2.1.399. .spec.volumes[].projected.sources[].podCertificate Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| The type of keypair Kubelet will generate for the pod. Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521", and "ED25519". |
|
|
| 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. |
|
|
| Kubelet’s generated CSRs will be addressed to this signer. |
2.1.400. .spec.volumes[].projected.sources[].secret Copy linkLink copied to clipboard!
- Description
- secret information about the secret data to project
- Type
-
object
| Property | Type | 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 '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| optional field specify whether the Secret or its key must be defined |
2.1.401. .spec.volumes[].projected.sources[].secret.items Copy linkLink copied to clipboard!
- 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.402. .spec.volumes[].projected.sources[].secret.items[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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.403. .spec.volumes[].projected.sources[].serviceAccountToken Copy linkLink copied to clipboard!
- Description
- serviceAccountToken is information about the serviceAccountToken data to project
- Type
-
object - Required
-
path
-
| Property | Type | Description |
|---|---|---|
|
|
| audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. |
|
|
| expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. |
|
|
| path is the path relative to the mount point of the file to project the token into. |
2.1.404. .spec.volumes[].quobyte Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| group to map volume access to Default is no group |
|
|
| readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
|
|
| registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
|
|
| tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin |
|
|
| user to map volume access to Defaults to serivceaccount user |
|
|
| volume is a string that references an already created Quobyte volume by name. |
2.1.405. .spec.volumes[].rbd Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the host address of the ScaleIO API Gateway. |
|
|
| protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. |
|
|
| readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
|
|
| sslEnabled Flag enable/disable SSL communication with Gateway, default false |
|
|
| storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. |
|
|
| storagePool is the ScaleIO Storage Pool associated with the protection domain. |
|
|
| system is the name of the storage system as configured in ScaleIO. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| optional field specify whether the Secret or its keys must be defined |
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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 defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. |
|
|
| volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. |
|
|
| volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |
2.1.413. .spec.volumes[].storageos.secretRef Copy linkLink copied to clipboard!
- Description
- secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. |
|
|
| storagePolicyName is the storage Policy Based Management (SPBM) profile name. |
|
|
| volumePath is the path that identifies vSphere volume vmdk |
2.1.415. .spec.web Copy linkLink copied to clipboard!
- Description
- web defines the web command line flags when starting Alertmanager.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
getConcurrency defines the maximum number of GET requests processed concurrently. This corresponds to the Alertmanager’s |
|
|
| httpConfig defines HTTP parameters for web server. |
|
|
|
timeout for HTTP requests. This corresponds to the Alertmanager’s |
|
|
| tlsConfig defines the TLS parameters for HTTPS. |
2.1.416. .spec.web.httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines HTTP parameters for web server.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| headers defines a list of headers that can be added to HTTP responses. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- headers defines a list of headers that can be added to HTTP responses.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. |
|
|
| 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 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 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 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 Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS parameters for HTTPS.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| cert defines the Secret or ConfigMap containing the TLS certificate for the web server.
Either
It is mutually exclusive with |
|
|
| certFile defines the path to the TLS certificate file in the container for the web server.
Either
It is mutually exclusive with |
|
|
| 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 defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType |
|
|
| clientCAFile defines the path to the CA certificate file for client certificate authentication to the server.
It is mutually exclusive with |
|
|
| client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server.
It is mutually exclusive with |
|
|
| 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 defines the path to the TLS private key file in the container for the web server.
If defined, either
It is mutually exclusive with |
|
|
| keySecret defines the secret containing the TLS private key for the web server.
Either
It is mutually exclusive with |
|
|
| maxVersion defines the Maximum TLS version that is acceptable. |
|
|
| minVersion defines the minimum TLS version that is acceptable. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
cert defines the Secret or ConfigMap containing the TLS certificate for the web server.
Either
keySecretorkeyFilemust be defined.It is mutually exclusive with
certFile.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.420. .spec.web.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.421. .spec.web.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.422. .spec.web.tlsConfig.client_ca Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
2.1.423. .spec.web.tlsConfig.client_ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
2.1.424. .spec.web.tlsConfig.client_ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.425. .spec.web.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
keySecret defines the secret containing the TLS private key for the web server.
Either
certorcertFilemust be defined.It is mutually exclusive with
keyFile.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
2.1.426. .status Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this Alertmanager cluster. |
|
|
| conditions defines the current state of the Alertmanager object. |
|
|
| Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource. |
|
|
| paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. |
|
|
| replicas defines the total number of non-terminated pods targeted by this Alertmanager object (their labels match the selector). |
|
|
| selector used to match the pods targeted by this Alertmanager object. |
|
|
| unavailableReplicas defines the total number of unavailable pods targeted by this Alertmanager object. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- conditions defines the current state of the Alertmanager object.
- Type
-
array
2.1.428. .status.conditions[] Copy linkLink copied to clipboard!
- Description
- Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource.
- Type
-
object - Required
-
lastTransitionTime -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastTransitionTime is the time of the last update to the current status property. |
|
|
| message defines human-readable message indicating details for the condition’s last transition. |
|
|
|
observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if |
|
|
| reason for the condition’s last transition. |
|
|
| status of the condition. |
|
|
| type of the condition being reported. |
2.2. API endpoints Copy linkLink copied to clipboard!
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
-
2.2.1. /apis/monitoring.coreos.com/v1/alertmanagers Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind Alertmanager
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
2.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of Alertmanager
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind Alertmanager
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create an Alertmanager
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
2.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Alertmanager |
- HTTP method
-
DELETE - Description
- delete an Alertmanager
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified Alertmanager
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified Alertmanager
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified Alertmanager
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
2.2.4. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers/{name}/scale Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Alertmanager |
- HTTP method
-
GET - Description
- read scale of the specified Alertmanager
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update scale of the specified Alertmanager
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace scale of the specified Alertmanager
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
2.2.5. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Alertmanager |
- HTTP method
-
GET - Description
- read status of the specified Alertmanager
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified Alertmanager
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified Alertmanager
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 3. AlertmanagerConfig [monitoring.coreos.com/v1beta1] Copy linkLink copied to clipboard!
- Description
The
AlertmanagerConfigcustom resource definition (CRD) defines howAlertmanagerobjects process Prometheus alerts. It allows to specify alert grouping and routing, notification receivers and inhibition rules.Alertmanagerobjects selectAlertmanagerConfigobjects using label and namespace selectors.- Type
-
object - Required
-
spec
-
3.1. Specification Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec defines the specification of AlertmanagerConfigSpec |
3.1.1. .spec Copy linkLink copied to clipboard!
- Description
- spec defines the specification of AlertmanagerConfigSpec
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource’s namespace. |
|
|
| 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 defines the list of receivers. |
|
|
| Receiver defines one or more notification integrations. |
|
|
| 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 defines the list of timeIntervals specifying when the routes should be muted. |
|
|
| TimeInterval specifies the periods in time when notifications will be muted or active. |
3.1.2. .spec.inhibitRules Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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 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. |
|
|
| Matcher defines how to match on alert’s labels. |
|
|
| 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). |
|
|
| Matcher defines how to match on alert’s labels. |
3.1.4. .spec.inhibitRules[].sourceMatch Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Matcher defines how to match on alert’s labels.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 defines the label to match. This specifies which alert label should be evaluated. |
|
|
| value defines the label value to match. This is the expected value for the specified label. |
3.1.6. .spec.inhibitRules[].targetMatch Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Matcher defines how to match on alert’s labels.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 defines the label to match. This specifies which alert label should be evaluated. |
|
|
| value defines the label value to match. This is the expected value for the specified label. |
3.1.8. .spec.receivers Copy linkLink copied to clipboard!
- Description
- receivers defines the list of receivers.
- Type
-
array
3.1.9. .spec.receivers[] Copy linkLink copied to clipboard!
- Description
- Receiver defines one or more notification integrations.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| discordConfigs defines the list of Slack configurations. |
|
|
| DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config |
|
|
| emailConfigs defines the list of Email configurations. |
|
|
| EmailConfig configures notifications via Email. |
|
|
| msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0. |
|
|
| MSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0. |
|
|
| msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0. |
|
|
| 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 defines the name of the receiver. Must be unique across all items from the list. |
|
|
| opsgenieConfigs defines the list of OpsGenie configurations. |
|
|
| OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config |
|
|
| pagerdutyConfigs defines the List of PagerDuty configurations. |
|
|
| PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config |
|
|
| pushoverConfigs defines the list of Pushover configurations. |
|
|
| PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config |
|
|
| rocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0. |
|
|
| RocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0. |
|
|
| slackConfigs defines the list of Slack configurations. |
|
|
| SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config |
|
|
| snsConfigs defines the list of SNS configurations |
|
|
| SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs |
|
|
| telegramConfigs defines the list of Telegram configurations. |
|
|
| TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config |
|
|
| victoropsConfigs defines the list of VictorOps configurations. |
|
|
| VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config |
|
|
| webexConfigs defines the list of Webex configurations. |
|
|
| WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config |
|
|
| webhookConfigs defines the List of webhook configurations. |
|
|
| WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config |
|
|
| wechatConfigs defines the list of WeChat configurations. |
|
|
| WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config |
3.1.10. .spec.receivers[].discordConfigs Copy linkLink copied to clipboard!
- Description
- discordConfigs defines the list of Slack configurations.
- Type
-
array
3.1.11. .spec.receivers[].discordConfigs[] Copy linkLink copied to clipboard!
- Description
- DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config
- Type
-
object - Required
-
apiURL
-
| Property | Type | 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. |
|
|
| avatarURL defines the avatar url of the message sender. |
|
|
| content defines the template of the content’s body. |
|
|
| httpConfig defines HTTP client configuration. |
|
|
| message defines the template of the message’s body. |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
| title defines the template of the message’s title. |
|
|
| username defines the username of the message sender. |
3.1.12. .spec.receivers[].discordConfigs[].apiURL Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.13. .spec.receivers[].discordConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines HTTP client configuration.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.14. .spec.receivers[].discordConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.15. .spec.receivers[].discordConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.16. .spec.receivers[].discordConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.17. .spec.receivers[].discordConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.18. .spec.receivers[].discordConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.19. .spec.receivers[].discordConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.20. .spec.receivers[].discordConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.21. .spec.receivers[].discordConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.22. .spec.receivers[].discordConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.23. .spec.receivers[].discordConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.24. .spec.receivers[].discordConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.25. .spec.receivers[].discordConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.26. .spec.receivers[].discordConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.27. .spec.receivers[].discordConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.28. .spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.29. .spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.30. .spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.31. .spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.32. .spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.33. .spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.34. .spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.35. .spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.36. .spec.receivers[].discordConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.37. .spec.receivers[].discordConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.38. .spec.receivers[].discordConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.39. .spec.receivers[].discordConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.40. .spec.receivers[].discordConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.41. .spec.receivers[].discordConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.42. .spec.receivers[].discordConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.43. .spec.receivers[].discordConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.44. .spec.receivers[].discordConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.45. .spec.receivers[].discordConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.46. .spec.receivers[].discordConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.47. .spec.receivers[].emailConfigs Copy linkLink copied to clipboard!
- Description
- emailConfigs defines the list of Email configurations.
- Type
-
array
3.1.48. .spec.receivers[].emailConfigs[] Copy linkLink copied to clipboard!
- Description
- EmailConfig configures notifications via Email.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| authIdentity defines the identity to use for SMTP authentication. This is typically used with PLAIN authentication mechanism. |
|
|
| 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 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 defines the username to use for SMTP authentication. This is used for SMTP AUTH when the server requires authentication. |
|
|
| from defines the sender address for email notifications. This appears as the "From" field in the email header. |
|
|
| headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation. |
|
|
| KeyValue defines a (key, value) tuple. |
|
|
| hello defines the hostname to identify to the SMTP server. This is used in the SMTP HELO/EHLO command during the connection handshake. |
|
|
| html defines the HTML body of the email notification. This allows for rich formatting in the email content. |
|
|
| requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints. |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
| smarthost defines the SMTP host and port through which emails are sent. Format should be "hostname:port", e.g. "smtp.example.com:587". |
|
|
| text defines the plain text body of the email notification. This provides a fallback for email clients that don’t support HTML. |
|
|
| tlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options. |
|
|
| to defines the email address to send notifications to. This is the recipient address for alert notifications. |
3.1.49. .spec.receivers[].emailConfigs[].authPassword Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.50. .spec.receivers[].emailConfigs[].authSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.51. .spec.receivers[].emailConfigs[].headers Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- KeyValue defines a (key, value) tuple.
- Type
-
object - Required
-
key -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the tuple. This is the identifier or name part of the key-value pair. |
|
|
| value defines the value of the tuple. This is the data or content associated with the key. |
3.1.53. .spec.receivers[].emailConfigs[].tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.54. .spec.receivers[].emailConfigs[].tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.55. .spec.receivers[].emailConfigs[].tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.56. .spec.receivers[].emailConfigs[].tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.57. .spec.receivers[].emailConfigs[].tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.58. .spec.receivers[].emailConfigs[].tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.59. .spec.receivers[].emailConfigs[].tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.60. .spec.receivers[].emailConfigs[].tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.61. .spec.receivers[].msteamsConfigs Copy linkLink copied to clipboard!
- Description
- msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0.
- Type
-
array
3.1.62. .spec.receivers[].msteamsConfigs[] Copy linkLink copied to clipboard!
- Description
- MSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0.
- Type
-
object - Required
-
webhookUrl
-
| Property | Type | Description |
|---|---|---|
|
|
| httpConfig defines the HTTP client configuration for Teams webhook requests. |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
| 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 defines the message body template for Teams notifications. This contains the detailed content of the Teams message. |
|
|
| title defines the message title template for Teams notifications. This appears as the main heading of the Teams message card. |
|
|
| webhookUrl defines the MSTeams webhook URL for sending notifications. This is the incoming webhook URL configured in your Teams channel. |
3.1.63. .spec.receivers[].msteamsConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration for Teams webhook requests.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.64. .spec.receivers[].msteamsConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.65. .spec.receivers[].msteamsConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.66. .spec.receivers[].msteamsConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.67. .spec.receivers[].msteamsConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.68. .spec.receivers[].msteamsConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.69. .spec.receivers[].msteamsConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.70. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.71. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.72. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.73. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.74. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.75. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.76. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.77. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.78. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.79. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.80. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.81. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.82. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.83. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.84. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.85. .spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.86. .spec.receivers[].msteamsConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.87. .spec.receivers[].msteamsConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.88. .spec.receivers[].msteamsConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.89. .spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.90. .spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.91. .spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.92. .spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.93. .spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.94. .spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.95. .spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.96. .spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.97. .spec.receivers[].msteamsConfigs[].webhookUrl Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.98. .spec.receivers[].msteamsv2Configs Copy linkLink copied to clipboard!
- Description
- msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0.
- Type
-
array
3.1.99. .spec.receivers[].msteamsv2Configs[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| httpConfig defines the HTTP client configuration for Teams webhook requests. |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
| text defines the message body template for adaptive card notifications. This contains the detailed content displayed in the Teams adaptive card format. |
|
|
| title defines the message title template for adaptive card notifications. This appears as the main heading in the Teams adaptive card. |
|
|
| webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. This webhook must support the newer adaptive cards format required by Teams flows. |
3.1.100. .spec.receivers[].msteamsv2Configs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration for Teams webhook requests.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.101. .spec.receivers[].msteamsv2Configs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.102. .spec.receivers[].msteamsv2Configs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.103. .spec.receivers[].msteamsv2Configs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.104. .spec.receivers[].msteamsv2Configs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.105. .spec.receivers[].msteamsv2Configs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.106. .spec.receivers[].msteamsv2Configs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.107. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.108. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.109. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.110. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.111. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.112. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.113. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.114. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.115. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.116. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.117. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.118. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.119. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.120. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.121. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.122. .spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.123. .spec.receivers[].msteamsv2Configs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.124. .spec.receivers[].msteamsv2Configs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.125. .spec.receivers[].msteamsv2Configs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.126. .spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.127. .spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.128. .spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.129. .spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.130. .spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.131. .spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.132. .spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.133. .spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.134. .spec.receivers[].msteamsv2Configs[].webhookURL Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.135. .spec.receivers[].opsgenieConfigs Copy linkLink copied to clipboard!
- Description
- opsgenieConfigs defines the list of OpsGenie configurations.
- Type
-
array
3.1.136. .spec.receivers[].opsgenieConfigs[] Copy linkLink copied to clipboard!
- Description
- OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 defines the URL to send OpsGenie API requests to. When not specified, defaults to the standard OpsGenie API endpoint. |
|
|
| description defines the detailed description of the incident. This provides additional context beyond the message field. |
|
|
| 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. |
|
|
| KeyValue defines a (key, value) tuple. |
|
|
| 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 defines the HTTP client configuration for OpsGenie API requests. |
|
|
| message defines the alert text limited to 130 characters. This appears as the main alert title in OpsGenie. |
|
|
| note defines an additional alert note. This provides supplementary information about the alert. |
|
|
| priority defines the priority level of alert. Possible values are P1, P2, P3, P4, and P5, where P1 is highest priority. |
|
|
| responders defines the list of responders responsible for notifications. These determine who gets notified when the alert is created. |
|
|
|
OpsGenieConfigResponder defines a responder to an incident. One of |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
| source defines the backlink to the sender of the notification. This helps identify where the alert originated from. |
|
|
| tags defines a comma separated list of tags attached to the notifications. These help categorize and filter alerts within OpsGenie. |
3.1.137. .spec.receivers[].opsgenieConfigs[].apiKey Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.138. .spec.receivers[].opsgenieConfigs[].details Copy linkLink copied to clipboard!
- 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
3.1.139. .spec.receivers[].opsgenieConfigs[].details[] Copy linkLink copied to clipboard!
- Description
- KeyValue defines a (key, value) tuple.
- Type
-
object - Required
-
key -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the tuple. This is the identifier or name part of the key-value pair. |
|
|
| value defines the value of the tuple. This is the data or content associated with the key. |
3.1.140. .spec.receivers[].opsgenieConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration for OpsGenie API requests.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.141. .spec.receivers[].opsgenieConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.142. .spec.receivers[].opsgenieConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.143. .spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.144. .spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.145. .spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.146. .spec.receivers[].opsgenieConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.147. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.148. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.149. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.150. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.151. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.152. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.153. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.154. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.155. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.156. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.157. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.158. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.159. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.160. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.161. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.162. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.163. .spec.receivers[].opsgenieConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.164. .spec.receivers[].opsgenieConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.165. .spec.receivers[].opsgenieConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.166. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.167. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.168. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.169. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.170. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.171. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.172. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.173. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.174. .spec.receivers[].opsgenieConfigs[].responders Copy linkLink copied to clipboard!
- Description
- responders defines the list of responders responsible for notifications. These determine who gets notified when the alert is created.
- Type
-
array
3.1.175. .spec.receivers[].opsgenieConfigs[].responders[] Copy linkLink copied to clipboard!
- Description
-
OpsGenieConfigResponder defines a responder to an incident. One of
id,nameorusernamehas to be defined. - Type
-
object - Required
-
type
-
| Property | Type | Description |
|---|---|---|
|
|
| id defines the unique identifier of the responder. This corresponds to the responder’s ID within OpsGenie. |
|
|
| name defines the display name of the responder. This is used when the responder is identified by name rather than ID. |
|
|
| type defines the type of responder. Valid values include "user", "team", "schedule", and "escalation". This determines how OpsGenie interprets the other identifier fields. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- pagerdutyConfigs defines the List of PagerDuty configurations.
- Type
-
array
3.1.177. .spec.receivers[].pagerdutyConfigs[] Copy linkLink copied to clipboard!
- Description
- PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| class defines the class/type of the event. |
|
|
| client defines the client identification. |
|
|
| clientURL defines the backlink to the sender of notification. |
|
|
| component defines the part or component of the affected system that is broken. |
|
|
| description of the incident. |
|
|
| details defines the arbitrary key/value pairs that provide further detail about the incident. |
|
|
| KeyValue defines a (key, value) tuple. |
|
|
| group defines a cluster or grouping of sources. |
|
|
| httpConfig defines the HTTP client configuration. |
|
|
| pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident. |
|
|
| PagerDutyImageConfig attaches images to an incident |
|
|
| pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident. |
|
|
| PagerDutyLinkConfig attaches text links to an incident |
|
|
|
routingKey defines the secret’s key that contains the PagerDuty integration key (when using Events API v2). Either this field or |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
|
serviceKey defines the secret’s key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or |
|
|
| severity of the incident. |
|
|
| source defines the unique location of the affected system. |
|
|
| url defines the URL to send requests to. |
3.1.178. .spec.receivers[].pagerdutyConfigs[].details Copy linkLink copied to clipboard!
- Description
- details defines the arbitrary key/value pairs that provide further detail about the incident.
- Type
-
array
3.1.179. .spec.receivers[].pagerdutyConfigs[].details[] Copy linkLink copied to clipboard!
- Description
- KeyValue defines a (key, value) tuple.
- Type
-
object - Required
-
key -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the tuple. This is the identifier or name part of the key-value pair. |
|
|
| value defines the value of the tuple. This is the data or content associated with the key. |
3.1.180. .spec.receivers[].pagerdutyConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.181. .spec.receivers[].pagerdutyConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.182. .spec.receivers[].pagerdutyConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.183. .spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.184. .spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.185. .spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.186. .spec.receivers[].pagerdutyConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.187. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.188. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.189. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.190. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.191. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.192. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.193. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.194. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.195. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.196. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.197. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.198. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.199. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.200. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.201. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.202. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.203. .spec.receivers[].pagerdutyConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.204. .spec.receivers[].pagerdutyConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.205. .spec.receivers[].pagerdutyConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.206. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.207. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.208. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.209. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.210. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.211. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.212. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.213. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.214. .spec.receivers[].pagerdutyConfigs[].pagerDutyImageConfigs Copy linkLink copied to clipboard!
- Description
- pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident.
- Type
-
array
3.1.215. .spec.receivers[].pagerdutyConfigs[].pagerDutyImageConfigs[] Copy linkLink copied to clipboard!
- Description
- PagerDutyImageConfig attaches images to an incident
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| alt is the optional alternative text for the image. |
|
|
| href defines the optional URL; makes the image a clickable link. |
|
|
| src of the image being attached to the incident |
3.1.216. .spec.receivers[].pagerdutyConfigs[].pagerDutyLinkConfigs Copy linkLink copied to clipboard!
- Description
- pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident.
- Type
-
array
3.1.217. .spec.receivers[].pagerdutyConfigs[].pagerDutyLinkConfigs[] Copy linkLink copied to clipboard!
- Description
- PagerDutyLinkConfig attaches text links to an incident
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| alt defines the text that describes the purpose of the link, and can be used as the link’s text. |
|
|
| href defines the URL of the link to be attached |
3.1.218. .spec.receivers[].pagerdutyConfigs[].routingKey Copy linkLink copied to clipboard!
- Description
-
routingKey defines the secret’s key that contains the PagerDuty integration key (when using Events API v2). Either this field or
serviceKeyneeds 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.219. .spec.receivers[].pagerdutyConfigs[].serviceKey Copy linkLink copied to clipboard!
- Description
-
serviceKey defines the secret’s key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or
routingKeyneeds 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.220. .spec.receivers[].pushoverConfigs Copy linkLink copied to clipboard!
- Description
- pushoverConfigs defines the list of Pushover configurations.
- Type
-
array
3.1.221. .spec.receivers[].pushoverConfigs[] Copy linkLink copied to clipboard!
- Description
- PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 defines how long your notification will continue to be retried for, unless the user acknowledges the notification. Only applies to priority 2 notifications. |
|
|
| html defines whether notification message is HTML or plain text. When true, the message can include HTML formatting tags. |
|
|
| httpConfig defines the HTTP client configuration for Pushover API requests. |
|
|
| message defines the notification message content. This is the main body text of the Pushover notification. |
|
|
| monospace optional HTML/monospace formatting for the message, see https://pushover.net/api#html html and monospace formatting are mutually exclusive. |
|
|
| priority defines the notification priority level. See https://pushover.net/api#priority for valid values and behavior. |
|
|
| 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 defines whether or not to notify about resolved alerts. |
|
|
| 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 defines the notification title displayed in the Pushover message. This appears as the bold header text in the notification. |
|
|
|
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 |
|
|
|
tokenFile defines the token file that contains the registered application’s API token. See https://pushover.net/apps for application registration. Either |
|
|
| ttl defines the time to live for the alert notification. This determines how long the notification remains active before expiring. |
|
|
| url defines a supplementary URL shown alongside the message. This creates a clickable link within the Pushover notification. |
|
|
| urlTitle defines a title for the supplementary URL. If not specified, the raw URL is shown instead. |
|
|
|
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 |
|
|
|
userKeyFile defines the user key file that contains the recipient user’s user key. Either |
3.1.222. .spec.receivers[].pushoverConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration for Pushover API requests.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.223. .spec.receivers[].pushoverConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.224. .spec.receivers[].pushoverConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.225. .spec.receivers[].pushoverConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.226. .spec.receivers[].pushoverConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.227. .spec.receivers[].pushoverConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.228. .spec.receivers[].pushoverConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.229. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.230. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.231. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.232. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.233. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.234. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.235. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.236. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.237. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.238. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.239. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.240. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.241. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.242. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.243. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.244. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.245. .spec.receivers[].pushoverConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.246. .spec.receivers[].pushoverConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.247. .spec.receivers[].pushoverConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.248. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.249. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.250. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.251. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.252. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.253. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.254. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.255. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.256. .spec.receivers[].pushoverConfigs[].token Copy linkLink copied to clipboard!
- 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
tokenortokenFileis required. - Type
-
object - Required
-
key -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.257. .spec.receivers[].pushoverConfigs[].userKey Copy linkLink copied to clipboard!
- 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
userKeyoruserKeyFileis required. - Type
-
object - Required
-
key -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.258. .spec.receivers[].rocketchatConfigs Copy linkLink copied to clipboard!
- Description
- rocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0.
- Type
-
array
3.1.259. .spec.receivers[].rocketchatConfigs[] Copy linkLink copied to clipboard!
- Description
- RocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0.
- Type
-
object - Required
-
token -
tokenID
-
| Property | Type | Description |
|---|---|---|
|
|
| actions defines interactive actions to include in the message. These appear as buttons that users can click to trigger responses. |
|
|
| RocketChatActionConfig defines actions for RocketChat messages. |
|
|
| apiURL defines the API URL for RocketChat. Defaults to https://open.rocket.chat/ if not specified. |
|
|
| channel defines the channel to send alerts to. This can be a channel name (e.g., "#alerts") or a direct message recipient. |
|
|
| color defines the message color displayed in RocketChat. This appears as a colored bar alongside the message. |
|
|
| 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 defines additional fields for the message attachment. These appear as structured key-value pairs within the message. |
|
|
| RocketChatFieldConfig defines a field for RocketChat messages. |
|
|
| httpConfig defines the HTTP client configuration for RocketChat API requests. |
|
|
| iconURL defines the icon URL for the message avatar. This displays a custom image as the message sender’s avatar. |
|
|
| imageURL defines the image URL to display within the message. This embeds an image directly in the message attachment. |
|
|
| linkNames defines whether to enable automatic linking of usernames and channels. When true, @username and #channel references become clickable links. |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
| shortFields defines whether to use short fields in the message layout. When true, fields may be displayed side by side to save space. |
|
|
| text defines the message text to send. This is optional because attachments can be used instead of or alongside text. |
|
|
| thumbURL defines the thumbnail URL for the message. This displays a small thumbnail image alongside the message content. |
|
|
| title defines the message title displayed prominently in the message. This appears as bold text at the top of the message attachment. |
|
|
| titleLink defines the URL that the title will link to when clicked. This makes the message title clickable in the RocketChat interface. |
|
|
| token defines the sender token for RocketChat authentication. This is the personal access token or bot token used to authenticate API requests. |
|
|
| tokenID defines the sender token ID for RocketChat authentication. This is the user ID associated with the token used for API requests. |
3.1.260. .spec.receivers[].rocketchatConfigs[].actions Copy linkLink copied to clipboard!
- Description
- actions defines interactive actions to include in the message. These appear as buttons that users can click to trigger responses.
- Type
-
array
3.1.261. .spec.receivers[].rocketchatConfigs[].actions[] Copy linkLink copied to clipboard!
- Description
- RocketChatActionConfig defines actions for RocketChat messages.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| msg defines the message to send when the button is clicked. This allows the button to post a predefined message to the channel. |
|
|
| text defines the button text displayed to users. This is the label that appears on the interactive button. |
|
|
| url defines the URL the button links to when clicked. This creates a clickable button that opens the specified URL. |
3.1.262. .spec.receivers[].rocketchatConfigs[].fields Copy linkLink copied to clipboard!
- Description
- fields defines additional fields for the message attachment. These appear as structured key-value pairs within the message.
- Type
-
array
3.1.263. .spec.receivers[].rocketchatConfigs[].fields[] Copy linkLink copied to clipboard!
- Description
- RocketChatFieldConfig defines a field for RocketChat messages.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 defines the title of this field. This appears as bold text labeling the field content. |
|
|
| value defines the value of this field, displayed underneath the title. This contains the actual data or content for the field. |
3.1.264. .spec.receivers[].rocketchatConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration for RocketChat API requests.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.265. .spec.receivers[].rocketchatConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.266. .spec.receivers[].rocketchatConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.267. .spec.receivers[].rocketchatConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.268. .spec.receivers[].rocketchatConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.269. .spec.receivers[].rocketchatConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.270. .spec.receivers[].rocketchatConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.271. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.272. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.273. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.274. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.275. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.276. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.277. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.278. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.279. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.280. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.281. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.282. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.283. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.284. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.285. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.286. .spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.287. .spec.receivers[].rocketchatConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.288. .spec.receivers[].rocketchatConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.289. .spec.receivers[].rocketchatConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.290. .spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.291. .spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.292. .spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.293. .spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.294. .spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.295. .spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.296. .spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.297. .spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.298. .spec.receivers[].rocketchatConfigs[].token Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.299. .spec.receivers[].rocketchatConfigs[].tokenID Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.300. .spec.receivers[].slackConfigs Copy linkLink copied to clipboard!
- Description
- slackConfigs defines the list of Slack configurations.
- Type
-
array
3.1.301. .spec.receivers[].slackConfigs[] Copy linkLink copied to clipboard!
- Description
- SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| actions defines a list of Slack actions that are sent with each notification. |
|
|
| 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 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 defines an identifier for the message used in interactive components. |
|
|
| channel defines the channel or user to send notifications to. |
|
|
| 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 defines a plain-text summary of the attachment for clients that don’t support attachments. |
|
|
| fields defines a list of Slack fields that are sent with each notification. |
|
|
| 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 defines small text displayed at the bottom of the message attachment. |
|
|
| httpConfig defines the HTTP client configuration. |
|
|
| iconEmoji defines the emoji to use as the bot’s avatar (e.g., ":ghost:"). |
|
|
| iconURL defines the URL to an image to use as the bot’s avatar. |
|
|
| imageURL defines the URL to an image file that will be displayed inside the message attachment. |
|
|
| linkNames enables automatic linking of channel names and usernames in the message. When true, @channel and @username will be converted to clickable links. |
|
|
| mrkdwnIn defines which fields should be parsed as Slack markdown. Valid values include "pretext", "text", and "fields". |
|
|
| pretext defines optional text that appears above the message attachment block. |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
| shortFields determines whether fields are displayed in a compact format. When true, fields are shown side by side when possible. |
|
|
| text defines the main text content of the Slack message attachment. |
|
|
| thumbURL defines the URL to an image file that will be displayed as a thumbnail on the right side of the message attachment. |
|
|
| title defines the title text displayed in the Slack message attachment. |
|
|
| titleLink defines the URL that the title will link to when clicked. |
|
|
| username defines the slack bot user name. |
3.1.302. .spec.receivers[].slackConfigs[].actions Copy linkLink copied to clipboard!
- Description
- actions defines a list of Slack actions that are sent with each notification.
- Type
-
array
3.1.303. .spec.receivers[].slackConfigs[].actions[] Copy linkLink copied to clipboard!
- 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
-
| Property | Type | 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. |
|
|
| 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 defines the visual appearance of the action element. Valid values include "default", "primary" (green), and "danger" (red). |
|
|
| 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 defines the type of interactive component. Common values include "button" for clickable buttons and "select" for dropdown menus. |
|
|
| 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 defines the payload sent when the action is triggered. This data is included in the callback sent to your application. |
3.1.304. .spec.receivers[].slackConfigs[].actions[].confirm Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| dismissText defines the label for the cancel button in the dialog. When not specified, defaults to "Cancel". This button cancels the action. |
|
|
| okText defines the label for the confirmation button in the dialog. When not specified, defaults to "Okay". This button proceeds with the action. |
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.306. .spec.receivers[].slackConfigs[].fields Copy linkLink copied to clipboard!
- Description
- fields defines a list of Slack fields that are sent with each notification.
- Type
-
array
3.1.307. .spec.receivers[].slackConfigs[].fields[] Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 defines the label or header text displayed for this field. This appears as bold text above the field value in the Slack message. |
|
|
| value defines the content or data displayed for this field. This appears below the title and can contain plain text or Slack markdown. |
3.1.308. .spec.receivers[].slackConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.309. .spec.receivers[].slackConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.310. .spec.receivers[].slackConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.311. .spec.receivers[].slackConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.312. .spec.receivers[].slackConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.313. .spec.receivers[].slackConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.314. .spec.receivers[].slackConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.315. .spec.receivers[].slackConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.316. .spec.receivers[].slackConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.317. .spec.receivers[].slackConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.318. .spec.receivers[].slackConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.319. .spec.receivers[].slackConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.320. .spec.receivers[].slackConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.321. .spec.receivers[].slackConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.322. .spec.receivers[].slackConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.323. .spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.324. .spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.325. .spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.326. .spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.327. .spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.328. .spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.329. .spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.330. .spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.331. .spec.receivers[].slackConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.332. .spec.receivers[].slackConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.333. .spec.receivers[].slackConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.334. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.335. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.336. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.337. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.338. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.339. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.340. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.341. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.342. .spec.receivers[].snsConfigs Copy linkLink copied to clipboard!
- Description
- snsConfigs defines the list of SNS configurations
- Type
-
array
3.1.343. .spec.receivers[].snsConfigs[] Copy linkLink copied to clipboard!
- Description
- SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 defines SNS message attributes as key-value pairs. These provide additional metadata that can be used for message filtering and routing. |
|
|
| httpConfig defines the HTTP client configuration for SNS API requests. |
|
|
| message defines the message content of the SNS notification. This is the actual notification text that will be sent to subscribers. |
|
|
| 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 defines whether or not to notify about resolved alerts. |
|
|
| sigv4 configures AWS’s Signature Verification 4 signing process to sign requests. This includes AWS credentials and region configuration for authentication. |
|
|
| 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 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 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 Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration for SNS API requests.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.345. .spec.receivers[].snsConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.346. .spec.receivers[].snsConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.347. .spec.receivers[].snsConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.348. .spec.receivers[].snsConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.349. .spec.receivers[].snsConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.350. .spec.receivers[].snsConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.351. .spec.receivers[].snsConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.352. .spec.receivers[].snsConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.353. .spec.receivers[].snsConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.354. .spec.receivers[].snsConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.355. .spec.receivers[].snsConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.356. .spec.receivers[].snsConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.357. .spec.receivers[].snsConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.358. .spec.receivers[].snsConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.359. .spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.360. .spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.361. .spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.362. .spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.363. .spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.364. .spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.365. .spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.366. .spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.367. .spec.receivers[].snsConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.368. .spec.receivers[].snsConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.369. .spec.receivers[].snsConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.370. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.371. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.372. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.373. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.374. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.375. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.376. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.377. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.378. .spec.receivers[].snsConfigs[].sigv4 Copy linkLink copied to clipboard!
- Description
- sigv4 configures AWS’s Signature Verification 4 signing process to sign requests. This includes AWS credentials and region configuration for authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
accessKey defines the AWS API key. If not specified, the environment variable |
|
|
| profile defines the named AWS profile used to authenticate. |
|
|
| region defines the AWS region. If blank, the region from the default credentials chain used. |
|
|
| roleArn defines the named AWS profile used to authenticate. |
|
|
|
secretKey defines the AWS API secret. If not specified, the environment variable |
|
|
| useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. It requires Prometheus >= v2.54.0. |
3.1.379. .spec.receivers[].snsConfigs[].sigv4.accessKey Copy linkLink copied to clipboard!
- Description
-
accessKey defines the AWS API key. If not specified, the environment variable
AWS_ACCESS_KEY_IDis used. - Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.380. .spec.receivers[].snsConfigs[].sigv4.secretKey Copy linkLink copied to clipboard!
- Description
-
secretKey defines the AWS API secret. If not specified, the environment variable
AWS_SECRET_ACCESS_KEYis used. - Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.381. .spec.receivers[].telegramConfigs Copy linkLink copied to clipboard!
- Description
- telegramConfigs defines the list of Telegram configurations.
- Type
-
array
3.1.382. .spec.receivers[].telegramConfigs[] Copy linkLink copied to clipboard!
- Description
- TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config
- Type
-
object - Required
-
chatID
-
| Property | Type | Description |
|---|---|---|
|
|
| apiURL defines the Telegram API URL, e.g. https://api.telegram.org. If not specified, the default Telegram API URL will be used. |
|
|
|
botToken defines the Telegram bot token. It is mutually exclusive with |
|
|
|
botTokenFile defines the file to read the Telegram bot token from. It is mutually exclusive with |
|
|
| 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 controls whether Telegram notifications are sent silently. When true, users will receive the message without notification sounds. |
|
|
| httpConfig defines the HTTP client configuration for Telegram API requests. |
|
|
| message defines the message template for the Telegram notification. This is the content that will be sent to the specified chat. |
|
|
| 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 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 defines whether or not to notify about resolved alerts. |
3.1.383. .spec.receivers[].telegramConfigs[].botToken Copy linkLink copied to clipboard!
- 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. EitherbotTokenorbotTokenFileis required. - Type
-
object - Required
-
key -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.384. .spec.receivers[].telegramConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration for Telegram API requests.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.385. .spec.receivers[].telegramConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.386. .spec.receivers[].telegramConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.387. .spec.receivers[].telegramConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.388. .spec.receivers[].telegramConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.389. .spec.receivers[].telegramConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.390. .spec.receivers[].telegramConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.391. .spec.receivers[].telegramConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.392. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.393. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.394. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.395. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.396. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.397. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.398. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.399. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.400. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.401. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.402. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.403. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.404. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.405. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.406. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.407. .spec.receivers[].telegramConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.408. .spec.receivers[].telegramConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.409. .spec.receivers[].telegramConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.410. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.411. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.412. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.413. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.414. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.415. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.416. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.417. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.418. .spec.receivers[].victoropsConfigs Copy linkLink copied to clipboard!
- Description
- victoropsConfigs defines the list of VictorOps configurations.
- Type
-
array
3.1.419. .spec.receivers[].victoropsConfigs[] Copy linkLink copied to clipboard!
- Description
- VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config
- Type
-
object
| Property | Type | 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. |
|
|
| apiUrl defines the VictorOps API URL. When not specified, defaults to the standard VictorOps API endpoint. |
|
|
| customFields defines additional custom fields for notification. These provide extra metadata that will be included with the VictorOps incident. |
|
|
| KeyValue defines a (key, value) tuple. |
|
|
| entityDisplayName contains a summary of the alerted problem. This appears as the main title or identifier for the incident. |
|
|
| httpConfig defines the HTTP client’s configuration for VictorOps API requests. |
|
|
| messageType describes the behavior of the alert. Valid values are "CRITICAL", "WARNING", and "INFO". |
|
|
| monitoringTool defines the monitoring tool the state message is from. This helps identify the source system that generated the alert. |
|
|
| routingKey defines a key used to map the alert to a team. This determines which VictorOps team will receive the alert notification. |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
| stateMessage contains a long explanation of the alerted problem. This provides detailed context about the incident. |
3.1.420. .spec.receivers[].victoropsConfigs[].apiKey Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.421. .spec.receivers[].victoropsConfigs[].customFields Copy linkLink copied to clipboard!
- Description
- customFields defines additional custom fields for notification. These provide extra metadata that will be included with the VictorOps incident.
- Type
-
array
3.1.422. .spec.receivers[].victoropsConfigs[].customFields[] Copy linkLink copied to clipboard!
- Description
- KeyValue defines a (key, value) tuple.
- Type
-
object - Required
-
key -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the tuple. This is the identifier or name part of the key-value pair. |
|
|
| value defines the value of the tuple. This is the data or content associated with the key. |
3.1.423. .spec.receivers[].victoropsConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client’s configuration for VictorOps API requests.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.424. .spec.receivers[].victoropsConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.425. .spec.receivers[].victoropsConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.426. .spec.receivers[].victoropsConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.427. .spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.428. .spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.429. .spec.receivers[].victoropsConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.430. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.431. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.432. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.433. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.434. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.435. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.436. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.437. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.438. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.439. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.440. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.441. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.442. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.443. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.444. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.445. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.446. .spec.receivers[].victoropsConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.447. .spec.receivers[].victoropsConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.448. .spec.receivers[].victoropsConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.449. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.450. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.451. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.452. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.453. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.454. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.455. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.456. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.457. .spec.receivers[].webexConfigs Copy linkLink copied to clipboard!
- Description
- webexConfigs defines the list of Webex configurations.
- Type
-
array
3.1.458. .spec.receivers[].webexConfigs[] Copy linkLink copied to clipboard!
- Description
- WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config
- Type
-
object - Required
-
roomID
-
| Property | Type | Description |
|---|---|---|
|
|
| apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages |
|
|
|
httpConfig defines the HTTP client’s configuration. You must use this configuration to supply the bot token as part of the HTTP |
|
|
| message defines the message template |
|
|
| roomID defines the ID of the Webex Teams room where to send the messages. |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
3.1.459. .spec.receivers[].webexConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
-
httpConfig defines the HTTP client’s configuration. You must use this configuration to supply the bot token as part of the HTTP
Authorizationheader. - Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.460. .spec.receivers[].webexConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.461. .spec.receivers[].webexConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.462. .spec.receivers[].webexConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.463. .spec.receivers[].webexConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.464. .spec.receivers[].webexConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.465. .spec.receivers[].webexConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.466. .spec.receivers[].webexConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.467. .spec.receivers[].webexConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.468. .spec.receivers[].webexConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.469. .spec.receivers[].webexConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.470. .spec.receivers[].webexConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.471. .spec.receivers[].webexConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.472. .spec.receivers[].webexConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.473. .spec.receivers[].webexConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.474. .spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.475. .spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.476. .spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.477. .spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.478. .spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.479. .spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.480. .spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.481. .spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.482. .spec.receivers[].webexConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.483. .spec.receivers[].webexConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.484. .spec.receivers[].webexConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.485. .spec.receivers[].webexConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.486. .spec.receivers[].webexConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.487. .spec.receivers[].webexConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.488. .spec.receivers[].webexConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.489. .spec.receivers[].webexConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.490. .spec.receivers[].webexConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.491. .spec.receivers[].webexConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.492. .spec.receivers[].webexConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.493. .spec.receivers[].webhookConfigs Copy linkLink copied to clipboard!
- Description
- webhookConfigs defines the List of webhook configurations.
- Type
-
array
3.1.494. .spec.receivers[].webhookConfigs[] Copy linkLink copied to clipboard!
- Description
- WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| httpConfig defines the HTTP client configuration for webhook requests. |
|
|
| maxAlerts defines the maximum number of alerts to be sent per webhook message. When 0, all alerts are included in the webhook payload. |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
| 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 defines the URL to send HTTP POST requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. |
|
|
| 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. |
3.1.495. .spec.receivers[].webhookConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration for webhook requests.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.496. .spec.receivers[].webhookConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.497. .spec.receivers[].webhookConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.498. .spec.receivers[].webhookConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.499. .spec.receivers[].webhookConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.500. .spec.receivers[].webhookConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.501. .spec.receivers[].webhookConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.502. .spec.receivers[].webhookConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.503. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.504. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.505. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.506. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.507. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.508. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.509. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.510. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.511. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.512. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.513. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.514. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.515. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.516. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.517. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.518. .spec.receivers[].webhookConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.519. .spec.receivers[].webhookConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.520. .spec.receivers[].webhookConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.521. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.522. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.523. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.524. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.525. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.526. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.527. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.528. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.529. .spec.receivers[].webhookConfigs[].urlSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.530. .spec.receivers[].wechatConfigs Copy linkLink copied to clipboard!
- Description
- wechatConfigs defines the list of WeChat configurations.
- Type
-
array
3.1.531. .spec.receivers[].wechatConfigs[] Copy linkLink copied to clipboard!
- Description
- WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| agentID defines the application agent ID within WeChat Work. This identifies which WeChat Work application will send the notifications. |
|
|
| 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 defines the WeChat API URL. When not specified, defaults to the standard WeChat Work API endpoint. |
|
|
| corpID defines the corp id for authentication. This is the unique identifier for your WeChat Work organization. |
|
|
| httpConfig defines the HTTP client configuration for WeChat API requests. |
|
|
| message defines the API request data as defined by the WeChat API. This contains the actual notification content to be sent. |
|
|
| messageType defines the type of message to send. Valid values include "text", "markdown", and other WeChat Work supported message types. |
|
|
| sendResolved defines whether or not to notify about resolved alerts. |
|
|
| toParty defines the target department(s) to receive the notification. Can be a single department ID or multiple department IDs separated by '|'. |
|
|
| toTag defines the target tag(s) to receive the notification. Can be a single tag ID or multiple tag IDs separated by '|'. |
|
|
| toUser defines the target user(s) to receive the notification. Can be a single user ID or multiple user IDs separated by '|'. |
3.1.532. .spec.receivers[].wechatConfigs[].apiSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.533. .spec.receivers[].wechatConfigs[].httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines the HTTP client configuration for WeChat API requests.
- Type
-
object
| Property | Type | 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+. |
|
|
| basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
| 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 can be used to disable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
| 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 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
3.1.534. .spec.receivers[].wechatConfigs[].httpConfig.authorization Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
3.1.535. .spec.receivers[].wechatConfigs[].httpConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.536. .spec.receivers[].wechatConfigs[].httpConfig.basicAuth Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
3.1.537. .spec.receivers[].wechatConfigs[].httpConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.538. .spec.receivers[].wechatConfigs[].httpConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.539. .spec.receivers[].wechatConfigs[].httpConfig.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key defines the key of the secret to select from. Must be a valid secret key. |
|
|
| name defines the name of the secret in the object’s namespace to select from. |
3.1.540. .spec.receivers[].wechatConfigs[].httpConfig.oauth2 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
3.1.541. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.542. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.543. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.544. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.545. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.546. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.547. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.548. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.549. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.550. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.551. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.552. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.553. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.554. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.555. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.556. .spec.receivers[].wechatConfigs[].httpConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
3.1.557. .spec.receivers[].wechatConfigs[].httpConfig.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
3.1.558. .spec.receivers[].wechatConfigs[].httpConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.559. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
3.1.560. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.561. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.562. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.563. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
3.1.564. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
3.1.565. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.566. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
3.1.567. .spec.route Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| activeTimeIntervals is a list of TimeInterval names when this route should be active. |
|
|
| 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 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 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 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 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 |
|
|
| Matcher defines how to match on alert’s labels. |
|
|
| muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched, |
|
|
|
receiver defines the name of the receiver for this route. If not empty, it should be listed in the |
|
|
| 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 defines the child routes. |
3.1.568. .spec.route.matchers Copy linkLink copied to clipboard!
- 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
namespacelabel and adds anamespace: <object namespace>matcher. - Type
-
array
3.1.569. .spec.route.matchers[] Copy linkLink copied to clipboard!
- Description
- Matcher defines how to match on alert’s labels.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 defines the label to match. This specifies which alert label should be evaluated. |
|
|
| value defines the label value to match. This is the expected value for the specified label. |
3.1.570. .spec.timeIntervals Copy linkLink copied to clipboard!
- Description
- timeIntervals defines the list of timeIntervals specifying when the routes should be muted.
- Type
-
array
3.1.571. .spec.timeIntervals[] Copy linkLink copied to clipboard!
- Description
- TimeInterval specifies the periods in time when notifications will be muted or active.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| name of the time interval. |
|
|
| timeIntervals defines a list of TimePeriod. |
|
|
| TimePeriod describes periods of time. |
3.1.572. .spec.timeIntervals[].timeIntervals Copy linkLink copied to clipboard!
- Description
- timeIntervals defines a list of TimePeriod.
- Type
-
array
3.1.573. .spec.timeIntervals[].timeIntervals[] Copy linkLink copied to clipboard!
- Description
- TimePeriod describes periods of time.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| daysOfMonth defines a list of DayOfMonthRange |
|
|
| DayOfMonthRange is an inclusive range of days of the month beginning at 1 |
|
|
| months defines a list of MonthRange |
|
|
| times defines a list of TimeRange |
|
|
| TimeRange defines a start and end time in 24hr format |
|
|
| weekdays defines a list of WeekdayRange |
|
|
| years defines a list of YearRange |
3.1.574. .spec.timeIntervals[].timeIntervals[].daysOfMonth Copy linkLink copied to clipboard!
- Description
- daysOfMonth defines a list of DayOfMonthRange
- Type
-
array
3.1.575. .spec.timeIntervals[].timeIntervals[].daysOfMonth[] Copy linkLink copied to clipboard!
- Description
- DayOfMonthRange is an inclusive range of days of the month beginning at 1
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| end of the inclusive range |
|
|
| start of the inclusive range |
3.1.576. .spec.timeIntervals[].timeIntervals[].times Copy linkLink copied to clipboard!
- Description
- times defines a list of TimeRange
- Type
-
array
3.1.577. .spec.timeIntervals[].timeIntervals[].times[] Copy linkLink copied to clipboard!
- Description
- TimeRange defines a start and end time in 24hr format
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| endTime defines the end time in 24hr format. |
|
|
| startTime defines the start time in 24hr format. |
3.2. API endpoints Copy linkLink copied to clipboard!
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
-
3.2.1. /apis/monitoring.coreos.com/v1beta1/alertmanagerconfigs Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind AlertmanagerConfig
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
3.2.2. /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of AlertmanagerConfig
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind AlertmanagerConfig
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create an AlertmanagerConfig
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
3.2.3. /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the AlertmanagerConfig |
- HTTP method
-
DELETE - Description
- delete an AlertmanagerConfig
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified AlertmanagerConfig
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified AlertmanagerConfig
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified AlertmanagerConfig
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 4. AlertRelabelConfig [monitoring.openshift.io/v1] Copy linkLink copied to clipboard!
- 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 Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec describes the desired state of this AlertRelabelConfig object. |
|
|
| status describes the current state of this AlertRelabelConfig object. |
4.1.1. .spec Copy linkLink copied to clipboard!
- Description
- spec describes the desired state of this AlertRelabelConfig object.
- Type
-
object - Required
-
configs
-
| Property | Type | Description |
|---|---|---|
|
|
| configs is a list of sequentially evaluated alert relabel configs. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- configs is a list of sequentially evaluated alert relabel configs.
- Type
-
array
4.1.3. .spec.configs[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on regex matching. Must be one of: 'Replace', 'Keep', 'Drop', 'HashMod', 'LabelMap', 'LabelDrop', or 'LabelKeep'. Default is: 'Replace' |
|
|
| 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 against which the extracted value is matched. Default is: '(.*)' regex is required for all actions except 'HashMod' |
|
|
| 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 placed between concatenated source label values. When omitted, Prometheus will use its default value of ';'. |
|
|
| 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 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 Copy linkLink copied to clipboard!
- Description
- status describes the current state of this AlertRelabelConfig object.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| conditions contains details on the state of the AlertRelabelConfig, may be empty. |
|
|
| Condition contains details for one aspect of the current state of this API Resource. |
4.1.5. .status.conditions Copy linkLink copied to clipboard!
- Description
- conditions contains details on the state of the AlertRelabelConfig, may be empty.
- Type
-
array
4.1.6. .status.conditions[] Copy linkLink copied to clipboard!
- Description
- Condition contains details for one aspect of the current state of this API Resource.
- Type
-
object - Required
-
lastTransitionTime -
message -
reason -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is a human readable message indicating details about the transition. This may be an empty string. |
|
|
| 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 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 of the condition, one of True, False, Unknown. |
|
|
| type of condition in CamelCase or in foo.example.com/CamelCase. |
4.2. API endpoints Copy linkLink copied to clipboard!
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
-
4.2.1. /apis/monitoring.openshift.io/v1/alertrelabelconfigs Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind AlertRelabelConfig
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
4.2.2. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of AlertRelabelConfig
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind AlertRelabelConfig
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create an AlertRelabelConfig
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
4.2.3. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the AlertRelabelConfig |
- HTTP method
-
DELETE - Description
- delete an AlertRelabelConfig
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified AlertRelabelConfig
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified AlertRelabelConfig
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified AlertRelabelConfig
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
4.2.4. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the AlertRelabelConfig |
- HTTP method
-
GET - Description
- read status of the specified AlertRelabelConfig
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified AlertRelabelConfig
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified AlertRelabelConfig
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 5. AlertingRule [monitoring.openshift.io/v1] Copy linkLink copied to clipboard!
- 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 Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec describes the desired state of this AlertingRule object. |
|
|
| status describes the current state of this AlertOverrides object. |
5.1.1. .spec Copy linkLink copied to clipboard!
- Description
- spec describes the desired state of this AlertingRule object.
- Type
-
object - Required
-
groups
-
| Property | Type | 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. |
|
|
| RuleGroup is a list of sequentially evaluated alerting rules. |
5.1.2. .spec.groups Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- RuleGroup is a list of sequentially evaluated alerting rules.
- Type
-
object - Required
-
name -
rules
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the name of the group. |
|
|
| 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. |
|
|
| Rule describes an alerting rule. See Prometheus documentation: - https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules |
5.1.4. .spec.groups[].rules Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Rule describes an alerting rule. See Prometheus documentation: - https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules
- Type
-
object - Required
-
alert -
expr
-
| Property | Type | Description |
|---|---|---|
|
|
| alert is the name of the alert. Must be a valid label value, i.e. may contain any Unicode character. |
|
|
| 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 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 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 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 |
5.1.6. .status Copy linkLink copied to clipboard!
- Description
- status describes the current state of this AlertOverrides object.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| observedGeneration is the last generation change you’ve dealt with. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| name of the referenced PrometheusRule. |
5.2. API endpoints Copy linkLink copied to clipboard!
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
-
5.2.1. /apis/monitoring.openshift.io/v1/alertingrules Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind AlertingRule
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
5.2.2. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of AlertingRule
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind AlertingRule
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create an AlertingRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
5.2.3. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the AlertingRule |
- HTTP method
-
DELETE - Description
- delete an AlertingRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified AlertingRule
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified AlertingRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified AlertingRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
5.2.4. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the AlertingRule |
- HTTP method
-
GET - Description
- read status of the specified AlertingRule
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified AlertingRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified AlertingRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 6. DataGather [insights.openshift.io/v1alpha2] Copy linkLink copied to clipboard!
- 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 Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec holds user settable values for configuration |
|
|
| status holds observed values from the cluster. They may not be overridden. |
6.1.1. .spec Copy linkLink copied to clipboard!
- Description
- spec holds user settable values for configuration
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 is an optional field that specifies the configuration of the gatherers. If omitted, all gatherers will be run. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- gatherers is an optional field that specifies the configuration of the gatherers. If omitted, all gatherers will be run.
- Type
-
object - Required
-
mode
-
| Property | Type | 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. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | 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'" |
|
|
| gathererConfig allows to configure specific gatherers |
6.1.4. .spec.gatherers.custom.configs Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- gathererConfig allows to configure specific gatherers
- Type
-
object - Required
-
name -
state
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | 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 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | 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. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- status holds observed values from the cluster. They may not be overridden.
- Type
-
object
| Property | Type | 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. |
|
|
| Condition contains details for one aspect of the current state of this API Resource. |
|
|
| finishTime is the time when Insights data gathering finished. |
|
|
| gatherers is a list of active gatherers (and their statuses) in the last gathering. |
|
|
| gathererStatus represents information about a particular data gatherer. |
|
|
| 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 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 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. |
|
|
| ObjectReference contains enough information to let you inspect or modify the referred object. |
|
|
| startTime is the time when Insights data gathering started. |
6.1.10. .status.conditions Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Condition contains details for one aspect of the current state of this API Resource.
- Type
-
object - Required
-
lastTransitionTime -
message -
reason -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is a human readable message indicating details about the transition. This may be an empty string. |
|
|
| 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 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 of the condition, one of True, False, Unknown. |
|
|
| type of condition in CamelCase or in foo.example.com/CamelCase. |
6.1.12. .status.gatherers Copy linkLink copied to clipboard!
- Description
- gatherers is a list of active gatherers (and their statuses) in the last gathering.
- Type
-
array
6.1.13. .status.gatherers[] Copy linkLink copied to clipboard!
- Description
- gathererStatus represents information about a particular data gatherer.
- Type
-
object - Required
-
lastGatherSeconds -
name
-
| Property | Type | 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. |
|
|
| Condition contains details for one aspect of the current state of this API Resource. |
|
|
| lastGatherSeconds is required field that represents the time spent gathering in seconds |
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Condition contains details for one aspect of the current state of this API Resource.
- Type
-
object - Required
-
lastTransitionTime -
message -
reason -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is a human readable message indicating details about the transition. This may be an empty string. |
|
|
| 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 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 of the condition, one of True, False, Unknown. |
|
|
| type of condition in CamelCase or in foo.example.com/CamelCase. |
6.1.16. .status.insightsReport Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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 provides basic information about active Insights health checks in a cluster. |
|
|
| healthCheck represents an Insights health check attributes. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- healthChecks provides basic information about active Insights health checks in a cluster.
- Type
-
array
6.1.18. .status.insightsReport.healthChecks[] Copy linkLink copied to clipboard!
- Description
- healthCheck represents an Insights health check attributes.
- Type
-
object - Required
-
advisorURI -
description -
totalRisk
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is required field that provides basic description of the healtcheck. It must contain at least 10 characters and may not exceed 2048 characters. |
|
|
| 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.2. API endpoints Copy linkLink copied to clipboard!
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
-
6.2.1. /apis/insights.openshift.io/v1alpha2/datagathers Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of DataGather
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind DataGather
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a DataGather
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
6.2.2. /apis/insights.openshift.io/v1alpha2/datagathers/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the DataGather |
- HTTP method
-
DELETE - Description
- delete a DataGather
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified DataGather
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified DataGather
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified DataGather
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
6.2.3. /apis/insights.openshift.io/v1alpha2/datagathers/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the DataGather |
- HTTP method
-
GET - Description
- read status of the specified DataGather
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified DataGather
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified DataGather
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 7. PodMonitor [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
PodMonitorcustom resource definition (CRD) defines howPrometheusandPrometheusAgentcan 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.PrometheusandPrometheusAgentobjects selectPodMonitorobjects using label and namespace selectors.- Type
-
object - Required
-
spec
-
7.1. Specification Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec defines the specification of desired Pod selection for target discovery by Prometheus. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- spec defines the specification of desired Pod selection for target discovery by Prometheus.
- Type
-
object - Required
-
selector
-
| Property | Type | Description |
|---|---|---|
|
|
| attachMetadata defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.35.0. |
|
|
| 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 defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0. |
|
|
| fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. |
|
|
|
jobLabel defines the label to use to retrieve the job name from.
For example if
If the value of this field is empty, the |
|
|
| 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 defines the per-scrape limit on number of labels that will be accepted for a sample. It requires Prometheus >= v2.27.0. |
|
|
| 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 defines the per-scrape limit on length of labels value that will be accepted for a sample. It requires Prometheus >= v2.27.0. |
|
|
|
namespaceSelector defines in which namespace(s) Prometheus should discover the pods. By default, the pods are discovered in the same namespace as the |
|
|
| 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 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 defines how to scrape metrics from the selected pods. |
|
|
| PodMetricsEndpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus. |
|
|
|
podTargetLabels defines the labels which are transferred from the associated Kubernetes |
|
|
| sampleLimit defines a per-scrape limit on the number of scraped samples that will be accepted. |
|
|
| scrapeClass defines the scrape class to apply. |
|
|
| scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.
Notice: |
|
|
| 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 defines the label selector to select the Kubernetes |
|
|
| 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 defines a limit on the number of scraped targets that will be accepted. |
7.1.2. .spec.attachMetadata Copy linkLink copied to clipboard!
- Description
attachMetadata defines additional metadata which is added to the discovered targets.
It requires Prometheus >= v2.35.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| node when set to true, Prometheus attaches node metadata to the discovered targets.
The Prometheus service account must have the |
7.1.3. .spec.namespaceSelector Copy linkLink copied to clipboard!
- Description
-
namespaceSelector defines in which namespace(s) Prometheus should discover the pods. By default, the pods are discovered in the same namespace as the
PodMonitorobject but it is possible to select pods across different/all namespaces. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them. |
|
|
| matchNames defines the list of namespace names to select from. |
7.1.4. .spec.podMetricsEndpoints Copy linkLink copied to clipboard!
- Description
- podMetricsEndpoints defines how to scrape metrics from the selected pods.
- Type
-
array
7.1.5. .spec.podMetricsEndpoints[] Copy linkLink copied to clipboard!
- Description
- PodMetricsEndpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| authorization configures the Authorization header credentials used by the client.
Cannot be set at the same time as |
|
|
| basicAuth defines the Basic Authentication credentials used by the client.
Cannot be set at the same time as |
|
|
| 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
Deprecated: use |
|
|
| enableHttp2 can be used to disable HTTP2. |
|
|
| 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 defines whether the client should follow HTTP 3xx redirects. |
|
|
| honorLabels when true preserves the metric’s labels when they collide with the target’s labels. |
|
|
| honorTimestamps defines whether Prometheus preserves the timestamps when exposed by the target. |
|
|
| interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval. |
|
|
| metricRelabelings defines the relabeling rules to apply to the samples before ingestion. |
|
|
| 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 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 defines the OAuth2 settings used by the client. It requires Prometheus >= 2.27.0.
Cannot be set at the same time as |
|
|
| params define optional HTTP URL parameters. |
|
|
| |
|
|
| path defines the HTTP path from which to scrape for metrics.
If empty, Prometheus uses the default value (e.g. |
|
|
|
port defines the If the pod doesn’t expose a port with the same name, it will result in no targets being discovered.
If a
It takes precedence over the |
|
|
|
portNumber defines the
The
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 In practice Prometheus will select targets for which the matches the target’s __meta_kubernetes_pod_container_port_number. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| 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 More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config |
|
|
| 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 defines the HTTP scheme to use for scraping. |
|
|
| 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 defines the name or number of the target port of the Deprecated: use 'port' or 'portNumber' instead. |
|
|
| tlsConfig defines the TLS configuration used by the client. |
|
|
|
trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if It requires Prometheus >= v2.48.0. |
7.1.6. .spec.podMetricsEndpoints[].authorization Copy linkLink copied to clipboard!
- Description
authorization configures the Authorization header credentials used by the client.
Cannot be set at the same time as
basicAuth,bearerTokenSecretoroauth2.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
7.1.7. .spec.podMetricsEndpoints[].authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.8. .spec.podMetricsEndpoints[].basicAuth Copy linkLink copied to clipboard!
- Description
basicAuth defines the Basic Authentication credentials used by the client.
Cannot be set at the same time as
authorization,bearerTokenSecretoroauth2.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
7.1.9. .spec.podMetricsEndpoints[].basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.10. .spec.podMetricsEndpoints[].basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.11. .spec.podMetricsEndpoints[].bearerTokenSecret Copy linkLink copied to clipboard!
- 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,basicAuthoroauth2.Deprecated: use
authorizationinstead.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.12. .spec.podMetricsEndpoints[].metricRelabelings Copy linkLink copied to clipboard!
- Description
- metricRelabelings defines the relabeling rules to apply to the samples before ingestion.
- Type
-
array
7.1.13. .spec.podMetricsEndpoints[].metricRelabelings[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
7.1.14. .spec.podMetricsEndpoints[].oauth2 Copy linkLink copied to clipboard!
- 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,basicAuthorbearerTokenSecret.- Type
-
object - Required
-
clientId -
clientSecret -
tokenUrl
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
7.1.15. .spec.podMetricsEndpoints[].oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
7.1.16. .spec.podMetricsEndpoints[].oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
7.1.17. .spec.podMetricsEndpoints[].oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.18. .spec.podMetricsEndpoints[].oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.19. .spec.podMetricsEndpoints[].oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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
7.1.20. .spec.podMetricsEndpoints[].oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
7.1.21. .spec.podMetricsEndpoints[].oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.22. .spec.podMetricsEndpoints[].oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
7.1.23. .spec.podMetricsEndpoints[].oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
7.1.24. .spec.podMetricsEndpoints[].oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
7.1.25. .spec.podMetricsEndpoints[].oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.26. .spec.podMetricsEndpoints[].oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
7.1.27. .spec.podMetricsEndpoints[].oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
7.1.28. .spec.podMetricsEndpoints[].oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.29. .spec.podMetricsEndpoints[].oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.30. .spec.podMetricsEndpoints[].params Copy linkLink copied to clipboard!
- Description
- params define optional HTTP URL parameters.
- Type
-
object
7.1.31. .spec.podMetricsEndpoints[].proxyConnectHeader Copy linkLink copied to clipboard!
- 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
7.1.32. .spec.podMetricsEndpoints[].proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
7.1.33. .spec.podMetricsEndpoints[].proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.34. .spec.podMetricsEndpoints[].relabelings Copy linkLink copied to clipboard!
- 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_namelabel.More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
- Type
-
array
7.1.35. .spec.podMetricsEndpoints[].relabelings[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
7.1.36. .spec.podMetricsEndpoints[].tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration used by the client.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
7.1.37. .spec.podMetricsEndpoints[].tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
7.1.38. .spec.podMetricsEndpoints[].tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
7.1.39. .spec.podMetricsEndpoints[].tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.40. .spec.podMetricsEndpoints[].tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
7.1.41. .spec.podMetricsEndpoints[].tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
7.1.42. .spec.podMetricsEndpoints[].tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.43. .spec.podMetricsEndpoints[].tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.44. .spec.selector Copy linkLink copied to clipboard!
- Description
-
selector defines the label selector to select the Kubernetes
Podobjects to scrape metrics from. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
7.1.45. .spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
7.1.46. .spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
7.1.47. .status Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource. |
|
|
| WorkloadBinding is a link between a configuration resource and a workload resource. |
7.1.48. .status.bindings Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- WorkloadBinding is a link between a configuration resource and a workload resource.
- Type
-
object - Required
-
group -
name -
namespace -
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| conditions defines the current state of the configuration resource when bound to the referenced Workload object. |
|
|
| ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler. |
|
|
| group defines the group of the referenced resource. |
|
|
| name defines the name of the referenced object. |
|
|
| namespace defines the namespace of the referenced object. |
|
|
| resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager). |
7.1.50. .status.bindings[].conditions Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
- Type
-
object - Required
-
lastTransitionTime -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastTransitionTime defines the time of the last update to the current status property. |
|
|
| message defines the human-readable message indicating details for the condition’s last transition. |
|
|
|
observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if |
|
|
| reason for the condition’s last transition. |
|
|
| status of the condition. |
|
|
| type of the condition being reported. Currently, only "Accepted" is supported. |
7.2. API endpoints Copy linkLink copied to clipboard!
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 Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind PodMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
7.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of PodMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind PodMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
7.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the PodMonitor |
- HTTP method
-
DELETE - Description
- delete a PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified PodMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
7.2.4. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the PodMonitor |
- HTTP method
-
GET - Description
- read status of the specified PodMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 8. Probe [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
Probecustom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).The
Proberesource 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.PrometheusandPrometheusAgentobjects selectProbeobjects using label and namespace selectors.- Type
-
object - Required
-
spec
-
8.1. Specification Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec defines the specification of desired Ingress selection for target discovery by Prometheus. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- spec defines the specification of desired Ingress selection for target discovery by Prometheus.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| authorization section for this endpoint |
|
|
| basicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint |
|
|
| 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 defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0. |
|
|
| fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. |
|
|
| interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used. |
|
|
| jobName assigned to scraped metrics by default. |
|
|
| 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 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 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 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 defines the RelabelConfig to apply to samples before ingestion. |
|
|
| 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 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 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 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 for the URL. Only valid in Prometheus versions 2.27.0 and newer. |
|
|
|
params defines the list of HTTP query parameters for the scrape. Please note that the |
|
|
| ProbeParam defines specification of extra parameters for a Probe. |
|
|
| 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 defines per-scrape limit on number of scraped samples that will be accepted. |
|
|
| scrapeClass defines the scrape class to apply. |
|
|
| scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.
Notice: |
|
|
| 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 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 defines a limit on the number of scraped targets that will be accepted. |
|
|
| targets defines a set of static or dynamically discovered targets to probe. |
|
|
| tlsConfig defines the TLS configuration to use when scraping the endpoint. |
8.1.2. .spec.authorization Copy linkLink copied to clipboard!
- Description
- authorization section for this endpoint
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
8.1.3. .spec.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.4. .spec.basicAuth Copy linkLink copied to clipboard!
- Description
- basicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
8.1.5. .spec.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.6. .spec.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.7. .spec.bearerTokenSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.8. .spec.metricRelabelings Copy linkLink copied to clipboard!
- Description
- metricRelabelings defines the RelabelConfig to apply to samples before ingestion.
- Type
-
array
8.1.9. .spec.metricRelabelings[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
8.1.10. .spec.oauth2 Copy linkLink copied to clipboard!
- Description
- oauth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
- Type
-
object - Required
-
clientId -
clientSecret -
tokenUrl
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
8.1.11. .spec.oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
8.1.12. .spec.oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
8.1.13. .spec.oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.14. .spec.oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.15. .spec.oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
8.1.17. .spec.oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.18. .spec.oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
8.1.19. .spec.oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
8.1.20. .spec.oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
8.1.21. .spec.oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.22. .spec.oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
8.1.23. .spec.oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
8.1.24. .spec.oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.25. .spec.oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.26. .spec.params Copy linkLink copied to clipboard!
- Description
-
params defines the list of HTTP query parameters for the scrape. Please note that the
.spec.modulefield takes precedence over themoduleparameter from this list when both are defined. The module name must be added using Module under ProbeSpec. - Type
-
array
8.1.27. .spec.params[] Copy linkLink copied to clipboard!
- Description
- ProbeParam defines specification of extra parameters for a Probe.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| name defines the parameter name |
|
|
| values defines the parameter values |
8.1.28. .spec.prober Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 to collect metrics from. Defaults to |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scheme defines the HTTP scheme to use when scraping the prober. |
|
|
| url defines the address of the prober.
Unlike what the name indicates, the value should be in the form of |
8.1.29. .spec.prober.proxyConnectHeader Copy linkLink copied to clipboard!
- 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{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
8.1.31. .spec.prober.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.32. .spec.targets Copy linkLink copied to clipboard!
- Description
- targets defines a set of static or dynamically discovered targets to probe.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
ingress defines the Ingress objects to probe and the relabeling configuration. If |
|
|
|
staticConfig defines the static list of targets to probe and the relabeling configuration. If |
8.1.33. .spec.targets.ingress Copy linkLink copied to clipboard!
- Description
-
ingress defines the Ingress objects to probe and the relabeling configuration. If
staticConfigis also defined,staticConfigtakes precedence. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| namespaceSelector defines from which namespaces to select Ingress objects. |
|
|
|
relabelingConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the |
|
|
| 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 to select the Ingress objects. |
8.1.34. .spec.targets.ingress.namespaceSelector Copy linkLink copied to clipboard!
- Description
- namespaceSelector defines from which namespaces to select Ingress objects.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them. |
|
|
| matchNames defines the list of namespace names to select from. |
8.1.35. .spec.targets.ingress.relabelingConfigs Copy linkLink copied to clipboard!
- 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_addresslabel. It can be used to customize the probed URL. The original scrape job’s name is available via the\__tmp_prometheus_job_namelabel. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config - Type
-
array
8.1.36. .spec.targets.ingress.relabelingConfigs[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
8.1.37. .spec.targets.ingress.selector Copy linkLink copied to clipboard!
- Description
- selector to select the Ingress objects.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
8.1.38. .spec.targets.ingress.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
8.1.39. .spec.targets.ingress.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
8.1.40. .spec.targets.staticConfig Copy linkLink copied to clipboard!
- Description
-
staticConfig defines the static list of targets to probe and the relabeling configuration. If
ingressis also defined,staticConfigtakes precedence. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| labels defines all labels assigned to all metrics scraped from the targets. |
|
|
| 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 |
|
|
| 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 defines the list of hosts to probe. |
8.1.41. .spec.targets.staticConfig.relabelingConfigs Copy linkLink copied to clipboard!
- 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
8.1.42. .spec.targets.staticConfig.relabelingConfigs[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
8.1.43. .spec.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when scraping the endpoint.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
8.1.44. .spec.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
8.1.45. .spec.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
8.1.46. .spec.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.47. .spec.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
8.1.48. .spec.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
8.1.49. .spec.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.50. .spec.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
8.1.51. .status Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource. |
|
|
| WorkloadBinding is a link between a configuration resource and a workload resource. |
8.1.52. .status.bindings Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- WorkloadBinding is a link between a configuration resource and a workload resource.
- Type
-
object - Required
-
group -
name -
namespace -
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| conditions defines the current state of the configuration resource when bound to the referenced Workload object. |
|
|
| ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler. |
|
|
| group defines the group of the referenced resource. |
|
|
| name defines the name of the referenced object. |
|
|
| namespace defines the namespace of the referenced object. |
|
|
| resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager). |
8.1.54. .status.bindings[].conditions Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
- Type
-
object - Required
-
lastTransitionTime -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastTransitionTime defines the time of the last update to the current status property. |
|
|
| message defines the human-readable message indicating details for the condition’s last transition. |
|
|
|
observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if |
|
|
| reason for the condition’s last transition. |
|
|
| status of the condition. |
|
|
| type of the condition being reported. Currently, only "Accepted" is supported. |
8.2. API endpoints Copy linkLink copied to clipboard!
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 Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind Probe
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
8.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of Probe
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind Probe
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a Probe
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
8.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Probe |
- HTTP method
-
DELETE - Description
- delete a Probe
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified Probe
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified Probe
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified Probe
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
8.2.4. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Probe |
- HTTP method
-
GET - Description
- read status of the specified Probe
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified Probe
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified Probe
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
Chapter 9. Prometheus [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
Prometheuscustom 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
Prometheusresource, the Operator deploys one or severalStatefulSetobjects 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,ProbeandPrometheusRuleobjects 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 Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | 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. |
|
|
| 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 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. |
|
|
| Argument as part of the AdditionalArgs list. |
|
|
| 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 defines the Pods' affinity scheduling rules if specified. |
|
|
| alerting defines the settings related to Alertmanager. |
|
|
| 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 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 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 |
|
|
| 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 is deprecated: use 'spec.image' instead. |
|
|
| 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 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 |
|
|
| 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: * Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. |
|
|
| A single application container that you want to run within a pod. |
|
|
| convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.4.0. |
|
|
|
disableCompaction when true, the Prometheus compaction is disabled. When |
|
|
| dnsConfig defines the DNS configuration for the pods. |
|
|
| dnsPolicy defines the DNS policy for the pods. |
|
|
| 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 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 defines the Prometheus to be used as a receiver for the OTLP Metrics protocol.
Note that the OTLP receiver endpoint is automatically enabled if It requires Prometheus >= v2.47.0. |
|
|
| 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 defines whether information about services should be injected into pod’s environment variables |
|
|
| 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 |
|
|
|
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 It requires Prometheus >= v2.47.0.
When both |
|
|
|
enforcedLabelLimit when defined specifies a global limit on the number of labels per sample. The value overrides any It requires Prometheus >= v2.27.0.
When both |
|
|
|
enforcedLabelNameLengthLimit when defined specifies a global limit on the length of labels name per sample. The value overrides any It requires Prometheus >= v2.27.0.
When both |
|
|
|
enforcedLabelValueLengthLimit when not null defines a global limit on the length of labels value per sample. The value overrides any It requires Prometheus >= v2.27.0.
When both |
|
|
| enforcedNamespaceLabel when not empty, a label will be added to:
1. All metrics scraped from
The label will not added for objects referenced in
The label’s name is this field’s value. The label’s value is the namespace of the |
|
|
|
enforcedSampleLimit when defined specifies a global limit on the number of scraped samples that will be accepted. This overrides any It is meant to be used by admins to keep the overall number of samples/series under a desired limit.
When both |
|
|
|
enforcedTargetLimit when defined specifies a global limit on the number of scraped targets. The value overrides any It is meant to be used by admins to to keep the overall number of targets under a desired limit.
When both |
|
|
| evaluationInterval defines the interval between rule evaluations. Default: "30s" |
|
|
| 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 |
|
|
| ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object. |
|
|
|
exemplars related settings that are runtime reloadable. It requires to enable the |
|
|
|
externalLabels defines the labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager). Labels defined by |
|
|
| 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 defines the optional list of hosts and IPs that will be injected into the Pod’s hosts file if specified. |
|
|
| HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file. |
|
|
| 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 |
|
|
| 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 |
|
|
|
ignoreNamespaceSelectors when true, |
|
|
|
image defines the container image name for Prometheus. If specified, it takes precedence over the
Specifying
If neither |
|
|
| 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 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 |
|
|
| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. |
|
|
| 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: * Overriding init containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. |
|
|
| A single application container that you want to run within a pod. |
|
|
| 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 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 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 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 when true, the Prometheus server listens on the loopback address instead of the Pod IP’s address. |
|
|
| logFormat for Log level for Prometheus and the config-reloader sidecar. |
|
|
| logLevel for Prometheus and the config-reloader sidecar. |
|
|
|
maximumStartupDurationSeconds defines the maximum time that the |
|
|
| 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 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 defines the validation scheme for metric and label names. It requires Prometheus >= v2.55.0. |
|
|
| nodeSelector defines on which Nodes the Pods are scheduled. |
|
|
| otlp defines the settings related to the OTLP receiver feature. It requires Prometheus >= v2.55.0. |
|
|
|
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, |
|
|
| 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 defines when a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects. |
|
|
| 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 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 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 defines the podMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.
If |
|
|
|
podTargetLabels are appended to the |
|
|
| portName used for the pods and governing service. Default: "web" |
|
|
| priorityClassName assigned to the Pods. |
|
|
| 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 defines the probes to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.
If |
|
|
|
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 defines the list of PrometheusRule objects to which the namespace label enforcement doesn’t apply. This is only relevant when |
|
|
| PrometheusRuleExcludeConfig enables users to configure excluded PrometheusRule names and their namespaces to be ignored while enforcing namespace label for alerts and metrics. |
|
|
| query defines the configuration of the Prometheus query service. |
|
|
| 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 |
|
|
| reloadStrategy defines the strategy used to reload the Prometheus configuration. If not specified, the configuration is reloaded using the /-/reload HTTP endpoint. |
|
|
| remoteRead defines the list of remote read configurations. |
|
|
| RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint. |
|
|
| remoteWrite defines the list of remote write configurations. |
|
|
| RemoteWriteSpec defines the configuration to write samples from Prometheus to a remote endpoint. |
|
|
| remoteWriteReceiverMessageVersions list of the protobuf message versions to accept when receiving the remote writes. It requires Prometheus >= v2.54.0. |
|
|
|
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 defines the number of replicas of each shard to deploy for a Prometheus deployment. Default: 1 |
|
|
| resources defines the resources requests and limits of the 'prometheus' container. |
|
|
| retention defines how long to retain the Prometheus data.
Default: "24h" if |
|
|
| retentionSize defines the maximum number of bytes used by the Prometheus data. |
|
|
| routePrefix defines the route prefix Prometheus registers HTTP handlers for.
This is useful when using |
|
|
| 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 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 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 defines the configuration of the Prometheus rules' engine. |
|
|
| runtime defines the values for the Prometheus process behavior |
|
|
| 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 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. |
|
|
| |
|
|
| scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.
Notice: It requires Prometheus >= v3.5.0. |
|
|
| 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 defines the scrapeConfigs to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.
If Note that the ScrapeConfig custom resource definition is currently at Alpha level. |
|
|
| 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 |
|
|
| scrapeInterval defines interval between consecutive scrapes. Default: "30s" |
|
|
| 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 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 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 |
|
|
| securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext. |
|
|
| serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods. |
|
|
|
serviceDiscoveryRole defines the service discovery role used to discover targets from If set, the value should be either "Endpoints" or "EndpointSlice". If unset, the operator assumes the "Endpoints" role. |
|
|
| 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 defines the serviceMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects.
If |
|
|
|
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 |
|
|
| sha is deprecated: use 'spec.image' instead. The image’s digest can be specified as part of the image name. |
|
|
| 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 defines the number of shards to distribute the scraped targets onto.
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
Users can define their own sharding implementation by setting the
You can also disable sharding on a specific target by setting the |
|
|
| storage defines the storage used by Prometheus. |
|
|
| tag is deprecated: use 'spec.image' instead. The image’s tag can be specified as part of the image name. |
|
|
| 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 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 defines the configuration of the optional Thanos sidecar. |
|
|
| tolerations defines the Pods' tolerations if specified. |
|
|
| The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. |
|
|
| topologySpreadConstraints defines the pod’s topology spread constraints if specified. |
|
|
| |
|
|
| tracingConfig defines tracing in Prometheus. This is an experimental feature, it may change in any upcoming release in a breaking way. |
|
|
| tsdb defines the runtime reloadable configuration of the timeseries database(TSDB). It requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0. |
|
|
| 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 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. |
|
|
| VolumeMount describes a mounting of a Volume within a container. |
|
|
| 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. |
|
|
| Volume represents a named volume in a pod that may be accessed by any container in the pod. |
|
|
| 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 defines the configuration of the Prometheus web server. |
9.1.2. .spec.additionalAlertManagerConfigs Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.3. .spec.additionalAlertRelabelConfigs Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.4. .spec.additionalArgs Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Argument as part of the AdditionalArgs list.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| name of the argument, e.g. "scrape.discovery-reload-interval". |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.7. .spec.affinity Copy linkLink copied to clipboard!
- Description
- affinity defines the Pods' affinity scheduling rules if specified.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Describes node affinity scheduling rules for the pod. |
|
|
| Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
|
|
| Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |
9.1.8. .spec.affinity.nodeAffinity Copy linkLink copied to clipboard!
- Description
- Describes node affinity scheduling rules for the pod.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
|
|
| An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). |
|
|
| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
9.1.9. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
9.1.10. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
- Type
-
object - Required
-
preference -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
| A node selector term, associated with the corresponding weight. |
|
|
| Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |
9.1.11. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference Copy linkLink copied to clipboard!
- Description
- A node selector term, associated with the corresponding weight.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| A list of node selector requirements by node’s labels. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| A list of node selector requirements by node’s fields. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
9.1.12. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s labels.
- Type
-
array
9.1.13. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
9.1.14. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s fields.
- Type
-
array
9.1.15. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
9.1.16. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- Description
- If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
- Type
-
object - Required
-
nodeSelectorTerms
-
| Property | Type | Description |
|---|---|---|
|
|
| Required. A list of node selector terms. The terms are ORed. |
|
|
| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. |
9.1.17. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Copy linkLink copied to clipboard!
- Description
- Required. A list of node selector terms. The terms are ORed.
- Type
-
array
9.1.18. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] Copy linkLink copied to clipboard!
- Description
- A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| A list of node selector requirements by node’s labels. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| A list of node selector requirements by node’s fields. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
9.1.19. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s labels.
- Type
-
array
9.1.20. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
9.1.21. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s fields.
- Type
-
array
9.1.22. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
9.1.23. .spec.affinity.podAffinity Copy linkLink copied to clipboard!
- Description
- Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
|
|
| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) |
|
|
| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
|
|
| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running |
9.1.24. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
9.1.25. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- Type
-
object - Required
-
podAffinityTerm -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
| Required. A pod affinity term, associated with the corresponding weight. |
|
|
| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
9.1.26. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Copy linkLink copied to clipboard!
- Description
- Required. A pod affinity term, associated with the corresponding weight.
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
9.1.27. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.28. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.29. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.30. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.31. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.33. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
9.1.34. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
9.1.35. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.36. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.37. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.38. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.39. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.40. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.41. .spec.affinity.podAntiAffinity Copy linkLink copied to clipboard!
- Description
- Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and 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. |
|
|
| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) |
|
|
| If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
|
|
| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running |
9.1.42. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
9.1.43. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- Type
-
object - Required
-
podAffinityTerm -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
| Required. A pod affinity term, associated with the corresponding weight. |
|
|
| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
9.1.44. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Copy linkLink copied to clipboard!
- Description
- Required. A pod affinity term, associated with the corresponding weight.
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
9.1.45. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.46. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.48. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.51. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
9.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
9.1.53. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.54. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.55. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.56. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.57. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.58. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.59. .spec.alerting Copy linkLink copied to clipboard!
- Description
- alerting defines the settings related to Alertmanager.
- Type
-
object - Required
-
alertmanagers
-
| Property | Type | Description |
|---|---|---|
|
|
| alertmanagers endpoints where Prometheus should send alerts to. |
|
|
| AlertmanagerEndpoints defines a selection of a single Endpoints object containing Alertmanager IPs to fire alerts against. |
9.1.60. .spec.alerting.alertmanagers Copy linkLink copied to clipboard!
- Description
- alertmanagers endpoints where Prometheus should send alerts to.
- Type
-
array
9.1.61. .spec.alerting.alertmanagers[] Copy linkLink copied to clipboard!
- Description
- AlertmanagerEndpoints defines a selection of a single Endpoints object containing Alertmanager IPs to fire alerts against.
- Type
-
object - Required
-
name -
port
-
| Property | Type | Description |
|---|---|---|
|
|
| alertRelabelings defines the relabeling configs applied before sending alerts to a specific Alertmanager. It requires Prometheus >= v2.51.0. |
|
|
| 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 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 section for Alertmanager.
Cannot be set at the same time as |
|
|
| basicAuth configuration for Alertmanager.
Cannot be set at the same time as |
|
|
| bearerTokenFile defines the file to read bearer token for Alertmanager.
Cannot be set at the same time as
Deprecated: this will be removed in a future release. Prefer using |
|
|
| enableHttp2 defines whether to enable HTTP2. |
|
|
| name of the Endpoints object in the namespace. |
|
|
| namespace of the Endpoints object. If not set, the object will be discovered in the namespace of the Prometheus object. |
|
|
| 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 defines the prefix for the HTTP path alerts are pushed to. |
|
|
| port on which the Alertmanager API is exposed. |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| relabelings defines the relabel configuration applied to the discovered Alertmanagers. |
|
|
| 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 defines the HTTP scheme to use when sending alerts. |
|
|
| sigv4 defines AWS’s Signature Verification 4 for the URL. It requires Prometheus >= v2.48.0.
Cannot be set at the same time as |
|
|
| timeout defines a per-target Alertmanager timeout when pushing alerts. |
|
|
| tlsConfig to use for Alertmanager. |
9.1.62. .spec.alerting.alertmanagers[].alertRelabelings Copy linkLink copied to clipboard!
- Description
- alertRelabelings defines the relabeling configs applied before sending alerts to a specific Alertmanager. It requires Prometheus >= v2.51.0.
- Type
-
array
9.1.63. .spec.alerting.alertmanagers[].alertRelabelings[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
9.1.64. .spec.alerting.alertmanagers[].authorization Copy linkLink copied to clipboard!
- Description
authorization section for Alertmanager.
Cannot be set at the same time as
basicAuth,bearerTokenFileorsigv4.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
9.1.65. .spec.alerting.alertmanagers[].authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.66. .spec.alerting.alertmanagers[].basicAuth Copy linkLink copied to clipboard!
- Description
basicAuth configuration for Alertmanager.
Cannot be set at the same time as
bearerTokenFile,authorizationorsigv4.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
9.1.67. .spec.alerting.alertmanagers[].basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.68. .spec.alerting.alertmanagers[].basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.69. .spec.alerting.alertmanagers[].proxyConnectHeader Copy linkLink copied to clipboard!
- 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.70. .spec.alerting.alertmanagers[].proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
9.1.71. .spec.alerting.alertmanagers[].proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.72. .spec.alerting.alertmanagers[].relabelings Copy linkLink copied to clipboard!
- Description
- relabelings defines the relabel configuration applied to the discovered Alertmanagers.
- Type
-
array
9.1.73. .spec.alerting.alertmanagers[].relabelings[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
9.1.74. .spec.alerting.alertmanagers[].sigv4 Copy linkLink copied to clipboard!
- 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,bearerTokenFileorauthorization.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
accessKey defines the AWS API key. If not specified, the environment variable |
|
|
| profile defines the named AWS profile used to authenticate. |
|
|
| region defines the AWS region. If blank, the region from the default credentials chain used. |
|
|
| roleArn defines the named AWS profile used to authenticate. |
|
|
|
secretKey defines the AWS API secret. If not specified, the environment variable |
|
|
| useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. It requires Prometheus >= v2.54.0. |
9.1.75. .spec.alerting.alertmanagers[].sigv4.accessKey Copy linkLink copied to clipboard!
- Description
-
accessKey defines the AWS API key. If not specified, the environment variable
AWS_ACCESS_KEY_IDis used. - Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.76. .spec.alerting.alertmanagers[].sigv4.secretKey Copy linkLink copied to clipboard!
- Description
-
secretKey defines the AWS API secret. If not specified, the environment variable
AWS_SECRET_ACCESS_KEYis used. - Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.77. .spec.alerting.alertmanagers[].tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig to use for Alertmanager.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| caFile defines the path to the CA cert in the Prometheus container to use for the targets. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| certFile defines the path to the client cert file in the Prometheus container for the targets. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keyFile defines the path to the client key file in the Prometheus container for the targets. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
9.1.78. .spec.alerting.alertmanagers[].tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.79. .spec.alerting.alertmanagers[].tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.80. .spec.alerting.alertmanagers[].tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.81. .spec.alerting.alertmanagers[].tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.82. .spec.alerting.alertmanagers[].tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.83. .spec.alerting.alertmanagers[].tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.84. .spec.alerting.alertmanagers[].tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.85. .spec.apiserverConfig Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| authorization section for the API server.
Cannot be set at the same time as |
|
|
| basicAuth configuration for the API server.
Cannot be set at the same time as |
|
|
|
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 |
|
|
| bearerTokenFile defines the file to read bearer token for accessing apiserver.
Cannot be set at the same time as
Deprecated: this will be removed in a future release. Prefer using |
|
|
| host defines the Kubernetes API address consisting of a hostname or IP address followed by an optional port number. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| tlsConfig to use for the API server. |
9.1.86. .spec.apiserverConfig.authorization Copy linkLink copied to clipboard!
- Description
authorization section for the API server.
Cannot be set at the same time as
basicAuth,bearerToken, orbearerTokenFile.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
|
credentialsFile defines the file to read a secret from, mutually exclusive with |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
9.1.87. .spec.apiserverConfig.authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.88. .spec.apiserverConfig.basicAuth Copy linkLink copied to clipboard!
- Description
basicAuth configuration for the API server.
Cannot be set at the same time as
authorization,bearerToken, orbearerTokenFile.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
9.1.89. .spec.apiserverConfig.basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.90. .spec.apiserverConfig.basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.91. .spec.apiserverConfig.proxyConnectHeader Copy linkLink copied to clipboard!
- 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{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
9.1.93. .spec.apiserverConfig.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.94. .spec.apiserverConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig to use for the API server.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| caFile defines the path to the CA cert in the Prometheus container to use for the targets. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| certFile defines the path to the client cert file in the Prometheus container for the targets. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keyFile defines the path to the client key file in the Prometheus container for the targets. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
9.1.95. .spec.apiserverConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.96. .spec.apiserverConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.97. .spec.apiserverConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.98. .spec.apiserverConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.99. .spec.apiserverConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.100. .spec.apiserverConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.101. .spec.apiserverConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.102. .spec.arbitraryFSAccessThroughSMs Copy linkLink copied to clipboard!
- 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
bearerTokenFilevalue (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. Settingspec.arbitraryFSAccessThroughSMto 'true' would prevent the attack. Users should instead provide the credentials using thespec.bearerTokenSecretfield. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 Copy linkLink copied to clipboard!
- 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-sidecarOverriding 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[] Copy linkLink copied to clipboard!
- Description
- A single application container that you want to run within a pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Arguments to the entrypoint. The 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 |
|
|
| 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 |
|
|
| List of environment variables to set in the container. Cannot be updated. |
|
|
| EnvVar represents an environment variable present in a Container. |
|
|
| List of sources to populate environment variables in the container. The keys defined within a source 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. |
|
|
| EnvFromSource represents the source of a set of ConfigMaps or Secrets |
|
|
| 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. |
|
|
| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
|
| Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
|
|
| Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
|
|
| List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. |
|
|
| ContainerPort represents a network port in a single container. |
|
|
| 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 |
|
|
| Resources resize policy for the container. |
|
|
| ContainerResizePolicy represents resource resize policy for the container. |
|
|
| Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| 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. |
|
|
| 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. |
|
|
| ContainerRestartRule describes how a container exit is handled. |
|
|
| SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
|
|
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
|
|
| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
|
|
| Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
|
|
| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
|
|
| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
|
| volumeDevices is the list of block devices to be used by the container. |
|
|
| volumeDevice describes a mapping of a raw block device within a container. |
|
|
| Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
| VolumeMount describes a mounting of a Volume within a container. |
|
|
| Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. |
9.1.105. .spec.containers[].env Copy linkLink copied to clipboard!
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
-
array
9.1.106. .spec.containers[].env[] Copy linkLink copied to clipboard!
- Description
- EnvVar represents an environment variable present in a Container.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the environment variable. May consist of any printable ASCII characters except '='. |
|
|
| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
|
|
| Source for the environment variable’s value. Cannot be used if value is not empty. |
9.1.107. .spec.containers[].env[].valueFrom Copy linkLink copied to clipboard!
- Description
- Source for the environment variable’s value. Cannot be used if value is not empty.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Selects a key of a ConfigMap. |
|
|
|
Selects a field of the pod: supports metadata.name, metadata.namespace, |
|
|
| FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled. |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
| Selects a key of a secret in the pod’s namespace |
9.1.108. .spec.containers[].env[].valueFrom.configMapKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a ConfigMap.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.109. .spec.containers[].env[].valueFrom.fieldRef Copy linkLink copied to clipboard!
- Description
-
Selects a field of the pod: supports metadata.name, metadata.namespace,
metadata.labels['<KEY>'],metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
9.1.110. .spec.containers[].env[].valueFrom.fileKeyRef Copy linkLink copied to clipboard!
- Description
- FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
- Type
-
object - Required
-
key -
path -
volumeName
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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. |
|
|
| The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'. |
|
|
| The name of the volume mount containing the env file. |
9.1.111. .spec.containers[].env[].valueFrom.resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
9.1.112. .spec.containers[].env[].valueFrom.secretKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a secret in the pod’s namespace
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.113. .spec.containers[].envFrom Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- EnvFromSource represents the source of a set of ConfigMaps or Secrets
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The ConfigMap to select from |
|
|
| Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='. |
|
|
| The Secret to select from |
9.1.115. .spec.containers[].envFrom[].configMapRef Copy linkLink copied to clipboard!
- Description
- The ConfigMap to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap must be defined |
9.1.116. .spec.containers[].envFrom[].secretRef Copy linkLink copied to clipboard!
- Description
- The Secret to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret must be defined |
9.1.117. .spec.containers[].lifecycle Copy linkLink copied to clipboard!
- Description
- Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
|
|
| PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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 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 Copy linkLink copied to clipboard!
- Description
- PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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.119. .spec.containers[].lifecycle.postStart.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
9.1.120. .spec.containers[].lifecycle.postStart.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
9.1.121. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
9.1.122. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
9.1.123. .spec.containers[].lifecycle.postStart.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
9.1.124. .spec.containers[].lifecycle.postStart.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
9.1.125. .spec.containers[].lifecycle.preStop Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
9.1.127. .spec.containers[].lifecycle.preStop.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
9.1.128. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
9.1.129. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
9.1.130. .spec.containers[].lifecycle.preStop.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
9.1.131. .spec.containers[].lifecycle.preStop.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
9.1.132. .spec.containers[].livenessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
9.1.133. .spec.containers[].livenessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
9.1.134. .spec.containers[].livenessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
9.1.136. .spec.containers[].livenessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
9.1.137. .spec.containers[].livenessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
9.1.138. .spec.containers[].livenessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
9.1.139. .spec.containers[].ports Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ContainerPort represents a network port in a single container.
- Type
-
object - Required
-
containerPort
-
| Property | Type | Description |
|---|---|---|
|
|
| Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
|
|
| What host IP to bind the external port to. |
|
|
| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. |
|
|
| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
|
|
| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |
9.1.141. .spec.containers[].readinessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
9.1.142. .spec.containers[].readinessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
9.1.143. .spec.containers[].readinessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
9.1.145. .spec.containers[].readinessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
9.1.146. .spec.containers[].readinessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
9.1.147. .spec.containers[].readinessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
9.1.148. .spec.containers[].resizePolicy Copy linkLink copied to clipboard!
- Description
- Resources resize policy for the container.
- Type
-
array
9.1.149. .spec.containers[].resizePolicy[] Copy linkLink copied to clipboard!
- Description
- ContainerResizePolicy represents resource resize policy for the container.
- Type
-
object - Required
-
resourceName -
restartPolicy
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. |
|
|
| Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. |
9.1.150. .spec.containers[].resources Copy linkLink copied to clipboard!
- Description
- Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| ResourceClaim references one entry in PodSpec.ResourceClaims. |
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
9.1.151. .spec.containers[].resources.claims Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ContainerRestartRule describes how a container exit is handled.
- Type
-
object - Required
-
action
-
| Property | Type | Description |
|---|---|---|
|
|
| Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container. |
|
|
| Represents the exit codes to check on container exits. |
9.1.155. .spec.containers[].restartPolicyRules[].exitCodes Copy linkLink copied to clipboard!
- Description
- Represents the exit codes to check on container exits.
- Type
-
object - Required
-
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| Specifies the set of values to check for container exit codes. At most 255 elements are allowed. |
9.1.156. .spec.containers[].securityContext Copy linkLink copied to clipboard!
- Description
- SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
9.1.157. .spec.containers[].securityContext.appArmorProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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.158. .spec.containers[].securityContext.capabilities Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Added capabilities |
|
|
| Removed capabilities |
9.1.159. .spec.containers[].securityContext.seLinuxOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Level is SELinux level label that applies to the container. |
|
|
| Role is a SELinux role label that applies to the container. |
|
|
| Type is a SELinux type label that applies to the container. |
|
|
| User is a SELinux user label that applies to the container. |
9.1.160. .spec.containers[].securityContext.seccompProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. |
|
|
| type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
9.1.161. .spec.containers[].securityContext.windowsOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
| GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
| HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
|
|
| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
9.1.162. .spec.containers[].startupProbe Copy linkLink copied to clipboard!
- Description
- StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
9.1.163. .spec.containers[].startupProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
9.1.164. .spec.containers[].startupProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
9.1.166. .spec.containers[].startupProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
9.1.167. .spec.containers[].startupProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
9.1.168. .spec.containers[].startupProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
9.1.169. .spec.containers[].volumeDevices Copy linkLink copied to clipboard!
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
-
array
9.1.170. .spec.containers[].volumeDevices[] Copy linkLink copied to clipboard!
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
-
object - Required
-
devicePath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| devicePath is the path inside of the container that the device will be mapped to. |
|
|
| name must match the name of a persistentVolumeClaim in the pod |
9.1.171. .spec.containers[].volumeMounts Copy linkLink copied to clipboard!
- Description
- Pod volumes to mount into the container’s filesystem. Cannot be updated.
- Type
-
array
9.1.172. .spec.containers[].volumeMounts[] Copy linkLink copied to clipboard!
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). |
|
|
| This must match the Name of a Volume. |
|
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
| 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. |
|
|
| Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
| Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
9.1.173. .spec.dnsConfig Copy linkLink copied to clipboard!
- Description
- dnsConfig defines the DNS configuration for the pods.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. |
|
|
| 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. |
|
|
| PodDNSConfigOption defines DNS resolver options of a pod. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- PodDNSConfigOption defines DNS resolver options of a pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| name is required and must be unique. |
|
|
| value is optional. |
9.1.176. .spec.excludedFromEnforcement Copy linkLink copied to clipboard!
- 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.enforcedNamespaceLabelset to true.- Type
-
array
9.1.177. .spec.excludedFromEnforcement[] Copy linkLink copied to clipboard!
- Description
- ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.
- Type
-
object - Required
-
namespace -
resource
-
| Property | Type | Description |
|---|---|---|
|
|
|
group of the referent. When not specified, it defaults to |
|
|
| name of the referent. When not set, all resources in the namespace are matched. |
|
|
| namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| resource of the referent. |
9.1.178. .spec.exemplars Copy linkLink copied to clipboard!
- Description
-
exemplars related settings that are runtime reloadable. It requires to enable the
exemplar-storagefeature flag to be effective. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| maxSize defines the maximum number of exemplars stored in memory for all series.
exemplar-storage itself must be enabled using the If not set, Prometheus uses its default value. A value of zero or less than zero disables the storage. |
9.1.179. .spec.hostAliases Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| hostnames defines hostnames for the above IP address. |
|
|
| ip defines the IP address of the host file entry. |
9.1.181. .spec.imagePullSecrets Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- A single application container that you want to run within a pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Arguments to the entrypoint. The 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 |
|
|
| 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 |
|
|
| List of environment variables to set in the container. Cannot be updated. |
|
|
| EnvVar represents an environment variable present in a Container. |
|
|
| List of sources to populate environment variables in the container. The keys defined within a source 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. |
|
|
| EnvFromSource represents the source of a set of ConfigMaps or Secrets |
|
|
| 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. |
|
|
| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
|
| Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
|
|
| Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
|
|
| List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. |
|
|
| ContainerPort represents a network port in a single container. |
|
|
| 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 |
|
|
| Resources resize policy for the container. |
|
|
| ContainerResizePolicy represents resource resize policy for the container. |
|
|
| Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| 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. |
|
|
| 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. |
|
|
| ContainerRestartRule describes how a container exit is handled. |
|
|
| SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
|
|
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
|
|
| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
|
|
| Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
|
|
| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
|
|
| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
|
| volumeDevices is the list of block devices to be used by the container. |
|
|
| volumeDevice describes a mapping of a raw block device within a container. |
|
|
| Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
| VolumeMount describes a mounting of a Volume within a container. |
|
|
| Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. |
9.1.185. .spec.initContainers[].env Copy linkLink copied to clipboard!
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
-
array
9.1.186. .spec.initContainers[].env[] Copy linkLink copied to clipboard!
- Description
- EnvVar represents an environment variable present in a Container.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the environment variable. May consist of any printable ASCII characters except '='. |
|
|
| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
|
|
| Source for the environment variable’s value. Cannot be used if value is not empty. |
9.1.187. .spec.initContainers[].env[].valueFrom Copy linkLink copied to clipboard!
- Description
- Source for the environment variable’s value. Cannot be used if value is not empty.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Selects a key of a ConfigMap. |
|
|
|
Selects a field of the pod: supports metadata.name, metadata.namespace, |
|
|
| FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled. |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
| Selects a key of a secret in the pod’s namespace |
9.1.188. .spec.initContainers[].env[].valueFrom.configMapKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a ConfigMap.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.189. .spec.initContainers[].env[].valueFrom.fieldRef Copy linkLink copied to clipboard!
- Description
-
Selects a field of the pod: supports metadata.name, metadata.namespace,
metadata.labels['<KEY>'],metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
9.1.190. .spec.initContainers[].env[].valueFrom.fileKeyRef Copy linkLink copied to clipboard!
- Description
- FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
- Type
-
object - Required
-
key -
path -
volumeName
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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. |
|
|
| The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'. |
|
|
| The name of the volume mount containing the env file. |
9.1.191. .spec.initContainers[].env[].valueFrom.resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
9.1.192. .spec.initContainers[].env[].valueFrom.secretKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a secret in the pod’s namespace
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.193. .spec.initContainers[].envFrom Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- EnvFromSource represents the source of a set of ConfigMaps or Secrets
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The ConfigMap to select from |
|
|
| Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='. |
|
|
| The Secret to select from |
9.1.195. .spec.initContainers[].envFrom[].configMapRef Copy linkLink copied to clipboard!
- Description
- The ConfigMap to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap must be defined |
9.1.196. .spec.initContainers[].envFrom[].secretRef Copy linkLink copied to clipboard!
- Description
- The Secret to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret must be defined |
9.1.197. .spec.initContainers[].lifecycle Copy linkLink copied to clipboard!
- Description
- Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
|
|
| PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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 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.198. .spec.initContainers[].lifecycle.postStart Copy linkLink copied to clipboard!
- Description
- PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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.199. .spec.initContainers[].lifecycle.postStart.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
9.1.200. .spec.initContainers[].lifecycle.postStart.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
9.1.201. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
9.1.202. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
9.1.203. .spec.initContainers[].lifecycle.postStart.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
9.1.204. .spec.initContainers[].lifecycle.postStart.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
9.1.205. .spec.initContainers[].lifecycle.preStop Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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.206. .spec.initContainers[].lifecycle.preStop.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
9.1.207. .spec.initContainers[].lifecycle.preStop.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
9.1.208. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
9.1.209. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
9.1.210. .spec.initContainers[].lifecycle.preStop.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
9.1.211. .spec.initContainers[].lifecycle.preStop.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
9.1.212. .spec.initContainers[].livenessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
9.1.213. .spec.initContainers[].livenessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
9.1.214. .spec.initContainers[].livenessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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.215. .spec.initContainers[].livenessProbe.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
9.1.216. .spec.initContainers[].livenessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
9.1.217. .spec.initContainers[].livenessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
9.1.218. .spec.initContainers[].livenessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
9.1.219. .spec.initContainers[].ports Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ContainerPort represents a network port in a single container.
- Type
-
object - Required
-
containerPort
-
| Property | Type | Description |
|---|---|---|
|
|
| Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
|
|
| What host IP to bind the external port to. |
|
|
| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. |
|
|
| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
|
|
| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |
9.1.221. .spec.initContainers[].readinessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
9.1.222. .spec.initContainers[].readinessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
9.1.223. .spec.initContainers[].readinessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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.224. .spec.initContainers[].readinessProbe.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
9.1.225. .spec.initContainers[].readinessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
9.1.226. .spec.initContainers[].readinessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
9.1.227. .spec.initContainers[].readinessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
9.1.228. .spec.initContainers[].resizePolicy Copy linkLink copied to clipboard!
- Description
- Resources resize policy for the container.
- Type
-
array
9.1.229. .spec.initContainers[].resizePolicy[] Copy linkLink copied to clipboard!
- Description
- ContainerResizePolicy represents resource resize policy for the container.
- Type
-
object - Required
-
resourceName -
restartPolicy
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. |
|
|
| Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. |
9.1.230. .spec.initContainers[].resources Copy linkLink copied to clipboard!
- Description
- Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| ResourceClaim references one entry in PodSpec.ResourceClaims. |
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
9.1.231. .spec.initContainers[].resources.claims Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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.234. .spec.initContainers[].restartPolicyRules[] Copy linkLink copied to clipboard!
- Description
- ContainerRestartRule describes how a container exit is handled.
- Type
-
object - Required
-
action
-
| Property | Type | Description |
|---|---|---|
|
|
| Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container. |
|
|
| Represents the exit codes to check on container exits. |
9.1.235. .spec.initContainers[].restartPolicyRules[].exitCodes Copy linkLink copied to clipboard!
- Description
- Represents the exit codes to check on container exits.
- Type
-
object - Required
-
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| Specifies the set of values to check for container exit codes. At most 255 elements are allowed. |
9.1.236. .spec.initContainers[].securityContext Copy linkLink copied to clipboard!
- Description
- SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
9.1.237. .spec.initContainers[].securityContext.appArmorProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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.238. .spec.initContainers[].securityContext.capabilities Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Added capabilities |
|
|
| Removed capabilities |
9.1.239. .spec.initContainers[].securityContext.seLinuxOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Level is SELinux level label that applies to the container. |
|
|
| Role is a SELinux role label that applies to the container. |
|
|
| Type is a SELinux type label that applies to the container. |
|
|
| User is a SELinux user label that applies to the container. |
9.1.240. .spec.initContainers[].securityContext.seccompProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. |
|
|
| type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
9.1.241. .spec.initContainers[].securityContext.windowsOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
| GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
| HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
|
|
| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
9.1.242. .spec.initContainers[].startupProbe Copy linkLink copied to clipboard!
- Description
- StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
9.1.243. .spec.initContainers[].startupProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
9.1.244. .spec.initContainers[].startupProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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.245. .spec.initContainers[].startupProbe.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
9.1.246. .spec.initContainers[].startupProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
9.1.247. .spec.initContainers[].startupProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
9.1.248. .spec.initContainers[].startupProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
9.1.249. .spec.initContainers[].volumeDevices Copy linkLink copied to clipboard!
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
-
array
9.1.250. .spec.initContainers[].volumeDevices[] Copy linkLink copied to clipboard!
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
-
object - Required
-
devicePath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| devicePath is the path inside of the container that the device will be mapped to. |
|
|
| name must match the name of a persistentVolumeClaim in the pod |
9.1.251. .spec.initContainers[].volumeMounts Copy linkLink copied to clipboard!
- Description
- Pod volumes to mount into the container’s filesystem. Cannot be updated.
- Type
-
array
9.1.252. .spec.initContainers[].volumeMounts[] Copy linkLink copied to clipboard!
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). |
|
|
| This must match the Name of a Volume. |
|
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
| 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. |
|
|
| Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
| Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
9.1.253. .spec.otlp Copy linkLink copied to clipboard!
- Description
- otlp defines the settings related to the OTLP receiver feature. It requires Prometheus >= v2.55.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| convertHistogramsToNHCB defines optional translation of OTLP explicit bucket histograms into native histograms with custom buckets. It requires Prometheus >= v3.4.0. |
|
|
|
ignoreResourceAttributes defines the list of OpenTelemetry resource attributes to ignore when
It requires |
|
|
|
keepIdentifyingResourceAttributes enables adding It requires Prometheus >= v3.1.0. |
|
|
|
promoteAllResourceAttributes promotes all resource attributes to metric labels except the ones defined in
Cannot be true when |
|
|
|
promoteResourceAttributes defines the list of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. Cannot be defined when |
|
|
| 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 defines how the OTLP receiver endpoint translates the incoming metrics. It requires Prometheus >= v3.0.0. |
9.1.254. .spec.persistentVolumeClaimRetentionPolicy Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
|
WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of |
|
|
|
WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of |
9.1.255. .spec.podMetadata Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.257. .spec.podMonitorNamespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.258. .spec.podMonitorNamespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.259. .spec.podMonitorSelector Copy linkLink copied to clipboard!
- 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.probeSelectorandspec.scrapeConfigSelectorare 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 theprometheus.yaml.gzkey. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to usespec.additionalScrapeConfigsinstead.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.260. .spec.podMonitorSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.261. .spec.podMonitorSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.262. .spec.probeNamespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.263. .spec.probeNamespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.264. .spec.probeNamespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.265. .spec.probeSelector Copy linkLink copied to clipboard!
- 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.probeSelectorandspec.scrapeConfigSelectorare 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 theprometheus.yaml.gzkey. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to usespec.additionalScrapeConfigsinstead.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.266. .spec.probeSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.267. .spec.probeSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.268. .spec.prometheusRulesExcludedFromEnforce Copy linkLink copied to clipboard!
- Description
-
prometheusRulesExcludedFromEnforce defines the list of PrometheusRule objects to which the namespace label enforcement doesn’t apply. This is only relevant when
spec.enforcedNamespaceLabelis set to true. Deprecated: usespec.excludedFromEnforcementinstead. - Type
-
array
9.1.269. .spec.prometheusRulesExcludedFromEnforce[] Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| ruleName defines the name of the excluded PrometheusRule object. |
|
|
| ruleNamespace defines the namespace of the excluded PrometheusRule object. |
9.1.270. .spec.query Copy linkLink copied to clipboard!
- Description
- query defines the configuration of the Prometheus query service.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| lookbackDelta defines the delta difference allowed for retrieving metrics during expression evaluations. |
|
|
| maxConcurrency defines the number of concurrent queries that can be run at once. |
|
|
| 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 defines the maximum time a query may take before being aborted. |
9.1.271. .spec.remoteRead Copy linkLink copied to clipboard!
- Description
- remoteRead defines the list of remote read configurations.
- Type
-
array
9.1.272. .spec.remoteRead[] Copy linkLink copied to clipboard!
- Description
- RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
- Type
-
object - Required
-
url
-
| Property | Type | Description |
|---|---|---|
|
|
| authorization section for the URL. It requires Prometheus >= v2.26.0.
Cannot be set at the same time as |
|
|
| basicAuth configuration for the URL.
Cannot be set at the same time as |
|
|
|
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 |
|
|
| 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 |
|
|
| filterExternalLabels defines whether to use the external labels as selectors for the remote read endpoint. It requires Prometheus >= v2.34.0. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.26.0. |
|
|
| 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 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 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 configuration for the URL. It requires Prometheus >= v2.27.0.
Cannot be set at the same time as |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| readRecent defines whether reads should be made for queries for time ranges that the local storage should have complete data for. |
|
|
| remoteTimeout defines the timeout for requests to the remote read endpoint. |
|
|
| requiredMatchers defines an optional list of equality matchers which have to be present in a selector to query the remote read endpoint. |
|
|
| tlsConfig to use for the URL. |
|
|
| url defines the URL of the endpoint to query from. |
9.1.273. .spec.remoteRead[].authorization Copy linkLink copied to clipboard!
- Description
authorization section for the URL.
It requires Prometheus >= v2.26.0.
Cannot be set at the same time as
basicAuth, oroauth2.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
|
credentialsFile defines the file to read a secret from, mutually exclusive with |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
9.1.274. .spec.remoteRead[].authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.275. .spec.remoteRead[].basicAuth Copy linkLink copied to clipboard!
- Description
basicAuth configuration for the URL.
Cannot be set at the same time as
authorization, oroauth2.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
9.1.276. .spec.remoteRead[].basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.277. .spec.remoteRead[].basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.278. .spec.remoteRead[].oauth2 Copy linkLink copied to clipboard!
- Description
oauth2 configuration for the URL.
It requires Prometheus >= v2.27.0.
Cannot be set at the same time as
authorization, orbasicAuth.- Type
-
object - Required
-
clientId -
clientSecret -
tokenUrl
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
9.1.279. .spec.remoteRead[].oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.280. .spec.remoteRead[].oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.281. .spec.remoteRead[].oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.282. .spec.remoteRead[].oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.283. .spec.remoteRead[].oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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.284. .spec.remoteRead[].oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
9.1.285. .spec.remoteRead[].oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.286. .spec.remoteRead[].oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
9.1.287. .spec.remoteRead[].oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.288. .spec.remoteRead[].oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.289. .spec.remoteRead[].oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.290. .spec.remoteRead[].oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.291. .spec.remoteRead[].oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.292. .spec.remoteRead[].oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.293. .spec.remoteRead[].oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.294. .spec.remoteRead[].proxyConnectHeader Copy linkLink copied to clipboard!
- 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{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
9.1.296. .spec.remoteRead[].proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.297. .spec.remoteRead[].tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig to use for the URL.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| caFile defines the path to the CA cert in the Prometheus container to use for the targets. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| certFile defines the path to the client cert file in the Prometheus container for the targets. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keyFile defines the path to the client key file in the Prometheus container for the targets. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
9.1.298. .spec.remoteRead[].tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.299. .spec.remoteRead[].tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.300. .spec.remoteRead[].tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.301. .spec.remoteRead[].tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.302. .spec.remoteRead[].tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.303. .spec.remoteRead[].tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.304. .spec.remoteRead[].tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.305. .spec.remoteWrite Copy linkLink copied to clipboard!
- Description
- remoteWrite defines the list of remote write configurations.
- Type
-
array
9.1.306. .spec.remoteWrite[] Copy linkLink copied to clipboard!
- Description
- RemoteWriteSpec defines the configuration to write samples from Prometheus to a remote endpoint.
- Type
-
object - Required
-
url
-
| Property | Type | 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 |
|
|
| azureAd for the URL. It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.
Cannot be set at the same time as |
|
|
| basicAuth configuration for the URL.
Cannot be set at the same time as |
|
|
|
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 |
|
|
| bearerTokenFile defines the file from which to read bearer token for the URL.
Deprecated: this will be removed in a future release. Prefer using |
|
|
| enableHTTP2 defines whether to enable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. |
|
|
| 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 defines the Remote Write message’s version to use when writing to the endpoint.
When 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 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 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 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 configuration for the URL. It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.
Cannot be set at the same time as |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| queueConfig allows tuning of the remote write queue parameters. |
|
|
| remoteTimeout defines the timeout for requests to the remote write endpoint. |
|
|
| 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 enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. |
|
|
| 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 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 |
|
|
| tlsConfig to use for the URL. |
|
|
| url defines the URL of the endpoint to send samples to. |
|
|
| writeRelabelConfigs defines the list of remote write relabel configurations. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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, orazureAd.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
|
credentialsFile defines the file to read a secret from, mutually exclusive with |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
9.1.308. .spec.remoteWrite[].authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.309. .spec.remoteWrite[].azureAd Copy linkLink copied to clipboard!
- 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, orsigv4.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. |
|
|
|
managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as |
|
|
|
oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0. |
|
|
|
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 It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0. |
9.1.310. .spec.remoteWrite[].azureAd.managedIdentity Copy linkLink copied to clipboard!
- Description
-
managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as
oauthorsdk. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 Copy linkLink copied to clipboard!
- Description
oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as
managedIdentityorsdk.It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.
- Type
-
object - Required
-
clientId -
clientSecret -
tenantId
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines the clientId of the Azure Active Directory application that is being used to authenticate. |
|
|
| clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate. |
|
|
| tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate. |
9.1.312. .spec.remoteWrite[].azureAd.oauth.clientSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.313. .spec.remoteWrite[].azureAd.sdk Copy linkLink copied to clipboard!
- 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
oauthormanagedIdentity.It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| tenantId defines the tenant ID of the azure active directory application that is being used to authenticate. |
9.1.314. .spec.remoteWrite[].basicAuth Copy linkLink copied to clipboard!
- Description
basicAuth configuration for the URL.
Cannot be set at the same time as
sigv4,authorization,oauth2, orazureAd.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
9.1.315. .spec.remoteWrite[].basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.316. .spec.remoteWrite[].basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.317. .spec.remoteWrite[].metadataConfig Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| maxSamplesPerSend defines the maximum number of metadata samples per send. It requires Prometheus >= v2.29.0. |
|
|
| send defines whether metric metadata is sent to the remote storage or not. |
|
|
| sendInterval defines how frequently metric metadata is sent to the remote storage. |
9.1.318. .spec.remoteWrite[].oauth2 Copy linkLink copied to clipboard!
- 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, orazureAd.- Type
-
object - Required
-
clientId -
clientSecret -
tokenUrl
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
9.1.319. .spec.remoteWrite[].oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.320. .spec.remoteWrite[].oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.321. .spec.remoteWrite[].oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.322. .spec.remoteWrite[].oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.323. .spec.remoteWrite[].oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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.324. .spec.remoteWrite[].oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
9.1.325. .spec.remoteWrite[].oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.326. .spec.remoteWrite[].oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
9.1.327. .spec.remoteWrite[].oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.328. .spec.remoteWrite[].oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.329. .spec.remoteWrite[].oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.330. .spec.remoteWrite[].oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.331. .spec.remoteWrite[].oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.332. .spec.remoteWrite[].oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.333. .spec.remoteWrite[].oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.334. .spec.remoteWrite[].proxyConnectHeader Copy linkLink copied to clipboard!
- 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{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
9.1.336. .spec.remoteWrite[].proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.337. .spec.remoteWrite[].queueConfig Copy linkLink copied to clipboard!
- Description
- queueConfig allows tuning of the remote write queue parameters.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| batchSendDeadline defines the maximum time a sample will wait in buffer. |
|
|
| capacity defines the number of samples to buffer per shard before we start dropping them. |
|
|
| maxBackoff defines the maximum retry delay. |
|
|
| maxRetries defines the maximum number of times to retry a batch on recoverable errors. |
|
|
| maxSamplesPerSend defines the maximum number of samples per send. |
|
|
| maxShards defines the maximum number of shards, i.e. amount of concurrency. |
|
|
| minBackoff defines the initial retry delay. Gets doubled for every retry. |
|
|
| minShards defines the minimum number of shards, i.e. amount of concurrency. |
|
|
| 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 drops samples older than the limit. It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0. |
9.1.338. .spec.remoteWrite[].sigv4 Copy linkLink copied to clipboard!
- 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, orazureAd.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
accessKey defines the AWS API key. If not specified, the environment variable |
|
|
| profile defines the named AWS profile used to authenticate. |
|
|
| region defines the AWS region. If blank, the region from the default credentials chain used. |
|
|
| roleArn defines the named AWS profile used to authenticate. |
|
|
|
secretKey defines the AWS API secret. If not specified, the environment variable |
|
|
| useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. It requires Prometheus >= v2.54.0. |
9.1.339. .spec.remoteWrite[].sigv4.accessKey Copy linkLink copied to clipboard!
- Description
-
accessKey defines the AWS API key. If not specified, the environment variable
AWS_ACCESS_KEY_IDis used. - Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.340. .spec.remoteWrite[].sigv4.secretKey Copy linkLink copied to clipboard!
- Description
-
secretKey defines the AWS API secret. If not specified, the environment variable
AWS_SECRET_ACCESS_KEYis used. - Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.341. .spec.remoteWrite[].tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig to use for the URL.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| caFile defines the path to the CA cert in the Prometheus container to use for the targets. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| certFile defines the path to the client cert file in the Prometheus container for the targets. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keyFile defines the path to the client key file in the Prometheus container for the targets. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
9.1.342. .spec.remoteWrite[].tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.343. .spec.remoteWrite[].tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.344. .spec.remoteWrite[].tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.345. .spec.remoteWrite[].tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.346. .spec.remoteWrite[].tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.347. .spec.remoteWrite[].tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.348. .spec.remoteWrite[].tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.349. .spec.remoteWrite[].writeRelabelConfigs Copy linkLink copied to clipboard!
- Description
- writeRelabelConfigs defines the list of remote write relabel configurations.
- Type
-
array
9.1.350. .spec.remoteWrite[].writeRelabelConfigs[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
9.1.351. .spec.resources Copy linkLink copied to clipboard!
- Description
- resources defines the resources requests and limits of the 'prometheus' container.
- Type
-
object
| Property | Type | 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. |
|
|
| ResourceClaim references one entry in PodSpec.ResourceClaims. |
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
9.1.352. .spec.resources.claims Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.355. .spec.ruleNamespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.356. .spec.ruleNamespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.357. .spec.ruleSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.358. .spec.ruleSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.359. .spec.ruleSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.360. .spec.rules Copy linkLink copied to clipboard!
- Description
- rules defines the configuration of the Prometheus rules' engine.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 Copy linkLink copied to clipboard!
- Description
alert defines the parameters of the Prometheus rules' engine.
Any update to these parameters trigger a restart of the pods.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 defines the max time to tolerate prometheus outage for restoring 'for' state of alert. |
|
|
| resendDelay defines the minimum amount of time to wait before resending an alert to Alertmanager. |
9.1.362. .spec.runtime Copy linkLink copied to clipboard!
- Description
- runtime defines the values for the Prometheus process behavior
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Type
-
object - Required
-
name
-
| Property | Type | 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. |
|
|
| authorization section for the ScrapeClass. It will only apply if the scrape resource doesn’t specify any Authorization. |
|
|
| 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 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 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 |
|
|
| 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 of the scrape class. |
|
|
| relabelings defines the relabeling rules to apply to all scrape targets.
The Operator automatically adds relabelings for a few standard Kubernetes fields like More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config |
|
|
| 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 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 |
9.1.365. .spec.scrapeClasses[].attachMetadata Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| node when set to true, Prometheus attaches node metadata to the discovered targets.
The Prometheus service account must have the |
9.1.366. .spec.scrapeClasses[].authorization Copy linkLink copied to clipboard!
- Description
- authorization section for the ScrapeClass. It will only apply if the scrape resource doesn’t specify any Authorization.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
|
credentialsFile defines the file to read a secret from, mutually exclusive with |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
9.1.367. .spec.scrapeClasses[].authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.368. .spec.scrapeClasses[].metricRelabelings Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
9.1.370. .spec.scrapeClasses[].relabelings Copy linkLink copied to clipboard!
- 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_namespaceand\__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[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
9.1.372. .spec.scrapeClasses[].tlsConfig Copy linkLink copied to clipboard!
- 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,certFileandkeyFilefields are supported.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| caFile defines the path to the CA cert in the Prometheus container to use for the targets. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| certFile defines the path to the client cert file in the Prometheus container for the targets. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keyFile defines the path to the client key file in the Prometheus container for the targets. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
9.1.373. .spec.scrapeClasses[].tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.374. .spec.scrapeClasses[].tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.375. .spec.scrapeClasses[].tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.376. .spec.scrapeClasses[].tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.377. .spec.scrapeClasses[].tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.378. .spec.scrapeClasses[].tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.379. .spec.scrapeClasses[].tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.380. .spec.scrapeConfigNamespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.381. .spec.scrapeConfigNamespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.382. .spec.scrapeConfigNamespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.383. .spec.scrapeConfigSelector Copy linkLink copied to clipboard!
- 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.probeSelectorandspec.scrapeConfigSelectorare 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 theprometheus.yaml.gzkey. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to usespec.additionalScrapeConfigsinstead.Note that the ScrapeConfig custom resource definition is currently at Alpha level.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.384. .spec.scrapeConfigSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.385. .spec.scrapeConfigSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.386. .spec.securityContext Copy linkLink copied to clipboard!
- Description
- securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
- Type
-
object
| Property | Type | 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. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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 hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows. |
|
|
| Sysctl defines a kernel parameter to be set |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Level is SELinux level label that applies to the container. |
|
|
| Role is a SELinux role label that applies to the container. |
|
|
| Type is a SELinux type label that applies to the container. |
|
|
| User is a SELinux user label that applies to the container. |
9.1.389. .spec.securityContext.seccompProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. |
|
|
| type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
9.1.390. .spec.securityContext.sysctls Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Sysctl defines a kernel parameter to be set
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of a property to set |
|
|
| Value of a property to set |
9.1.392. .spec.securityContext.windowsOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
| GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
| HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
|
|
| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
9.1.393. .spec.serviceMonitorNamespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.394. .spec.serviceMonitorNamespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.395. .spec.serviceMonitorNamespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.396. .spec.serviceMonitorSelector Copy linkLink copied to clipboard!
- 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.probeSelectorandspec.scrapeConfigSelectorare 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 theprometheus.yaml.gzkey. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to usespec.additionalScrapeConfigsinstead.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.397. .spec.serviceMonitorSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.398. .spec.serviceMonitorSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.399. .spec.shardRetentionPolicy Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
|
retain defines the config for retention when the retention policy is set to |
|
|
|
whenScaled defines the retention policy when the Prometheus shards are scaled down. *
If not defined, the operator assumes the |
9.1.400. .spec.shardRetentionPolicy.retain Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| retentionPeriod defines the retentionPeriod for shard retention policy. |
9.1.401. .spec.storage Copy linkLink copied to clipboard!
- Description
- storage defines the storage used by Prometheus.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| disableMountSubPath deprecated: subPath usage will be removed in a future release. |
|
|
|
emptyDir to be used by the StatefulSet. If specified, it takes precedence over |
|
|
| 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 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 Copy linkLink copied to clipboard!
- Description
-
emptyDir to be used by the StatefulSet. If specified, it takes precedence over
ephemeralandvolumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
|
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be 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. |
9.1.404. .spec.storage.ephemeral.volumeClaimTemplate Copy linkLink copied to clipboard!
- Description
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be
<pod name>-<volume name>where<volume name>is the name from thePodSpec.Volumesarray entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
- Type
-
object - Required
-
spec
-
| Property | Type | Description |
|---|---|---|
|
|
| May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. |
|
|
| The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. |
9.1.405. .spec.storage.ephemeral.volumeClaimTemplate.metadata Copy linkLink copied to clipboard!
- 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
9.1.406. .spec.storage.ephemeral.volumeClaimTemplate.spec Copy linkLink copied to clipboard!
- Description
- The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
| 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 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 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 is a label query over volumes to consider for binding. |
|
|
| storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| 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 defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
| volumeName is the binding reference to the PersistentVolume backing this claim. |
9.1.407. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
9.1.408. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
|
|
| 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. |
9.1.409. .spec.storage.ephemeral.volumeClaimTemplate.spec.resources Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
9.1.410. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector Copy linkLink copied to clipboard!
- Description
- selector is a label query over volumes to consider for binding.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.411. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.412. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.413. .spec.storage.volumeClaimTemplate Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. |
|
|
| 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 is deprecated: this field is never set. |
9.1.414. .spec.storage.volumeClaimTemplate.metadata Copy linkLink copied to clipboard!
- Description
- metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
| 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 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 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 is a label query over volumes to consider for binding. |
|
|
| storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| 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 defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
| volumeName is the binding reference to the PersistentVolume backing this claim. |
9.1.416. .spec.storage.volumeClaimTemplate.spec.dataSource Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
9.1.417. .spec.storage.volumeClaimTemplate.spec.dataSourceRef Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
|
|
| 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. |
9.1.418. .spec.storage.volumeClaimTemplate.spec.resources Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
9.1.419. .spec.storage.volumeClaimTemplate.spec.selector Copy linkLink copied to clipboard!
- Description
- selector is a label query over volumes to consider for binding.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.420. .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.421. .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.422. .spec.storage.volumeClaimTemplate.status Copy linkLink copied to clipboard!
- Description
- status is deprecated: this field is never set.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 represents the actual resources of the underlying volume. |
|
|
| conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'. |
|
|
| PersistentVolumeClaimCondition contains details about state of pvc |
|
|
| currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim |
|
|
| ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. |
|
|
| phase represents the current phase of PersistentVolumeClaim. |
9.1.423. .spec.storage.volumeClaimTemplate.status.conditions Copy linkLink copied to clipboard!
- 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
9.1.424. .spec.storage.volumeClaimTemplate.status.conditions[] Copy linkLink copied to clipboard!
- Description
- PersistentVolumeClaimCondition contains details about state of pvc
- Type
-
object - Required
-
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastProbeTime is the time we probed the condition. |
|
|
| lastTransitionTime is the time the condition transitioned from one status to another. |
|
|
| message is the human-readable message indicating details about last transition. |
|
|
| 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 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 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 |
9.1.425. .spec.storage.volumeClaimTemplate.status.modifyVolumeStatus Copy linkLink copied to clipboard!
- Description
- ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.
- Type
-
object - Required
-
status
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the name of the VolumeAttributesClass the PVC currently being reconciled |
9.1.426. .spec.thanos Copy linkLink copied to clipboard!
- Description
- thanos defines the configuration of the optional Thanos sidecar.
- Type
-
object
| Property | Type | 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. |
|
|
| Argument as part of the AdditionalArgs list. |
|
|
| baseImage is deprecated: use 'image' instead. |
|
|
| 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 defines how often to retrieve the Prometheus configuration. |
|
|
| getConfigTimeout defines the maximum time to wait when retrieving the Prometheus configuration. |
|
|
| 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 |
|
|
| grpcServerTlsConfig defines the TLS parameters for the gRPC server providing the StoreAPI.
Note: Currently only the |
|
|
| 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 |
|
|
|
image defines the container image name for Thanos. If specified, it takes precedence over the
Specifying
If neither |
|
|
|
listenLocal is deprecated: use |
|
|
| logFormat for the Thanos sidecar. |
|
|
| logLevel for the Thanos sidecar. |
|
|
| 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 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 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 defines the maximum time that the Thanos sidecar will wait for Prometheus to start. |
|
|
| resources defines the resources requests and limits of the Thanos sidecar. |
|
|
| sha is deprecated: use 'image' instead. The image digest can be specified as part of the image name. |
|
|
| tag is deprecated: use 'image' instead. The image’s tag can be specified as as part of the image name. |
|
|
| tracingConfig defines the tracing configuration for the Thanos sidecar.
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 defines the tracing configuration file for the Thanos sidecar.
This field takes precedence over 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 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 allows configuration of additional VolumeMounts for Thanos. VolumeMounts specified will be appended to other VolumeMounts in the 'thanos-sidecar' container. |
|
|
| VolumeMount describes a mounting of a Volume within a container. |
9.1.427. .spec.thanos.additionalArgs Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Argument as part of the AdditionalArgs list.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| name of the argument, e.g. "scrape.discovery-reload-interval". |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
grpcServerTlsConfig defines the TLS parameters for the gRPC server providing the StoreAPI.
Note: Currently only the
caFile,certFile, andkeyFilefields are supported.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| caFile defines the path to the CA cert in the Prometheus container to use for the targets. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| certFile defines the path to the client cert file in the Prometheus container for the targets. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keyFile defines the path to the client key file in the Prometheus container for the targets. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
9.1.430. .spec.thanos.grpcServerTlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.431. .spec.thanos.grpcServerTlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.432. .spec.thanos.grpcServerTlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.433. .spec.thanos.grpcServerTlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.434. .spec.thanos.grpcServerTlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.435. .spec.thanos.grpcServerTlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.436. .spec.thanos.grpcServerTlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.437. .spec.thanos.objectStorageConfig Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.438. .spec.thanos.resources Copy linkLink copied to clipboard!
- Description
- resources defines the resources requests and limits of the Thanos sidecar.
- Type
-
object
| Property | Type | 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. |
|
|
| ResourceClaim references one entry in PodSpec.ResourceClaims. |
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
9.1.439. .spec.thanos.resources.claims Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- Description
tracingConfig defines the tracing configuration for the Thanos sidecar.
tracingConfigFiletakes 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.442. .spec.thanos.volumeMounts Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). |
|
|
| This must match the Name of a Volume. |
|
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
| 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. |
|
|
| Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
| Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
9.1.444. .spec.tolerations Copy linkLink copied to clipboard!
- Description
- tolerations defines the Pods' tolerations if specified.
- Type
-
array
9.1.445. .spec.tolerations[] Copy linkLink copied to clipboard!
- Description
- The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
|
|
| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
|
|
| Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
|
|
| TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
|
|
| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
9.1.446. .spec.topologySpreadConstraints Copy linkLink copied to clipboard!
- Description
- topologySpreadConstraints defines the pod’s topology spread constraints if specified.
- Type
-
array
9.1.447. .spec.topologySpreadConstraints[] Copy linkLink copied to clipboard!
- Description
- Type
-
object - Required
-
maxSkew -
topologyKey -
whenUnsatisfiable
-
| Property | Type | Description |
|---|---|---|
|
|
| additionalLabelSelectors Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint. |
|
|
| 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 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 describes the degree to which pods may be unevenly distributed. When |
|
|
| 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 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 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 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 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. |
9.1.448. .spec.topologySpreadConstraints[].labelSelector Copy linkLink copied to clipboard!
- Description
- LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.449. .spec.topologySpreadConstraints[].labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.450. .spec.topologySpreadConstraints[].labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.451. .spec.tracingConfig Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
clientType defines the client used to export the traces. Supported values are |
|
|
|
compression key for supported compression types. The only supported value is |
|
|
| endpoint to send the traces to. Should be provided in format <host>:<port>. |
|
|
| headers defines the key-value pairs to be used as headers associated with gRPC or HTTP requests. |
|
|
| insecure if disabled, the client will use a secure connection. |
|
|
| samplingFraction defines the probability a given trace will be sampled. Must be a float from 0 through 1. |
|
|
| timeout defines the maximum time the exporter will wait for each batch export. |
|
|
| tlsConfig to use when sending traces. |
9.1.452. .spec.tracingConfig.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig to use when sending traces.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| caFile defines the path to the CA cert in the Prometheus container to use for the targets. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| certFile defines the path to the client cert file in the Prometheus container for the targets. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keyFile defines the path to the client key file in the Prometheus container for the targets. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
9.1.453. .spec.tracingConfig.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.454. .spec.tracingConfig.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.455. .spec.tracingConfig.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.456. .spec.tracingConfig.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.457. .spec.tracingConfig.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.458. .spec.tracingConfig.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.459. .spec.tracingConfig.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.460. .spec.tsdb Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). |
|
|
| This must match the Name of a Volume. |
|
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
| 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. |
|
|
| Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
| Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
9.1.463. .spec.volumes Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Volume represents a named volume in a pod that may be accessed by any container in the pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. 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 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 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 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 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 represents a configMap that should populate this volume |
|
|
| csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers. |
|
|
| downwardAPI represents downward API about the pod that should populate this volume |
|
|
| emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
|
| ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. |
|
|
| fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
|
|
| flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. |
|
|
| 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 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 represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container. |
|
|
| glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. |
|
|
| 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 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 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 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 represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
| photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. |
|
|
| 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 items for all in one resources secrets, configmaps, and downward API |
|
|
| quobyte represents a Quobyte mount on the host that shares a pod’s lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. |
|
|
| 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 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 represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
|
| storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| cachingMode is the Host Caching mode: None, Read Only, Read Write. |
|
|
| diskName is the Name of the data disk in the blob storage |
|
|
| diskURI is the URI of data disk in the blob storage |
|
|
| 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 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 Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
9.1.467. .spec.volumes[].azureFile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| secretName is the name of secret that contains Azure Storage Account Name and Key |
|
|
| shareName is the azure share Name |
9.1.468. .spec.volumes[].cephfs Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
|
|
| 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 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 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 is optional: points to a secret object containing parameters used to connect to OpenStack. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- configMap represents a configMap that should populate this volume
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| optional specify whether the ConfigMap or its keys must be defined |
9.1.473. .spec.volumes[].configMap.items Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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 Copy linkLink copied to clipboard!
- Description
- csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
- Type
-
object - Required
-
driver
-
| Property | Type | Description |
|---|---|---|
|
|
| driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. |
|
|
| 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 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 specifies a read-only configuration for the volume. Defaults to false (read/write). |
|
|
| volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values. |
9.1.476. .spec.volumes[].csi.nodePublishSecretRef Copy linkLink copied to clipboard!
- Description
- nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- downwardAPI represents downward API about the pod that should populate this volume
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
| Items is a list of downward API volume file |
|
|
| DownwardAPIVolumeFile represents information to create the file containing the pod field |
9.1.478. .spec.volumes[].downwardAPI.items Copy linkLink copied to clipboard!
- Description
- Items is a list of downward API volume file
- Type
-
array
9.1.479. .spec.volumes[].downwardAPI.items[] Copy linkLink copied to clipboard!
- Description
- DownwardAPIVolumeFile represents information to create the file containing the pod field
- Type
-
object - Required
-
path
-
| Property | Type | Description |
|---|---|---|
|
|
| Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. |
|
|
| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
9.1.480. .spec.volumes[].downwardAPI.items[].fieldRef Copy linkLink copied to clipboard!
- Description
- Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
9.1.481. .spec.volumes[].downwardAPI.items[].resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
9.1.482. .spec.volumes[].emptyDir Copy linkLink copied to clipboard!
- Description
- emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
|
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be 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. |
9.1.484. .spec.volumes[].ephemeral.volumeClaimTemplate Copy linkLink copied to clipboard!
- Description
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be
<pod name>-<volume name>where<volume name>is the name from thePodSpec.Volumesarray entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
- Type
-
object - Required
-
spec
-
| Property | Type | Description |
|---|---|---|
|
|
| May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. |
|
|
| The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. |
9.1.485. .spec.volumes[].ephemeral.volumeClaimTemplate.metadata Copy linkLink copied to clipboard!
- 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
9.1.486. .spec.volumes[].ephemeral.volumeClaimTemplate.spec Copy linkLink copied to clipboard!
- Description
- The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
| 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 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 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 is a label query over volumes to consider for binding. |
|
|
| storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| 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 defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
| volumeName is the binding reference to the PersistentVolume backing this claim. |
9.1.487. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
9.1.488. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
|
|
| 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. |
9.1.489. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
9.1.490. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector Copy linkLink copied to clipboard!
- Description
- selector is a label query over volumes to consider for binding.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.491. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.492. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.493. .spec.volumes[].fc Copy linkLink copied to clipboard!
- Description
- fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 is Optional: FC target lun number |
|
|
| readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| targetWWNs is Optional: FC target worldwide names (WWNs) |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| driver is the name of the driver to use for this volume. |
|
|
| 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 is Optional: this field holds extra command options if any. |
|
|
| readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| datasetName is Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated |
|
|
| datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset |
9.1.497. .spec.volumes[].gcePersistentDisk Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 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 Copy linkLink copied to clipboard!
- Description
- gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.
- Type
-
object - Required
-
repository
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the URL |
|
|
| revision is the commit hash for the specified revision. |
9.1.499. .spec.volumes[].glusterfs Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| endpoints is the endpoint name that details Glusterfs topology. |
|
|
| path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
|
| readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
9.1.500. .spec.volumes[].hostPath Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
|
| type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
9.1.501. .spec.volumes[].image Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication |
|
|
| chapAuthSession defines whether support iSCSI Session CHAP authentication |
|
|
| 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 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 is the target iSCSI Qualified Name. |
|
|
| iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). |
|
|
| lun represents iSCSI Target Lun number. |
|
|
| 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 here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
|
|
| secretRef is the CHAP Secret for iSCSI target and initiator authentication |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef is the CHAP Secret for iSCSI target and initiator authentication
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- Type
-
object - Required
-
path -
server
-
| Property | Type | Description |
|---|---|---|
|
|
| path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
9.1.505. .spec.volumes[].persistentVolumeClaim Copy linkLink copied to clipboard!
- Description
- persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- Type
-
object - Required
-
claimName
-
| Property | Type | Description |
|---|---|---|
|
|
| claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
| readOnly Will force the ReadOnly setting in VolumeMounts. Default false. |
9.1.506. .spec.volumes[].photonPersistentDisk Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the ID that identifies Photon Controller persistent disk |
9.1.507. .spec.volumes[].portworxVolume Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
| readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| volumeID uniquely identifies a Portworx volume |
9.1.508. .spec.volumes[].projected Copy linkLink copied to clipboard!
- Description
- projected items for all in one resources secrets, configmaps, and downward API
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the list of volume projections. Each entry in this list handles one source. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
ClusterTrustBundle allows a pod to access the 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 information about the configMap data to project |
|
|
| downwardAPI information about the downwardAPI data to project |
|
|
| 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 information about the secret data to project |
|
|
| serviceAccountToken is information about the serviceAccountToken data to project |
9.1.511. .spec.volumes[].projected.sources[].clusterTrustBundle Copy linkLink copied to clipboard!
- Description
ClusterTrustBundle allows a pod to access the
.spec.trustBundlefield 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
-
| Property | Type | 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". |
|
|
| Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector. |
|
|
| 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. |
|
|
| Relative path from the volume root to write the bundle. |
|
|
| Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated. |
9.1.512. .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
9.1.513. .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
9.1.514. .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
9.1.515. .spec.volumes[].projected.sources[].configMap Copy linkLink copied to clipboard!
- Description
- configMap information about the configMap data to project
- Type
-
object
| Property | Type | 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 '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| optional specify whether the ConfigMap or its keys must be defined |
9.1.516. .spec.volumes[].projected.sources[].configMap.items Copy linkLink copied to clipboard!
- 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.517. .spec.volumes[].projected.sources[].configMap.items[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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.518. .spec.volumes[].projected.sources[].downwardAPI Copy linkLink copied to clipboard!
- Description
- downwardAPI information about the downwardAPI data to project
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Items is a list of DownwardAPIVolume file |
|
|
| DownwardAPIVolumeFile represents information to create the file containing the pod field |
9.1.519. .spec.volumes[].projected.sources[].downwardAPI.items Copy linkLink copied to clipboard!
- Description
- Items is a list of DownwardAPIVolume file
- Type
-
array
9.1.520. .spec.volumes[].projected.sources[].downwardAPI.items[] Copy linkLink copied to clipboard!
- Description
- DownwardAPIVolumeFile represents information to create the file containing the pod field
- Type
-
object - Required
-
path
-
| Property | Type | Description |
|---|---|---|
|
|
| Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. |
|
|
| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
9.1.521. .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef Copy linkLink copied to clipboard!
- Description
- Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
9.1.522. .spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
9.1.523. .spec.volumes[].projected.sources[].podCertificate Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| The type of keypair Kubelet will generate for the pod. Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521", and "ED25519". |
|
|
| 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. |
|
|
| Kubelet’s generated CSRs will be addressed to this signer. |
9.1.524. .spec.volumes[].projected.sources[].secret Copy linkLink copied to clipboard!
- Description
- secret information about the secret data to project
- Type
-
object
| Property | Type | 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 '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| optional field specify whether the Secret or its key must be defined |
9.1.525. .spec.volumes[].projected.sources[].secret.items Copy linkLink copied to clipboard!
- 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.526. .spec.volumes[].projected.sources[].secret.items[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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.527. .spec.volumes[].projected.sources[].serviceAccountToken Copy linkLink copied to clipboard!
- Description
- serviceAccountToken is information about the serviceAccountToken data to project
- Type
-
object - Required
-
path
-
| Property | Type | Description |
|---|---|---|
|
|
| audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. |
|
|
| expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. |
|
|
| path is the path relative to the mount point of the file to project the token into. |
9.1.528. .spec.volumes[].quobyte Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| group to map volume access to Default is no group |
|
|
| readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
|
|
| registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
|
|
| tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin |
|
|
| user to map volume access to Defaults to serivceaccount user |
|
|
| volume is a string that references an already created Quobyte volume by name. |
9.1.529. .spec.volumes[].rbd Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the host address of the ScaleIO API Gateway. |
|
|
| protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. |
|
|
| readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
|
|
| sslEnabled Flag enable/disable SSL communication with Gateway, default false |
|
|
| storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. |
|
|
| storagePool is the ScaleIO Storage Pool associated with the protection domain. |
|
|
| system is the name of the storage system as configured in ScaleIO. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| optional field specify whether the Secret or its keys must be defined |
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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 defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. |
|
|
| volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. |
|
|
| volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |
9.1.537. .spec.volumes[].storageos.secretRef Copy linkLink copied to clipboard!
- Description
- secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. |
|
|
| storagePolicyName is the storage Policy Based Management (SPBM) profile name. |
|
|
| volumePath is the path that identifies vSphere volume vmdk |
9.1.539. .spec.web Copy linkLink copied to clipboard!
- Description
- web defines the configuration of the Prometheus web server.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| httpConfig defines HTTP parameters for web server. |
|
|
| maxConnections defines the maximum number of simultaneous connections A zero value means that Prometheus doesn’t accept any incoming connection. |
|
|
| pageTitle defines the prometheus web page title. |
|
|
| tlsConfig defines the TLS parameters for HTTPS. |
9.1.540. .spec.web.httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines HTTP parameters for web server.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| headers defines a list of headers that can be added to HTTP responses. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- headers defines a list of headers that can be added to HTTP responses.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. |
|
|
| 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 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 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 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 Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS parameters for HTTPS.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| cert defines the Secret or ConfigMap containing the TLS certificate for the web server.
Either
It is mutually exclusive with |
|
|
| certFile defines the path to the TLS certificate file in the container for the web server.
Either
It is mutually exclusive with |
|
|
| 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 defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType |
|
|
| clientCAFile defines the path to the CA certificate file for client certificate authentication to the server.
It is mutually exclusive with |
|
|
| client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server.
It is mutually exclusive with |
|
|
| 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 defines the path to the TLS private key file in the container for the web server.
If defined, either
It is mutually exclusive with |
|
|
| keySecret defines the secret containing the TLS private key for the web server.
Either
It is mutually exclusive with |
|
|
| maxVersion defines the Maximum TLS version that is acceptable. |
|
|
| minVersion defines the minimum TLS version that is acceptable. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
cert defines the Secret or ConfigMap containing the TLS certificate for the web server.
Either
keySecretorkeyFilemust be defined.It is mutually exclusive with
certFile.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.544. .spec.web.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.545. .spec.web.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.546. .spec.web.tlsConfig.client_ca Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
9.1.547. .spec.web.tlsConfig.client_ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
9.1.548. .spec.web.tlsConfig.client_ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.549. .spec.web.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
keySecret defines the secret containing the TLS private key for the web server.
Either
certorcertFilemust be defined.It is mutually exclusive with
keyFile.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
9.1.550. .status Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this Prometheus deployment. |
|
|
| conditions defines the current state of the Prometheus deployment. |
|
|
| Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource. |
|
|
| paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. |
|
|
| replicas defines the total number of non-terminated pods targeted by this Prometheus deployment (their labels match the selector). |
|
|
| selector used to match the pods targeted by this Prometheus resource. |
|
|
| shardStatuses defines the list has one entry per shard. Each entry provides a summary of the shard status. |
|
|
| |
|
|
| shards defines the most recently observed number of shards. |
|
|
| unavailableReplicas defines the total number of unavailable pods targeted by this Prometheus deployment. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- conditions defines the current state of the Prometheus deployment.
- Type
-
array
9.1.552. .status.conditions[] Copy linkLink copied to clipboard!
- Description
- Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource.
- Type
-
object - Required
-
lastTransitionTime -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastTransitionTime is the time of the last update to the current status property. |
|
|
| message defines human-readable message indicating details for the condition’s last transition. |
|
|
|
observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if |
|
|
| reason for the condition’s last transition. |
|
|
| status of the condition. |
|
|
| type of the condition being reported. |
9.1.553. .status.shardStatuses Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Type
-
object - Required
-
availableReplicas -
replicas -
shardID -
unavailableReplicas -
updatedReplicas
-
| Property | Type | Description |
|---|---|---|
|
|
| availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this shard. |
|
|
| replicas defines the total number of pods targeted by this shard. |
|
|
| shardID defines the identifier of the shard. |
|
|
| unavailableReplicas defines the Total number of unavailable pods targeted by this shard. |
|
|
| updatedReplicas defines the total number of non-terminated pods targeted by this shard that have the desired spec. |
9.2. API endpoints Copy linkLink copied to clipboard!
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 Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind Prometheus
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
9.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of Prometheus
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind Prometheus
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create Prometheus
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
9.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Prometheus |
- HTTP method
-
DELETE - Description
- delete Prometheus
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified Prometheus
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified Prometheus
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified Prometheus
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
9.2.4. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name}/scale Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Prometheus |
- HTTP method
-
GET - Description
- read scale of the specified Prometheus
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update scale of the specified Prometheus
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace scale of the specified Prometheus
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
9.2.5. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Prometheus |
- HTTP method
-
GET - Description
- read status of the specified Prometheus
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified Prometheus
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified Prometheus
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 10. PrometheusRule [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
PrometheusRulecustom 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 byPrometheusorThanosRulerobjects.PrometheusandThanosRulerobjects selectPrometheusRuleobjects using label and namespace selectors.- Type
-
object - Required
-
spec
-
10.1. Specification Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec defines the specification of desired alerting rule definitions for Prometheus. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- spec defines the specification of desired alerting rule definitions for Prometheus.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| groups defines the content of Prometheus rule file |
|
|
| RuleGroup is a list of sequentially evaluated recording and alerting rules. |
10.1.2. .spec.groups Copy linkLink copied to clipboard!
- Description
- groups defines the content of Prometheus rule file
- Type
-
array
10.1.3. .spec.groups[] Copy linkLink copied to clipboard!
- Description
- RuleGroup is a list of sequentially evaluated recording and alerting rules.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| interval defines how often rules in the group are evaluated. |
|
|
| 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 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 defines the name of the rule group. |
|
|
| 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 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 defines the list of alerting and recording rules. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- rules defines the list of alerting and recording rules.
- Type
-
array
10.1.5. .spec.groups[].rules[] Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
|
alert defines the name of the alert. Must be a valid label value. Only one of |
|
|
| annotations defines annotations to add to each alert. Only valid for alerting rules. |
|
|
| expr defines the PromQL expression to evaluate. |
|
|
| for defines how alerts are considered firing once they have been returned for this long. |
|
|
| keep_firing_for defines how long an alert will continue firing after the condition that triggered it has cleared. |
|
|
| labels defines labels to add or overwrite. |
|
|
|
record defines the name of the time series to output to. Must be a valid metric name. Only one of |
10.1.6. .status Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource. |
|
|
| WorkloadBinding is a link between a configuration resource and a workload resource. |
10.1.7. .status.bindings Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- WorkloadBinding is a link between a configuration resource and a workload resource.
- Type
-
object - Required
-
group -
name -
namespace -
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| conditions defines the current state of the configuration resource when bound to the referenced Workload object. |
|
|
| ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler. |
|
|
| group defines the group of the referenced resource. |
|
|
| name defines the name of the referenced object. |
|
|
| namespace defines the namespace of the referenced object. |
|
|
| resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager). |
10.1.9. .status.bindings[].conditions Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
- Type
-
object - Required
-
lastTransitionTime -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastTransitionTime defines the time of the last update to the current status property. |
|
|
| message defines the human-readable message indicating details for the condition’s last transition. |
|
|
|
observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if |
|
|
| reason for the condition’s last transition. |
|
|
| status of the condition. |
|
|
| type of the condition being reported. Currently, only "Accepted" is supported. |
10.2. API endpoints Copy linkLink copied to clipboard!
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
-
10.2.1. /apis/monitoring.coreos.com/v1/prometheusrules Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind PrometheusRule
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
10.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of PrometheusRule
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind PrometheusRule
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a PrometheusRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
10.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the PrometheusRule |
- HTTP method
-
DELETE - Description
- delete a PrometheusRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified PrometheusRule
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified PrometheusRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified PrometheusRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
10.2.4. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the PrometheusRule |
- HTTP method
-
GET - Description
- read status of the specified PrometheusRule
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified PrometheusRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified PrometheusRule
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 11. ServiceMonitor [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
ServiceMonitorcustom resource definition (CRD) defines howPrometheusandPrometheusAgentcan 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.PrometheusandPrometheusAgentobjects selectServiceMonitorobjects using label and namespace selectors.- Type
-
object - Required
-
spec
-
11.1. Specification Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec defines the specification of desired Service selection for target discovery by Prometheus. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- spec defines the specification of desired Service selection for target discovery by Prometheus.
- Type
-
object - Required
-
endpoints -
selector
-
| Property | Type | Description |
|---|---|---|
|
|
| attachMetadata defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.37.0. |
|
|
| 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 defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0. |
|
|
| 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. |
|
|
| Endpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus. |
|
|
| fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. |
|
|
|
jobLabel selects the label from the associated Kubernetes
For example if
If the value of this field is empty or if the label doesn’t exist for the given Service, the |
|
|
| 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 defines the per-scrape limit on number of labels that will be accepted for a sample. It requires Prometheus >= v2.27.0. |
|
|
| 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 defines the per-scrape limit on length of labels value that will be accepted for a sample. It requires Prometheus >= v2.27.0. |
|
|
|
namespaceSelector defines in which namespace(s) Prometheus should discover the services. By default, the services are discovered in the same namespace as the |
|
|
| 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 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 defines the labels which are transferred from the associated Kubernetes |
|
|
| sampleLimit defines a per-scrape limit on the number of scraped samples that will be accepted. |
|
|
| scrapeClass defines the scrape class to apply. |
|
|
| scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.
Notice: |
|
|
| 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 defines the label selector to select the Kubernetes |
|
|
| 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 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 defines the labels which are transferred from the associated Kubernetes |
|
|
| targetLimit defines a limit on the number of scraped targets that will be accepted. |
11.1.2. .spec.attachMetadata Copy linkLink copied to clipboard!
- Description
attachMetadata defines additional metadata which is added to the discovered targets.
It requires Prometheus >= v2.37.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| node when set to true, Prometheus attaches node metadata to the discovered targets.
The Prometheus service account must have the |
11.1.3. .spec.endpoints Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Endpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| authorization configures the Authorization header credentials to use when scraping the target.
Cannot be set at the same time as |
|
|
| basicAuth defines the Basic Authentication credentials to use when scraping the target.
Cannot be set at the same time as |
|
|
| bearerTokenFile defines the file to read bearer token for scraping the target.
Deprecated: use |
|
|
| 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 |
|
|
| enableHttp2 can be used to disable HTTP2 when scraping the target. |
|
|
| 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 defines whether the scrape requests should follow HTTP 3xx redirects. |
|
|
| honorLabels defines when true the metric’s labels when they collide with the target’s labels. |
|
|
| honorTimestamps defines whether Prometheus preserves the timestamps when exposed by the target. |
|
|
| interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval. |
|
|
| metricRelabelings defines the relabeling rules to apply to the samples before ingestion. |
|
|
| 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 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 defines the OAuth2 settings to use when scraping the target. It requires Prometheus >= 2.27.0.
Cannot be set at the same time as |
|
|
| params define optional HTTP URL parameters. |
|
|
| |
|
|
| path defines the HTTP path from which to scrape for metrics.
If empty, Prometheus uses the default value (e.g. |
|
|
| port defines the name of the Service port which this endpoint refers to.
It takes precedence over |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| 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 More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config |
|
|
| 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 defines the HTTP scheme to use when scraping the metrics. |
|
|
| 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 defines the name or number of the target port of the |
|
|
| tlsConfig defines the TLS configuration to use when scraping the target. |
|
|
|
trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if It requires Prometheus >= v2.48.0. |
11.1.5. .spec.endpoints[].authorization Copy linkLink copied to clipboard!
- Description
authorization configures the Authorization header credentials to use when scraping the target.
Cannot be set at the same time as
basicAuth, oroauth2.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
11.1.6. .spec.endpoints[].authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.7. .spec.endpoints[].basicAuth Copy linkLink copied to clipboard!
- Description
basicAuth defines the Basic Authentication credentials to use when scraping the target.
Cannot be set at the same time as
authorization, oroauth2.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
11.1.8. .spec.endpoints[].basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.9. .spec.endpoints[].basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.10. .spec.endpoints[].bearerTokenSecret Copy linkLink copied to clipboard!
- 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
authorizationinstead.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.11. .spec.endpoints[].metricRelabelings Copy linkLink copied to clipboard!
- Description
- metricRelabelings defines the relabeling rules to apply to the samples before ingestion.
- Type
-
array
11.1.12. .spec.endpoints[].metricRelabelings[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
11.1.13. .spec.endpoints[].oauth2 Copy linkLink copied to clipboard!
- 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, orbasicAuth.- Type
-
object - Required
-
clientId -
clientSecret -
tokenUrl
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
11.1.14. .spec.endpoints[].oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
11.1.15. .spec.endpoints[].oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
11.1.16. .spec.endpoints[].oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.17. .spec.endpoints[].oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.18. .spec.endpoints[].oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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.19. .spec.endpoints[].oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
11.1.20. .spec.endpoints[].oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.21. .spec.endpoints[].oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
11.1.22. .spec.endpoints[].oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
11.1.23. .spec.endpoints[].oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
11.1.24. .spec.endpoints[].oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.25. .spec.endpoints[].oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
11.1.26. .spec.endpoints[].oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
11.1.27. .spec.endpoints[].oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.28. .spec.endpoints[].oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.29. .spec.endpoints[].params Copy linkLink copied to clipboard!
- Description
- params define optional HTTP URL parameters.
- Type
-
object
11.1.30. .spec.endpoints[].proxyConnectHeader Copy linkLink copied to clipboard!
- 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{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
11.1.32. .spec.endpoints[].proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.33. .spec.endpoints[].relabelings Copy linkLink copied to clipboard!
- 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_namelabel.More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
- Type
-
array
11.1.34. .spec.endpoints[].relabelings[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
11.1.35. .spec.endpoints[].tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when scraping the target.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| caFile defines the path to the CA cert in the Prometheus container to use for the targets. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| certFile defines the path to the client cert file in the Prometheus container for the targets. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keyFile defines the path to the client key file in the Prometheus container for the targets. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
11.1.36. .spec.endpoints[].tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
11.1.37. .spec.endpoints[].tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
11.1.38. .spec.endpoints[].tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.39. .spec.endpoints[].tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
11.1.40. .spec.endpoints[].tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
11.1.41. .spec.endpoints[].tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.42. .spec.endpoints[].tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
11.1.43. .spec.namespaceSelector Copy linkLink copied to clipboard!
- Description
-
namespaceSelector defines in which namespace(s) Prometheus should discover the services. By default, the services are discovered in the same namespace as the
ServiceMonitorobject but it is possible to select pods across different/all namespaces. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them. |
|
|
| matchNames defines the list of namespace names to select from. |
11.1.44. .spec.selector Copy linkLink copied to clipboard!
- Description
-
selector defines the label selector to select the Kubernetes
Endpointsobjects to scrape metrics from. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
11.1.45. .spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
11.1.46. .spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
11.1.47. .status Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource. |
|
|
| WorkloadBinding is a link between a configuration resource and a workload resource. |
11.1.48. .status.bindings Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- WorkloadBinding is a link between a configuration resource and a workload resource.
- Type
-
object - Required
-
group -
name -
namespace -
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| conditions defines the current state of the configuration resource when bound to the referenced Workload object. |
|
|
| ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler. |
|
|
| group defines the group of the referenced resource. |
|
|
| name defines the name of the referenced object. |
|
|
| namespace defines the namespace of the referenced object. |
|
|
| resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager). |
11.1.50. .status.bindings[].conditions Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
- Type
-
object - Required
-
lastTransitionTime -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastTransitionTime defines the time of the last update to the current status property. |
|
|
| message defines the human-readable message indicating details for the condition’s last transition. |
|
|
|
observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if |
|
|
| reason for the condition’s last transition. |
|
|
| status of the condition. |
|
|
| type of the condition being reported. Currently, only "Accepted" is supported. |
11.2. API endpoints Copy linkLink copied to clipboard!
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
-
11.2.1. /apis/monitoring.coreos.com/v1/servicemonitors Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind ServiceMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
11.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of ServiceMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind ServiceMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a ServiceMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
11.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ServiceMonitor |
- HTTP method
-
DELETE - Description
- delete a ServiceMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified ServiceMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified ServiceMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified ServiceMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
11.2.4. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ServiceMonitor |
- HTTP method
-
GET - Description
- read status of the specified ServiceMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified ServiceMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified ServiceMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 12. ThanosRuler [monitoring.coreos.com/v1] Copy linkLink copied to clipboard!
- Description
The
ThanosRulercustom 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
ThanosRulerinstance requires at least one compatible Prometheus API endpoint (either Thanos Querier or Prometheus services).The resource defines via label and namespace selectors which
PrometheusRuleobjects should be associated to the deployed Thanos Ruler instances.- Type
-
object - Required
-
spec
-
12.1. Specification Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | 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. |
|
|
| Argument as part of the AdditionalArgs list. |
|
|
| affinity defines when specified, the pod’s scheduling constraints. |
|
|
| alertDropLabels defines the label names which should be dropped in Thanos Ruler alerts.
The replica label |
|
|
| alertQueryUrl defines how Thanos Ruler will set in the 'Source' field of all alerts. Maps to the '--alert.query-url' CLI arg. |
|
|
| 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 |
|
|
| 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.
|
|
|
| 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 defines the list of Alertmanager endpoints to send alerts to.
For Thanos >= v0.10.0, it is recommended to use
|
|
|
|
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: |
|
|
| A single application container that you want to run within a pod. |
|
|
| dnsConfig defines Defines the DNS configuration for the pods. |
|
|
| dnsPolicy defines the DNS policy for the pods. |
|
|
| 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 defines whether information about services should be injected into pod’s environment variables |
|
|
| 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 defines the interval between consecutive evaluations. |
|
|
| 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. |
|
|
| ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object. |
|
|
| 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 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 defines pods' hostAliases configuration |
|
|
| HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file. |
|
|
| 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 |
|
|
| image defines Thanos container image URL. |
|
|
| 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 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 |
|
|
| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. |
|
|
| 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. |
|
|
| A single application container that you want to run within a pod. |
|
|
| labels defines the external label pairs of the ThanosRuler resource.
A default replica label |
|
|
| listenLocal defines the Thanos ruler listen on loopback, so that it does not bind against the Pod IP. |
|
|
| logFormat for ThanosRuler to be configured with. |
|
|
| logLevel for ThanosRuler to be configured with. |
|
|
| 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 defines which Nodes the Pods are scheduled on. |
|
|
| 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 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 |
|
|
| paused defines when a ThanosRuler deployment is paused, no actions except for deletion will be performed on the underlying objects. |
|
|
| 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 defines the port name used for the pods and governing service. Defaults to |
|
|
| priorityClassName defines the priority class assigned to the Pods |
|
|
| 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. |
|
|
| PrometheusRuleExcludeConfig enables users to configure excluded PrometheusRule names and their namespaces to be ignored while enforcing namespace label for alerts and metrics. |
|
|
| 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 defines the list of Thanos Query endpoints from which to query metrics.
For Thanos >= v0.11.0, it is recommended to use
|
|
|
| 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. |
|
|
| RemoteWriteSpec defines the configuration to write samples from Prometheus to a remote endpoint. |
|
|
| replicas defines the number of thanos ruler instances to deploy. |
|
|
| resendDelay defines the minimum amount of time to wait before resending an alert to Alertmanager. |
|
|
| resources defines the resource requirements for single Pods. If not provided, no requests/limits will be set |
|
|
|
retention defines the time duration ThanosRuler shall retain data for. Default is '24h', and must match the regular expression The field has no effect when remote-write is configured since the Ruler operates in stateless mode. |
|
|
| routePrefix defines the route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path. |
|
|
| ruleConcurrentEval defines how many rules can be evaluated concurrently. It requires Thanos >= v0.37.0. |
|
|
| 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 defines the namespaces to be selected for Rules discovery. If unspecified, only the same namespace as the ThanosRuler object is in is used. |
|
|
| ruleOutageTolerance defines the max time to tolerate prometheus outage for restoring "for" state of alert. It requires Thanos >= v0.30.0. |
|
|
| ruleQueryOffset defines the default rule group’s query offset duration to use. It requires Thanos >= v0.38.0. |
|
|
| 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 defines the pod-level security attributes and common container settings. This defaults to the default PodSecurityContext. |
|
|
| serviceAccountName defines the name of the ServiceAccount to use to run the Thanos Ruler Pods. |
|
|
|
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 |
|
|
| storage defines the specification of how storage shall be used. |
|
|
| 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 defines when specified, the pod’s tolerations. |
|
|
| The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. |
|
|
| topologySpreadConstraints defines the pod’s topology spread constraints. |
|
|
| TopologySpreadConstraint specifies how to spread matching pods among the given topology. |
|
|
| 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 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 |
|
|
| version of Thanos to be deployed. |
|
|
| 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. |
|
|
| VolumeMount describes a mounting of a Volume within a container. |
|
|
| 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. |
|
|
| Volume represents a named volume in a pod that may be accessed by any container in the pod. |
|
|
| web defines the configuration of the ThanosRuler web server. |
12.1.2. .spec.additionalArgs Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Argument as part of the AdditionalArgs list.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| name of the argument, e.g. "scrape.discovery-reload-interval". |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- affinity defines when specified, the pod’s scheduling constraints.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Describes node affinity scheduling rules for the pod. |
|
|
| Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
|
|
| Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |
12.1.5. .spec.affinity.nodeAffinity Copy linkLink copied to clipboard!
- Description
- Describes node affinity scheduling rules for the pod.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
|
|
| An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). |
|
|
| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
12.1.6. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
12.1.7. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
- Type
-
object - Required
-
preference -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
| A node selector term, associated with the corresponding weight. |
|
|
| Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |
12.1.8. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference Copy linkLink copied to clipboard!
- Description
- A node selector term, associated with the corresponding weight.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| A list of node selector requirements by node’s labels. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| A list of node selector requirements by node’s fields. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
12.1.9. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s labels.
- Type
-
array
12.1.10. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
12.1.11. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s fields.
- Type
-
array
12.1.12. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
12.1.13. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- Description
- If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
- Type
-
object - Required
-
nodeSelectorTerms
-
| Property | Type | Description |
|---|---|---|
|
|
| Required. A list of node selector terms. The terms are ORed. |
|
|
| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. |
12.1.14. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Copy linkLink copied to clipboard!
- Description
- Required. A list of node selector terms. The terms are ORed.
- Type
-
array
12.1.15. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] Copy linkLink copied to clipboard!
- Description
- A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| A list of node selector requirements by node’s labels. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| A list of node selector requirements by node’s fields. |
|
|
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
12.1.16. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s labels.
- Type
-
array
12.1.17. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
12.1.18. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Copy linkLink copied to clipboard!
- Description
- A list of node selector requirements by node’s fields.
- Type
-
array
12.1.19. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] Copy linkLink copied to clipboard!
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| The label key that the selector applies to. |
|
|
| Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
|
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
12.1.20. .spec.affinity.podAffinity Copy linkLink copied to clipboard!
- Description
- Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
|
|
| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) |
|
|
| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
|
|
| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running |
12.1.21. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
12.1.22. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- Type
-
object - Required
-
podAffinityTerm -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
| Required. A pod affinity term, associated with the corresponding weight. |
|
|
| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
12.1.23. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Copy linkLink copied to clipboard!
- Description
- Required. A pod affinity term, associated with the corresponding weight.
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
12.1.24. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.25. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.26. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.27. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.28. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.30. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
12.1.31. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
12.1.32. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.33. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.34. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.35. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.36. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.37. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.38. .spec.affinity.podAntiAffinity Copy linkLink copied to clipboard!
- Description
- Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and 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. |
|
|
| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) |
|
|
| If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
|
|
| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running |
12.1.39. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
12.1.40. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- Type
-
object - Required
-
podAffinityTerm -
weight
-
| Property | Type | Description |
|---|---|---|
|
|
| Required. A pod affinity term, associated with the corresponding weight. |
|
|
| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
12.1.41. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Copy linkLink copied to clipboard!
- Description
- Required. A pod affinity term, associated with the corresponding weight.
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
12.1.42. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.43. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.45. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.48. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution Copy linkLink copied to clipboard!
- 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
12.1.49. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Copy linkLink copied to clipboard!
- Description
- Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
- Type
-
object - Required
-
topologyKey
-
| Property | Type | Description |
|---|---|---|
|
|
| A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
|
|
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 |
|
|
|
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 |
|
|
| 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 specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace". |
|
|
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
12.1.50. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.51. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.53. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.54. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.55. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.56. .spec.alertRelabelConfigs Copy linkLink copied to clipboard!
- 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.
alertRelabelConfigFiletakes precedence over this field.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.57. .spec.alertmanagersConfig Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.58. .spec.containers Copy linkLink copied to clipboard!
- 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-rulerandconfig-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[] Copy linkLink copied to clipboard!
- Description
- A single application container that you want to run within a pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Arguments to the entrypoint. The 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 |
|
|
| 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 |
|
|
| List of environment variables to set in the container. Cannot be updated. |
|
|
| EnvVar represents an environment variable present in a Container. |
|
|
| List of sources to populate environment variables in the container. The keys defined within a source 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. |
|
|
| EnvFromSource represents the source of a set of ConfigMaps or Secrets |
|
|
| 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. |
|
|
| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
|
| Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
|
|
| Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
|
|
| List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. |
|
|
| ContainerPort represents a network port in a single container. |
|
|
| 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 |
|
|
| Resources resize policy for the container. |
|
|
| ContainerResizePolicy represents resource resize policy for the container. |
|
|
| Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| 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. |
|
|
| 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. |
|
|
| ContainerRestartRule describes how a container exit is handled. |
|
|
| SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
|
|
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
|
|
| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
|
|
| Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
|
|
| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
|
|
| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
|
| volumeDevices is the list of block devices to be used by the container. |
|
|
| volumeDevice describes a mapping of a raw block device within a container. |
|
|
| Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
| VolumeMount describes a mounting of a Volume within a container. |
|
|
| Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. |
12.1.60. .spec.containers[].env Copy linkLink copied to clipboard!
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
-
array
12.1.61. .spec.containers[].env[] Copy linkLink copied to clipboard!
- Description
- EnvVar represents an environment variable present in a Container.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the environment variable. May consist of any printable ASCII characters except '='. |
|
|
| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
|
|
| Source for the environment variable’s value. Cannot be used if value is not empty. |
12.1.62. .spec.containers[].env[].valueFrom Copy linkLink copied to clipboard!
- Description
- Source for the environment variable’s value. Cannot be used if value is not empty.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Selects a key of a ConfigMap. |
|
|
|
Selects a field of the pod: supports metadata.name, metadata.namespace, |
|
|
| FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled. |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
| Selects a key of a secret in the pod’s namespace |
12.1.63. .spec.containers[].env[].valueFrom.configMapKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a ConfigMap.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.64. .spec.containers[].env[].valueFrom.fieldRef Copy linkLink copied to clipboard!
- Description
-
Selects a field of the pod: supports metadata.name, metadata.namespace,
metadata.labels['<KEY>'],metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
12.1.65. .spec.containers[].env[].valueFrom.fileKeyRef Copy linkLink copied to clipboard!
- Description
- FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
- Type
-
object - Required
-
key -
path -
volumeName
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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. |
|
|
| The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'. |
|
|
| The name of the volume mount containing the env file. |
12.1.66. .spec.containers[].env[].valueFrom.resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
12.1.67. .spec.containers[].env[].valueFrom.secretKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a secret in the pod’s namespace
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.68. .spec.containers[].envFrom Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- EnvFromSource represents the source of a set of ConfigMaps or Secrets
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The ConfigMap to select from |
|
|
| Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='. |
|
|
| The Secret to select from |
12.1.70. .spec.containers[].envFrom[].configMapRef Copy linkLink copied to clipboard!
- Description
- The ConfigMap to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap must be defined |
12.1.71. .spec.containers[].envFrom[].secretRef Copy linkLink copied to clipboard!
- Description
- The Secret to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret must be defined |
12.1.72. .spec.containers[].lifecycle Copy linkLink copied to clipboard!
- Description
- Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
|
|
| PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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 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 Copy linkLink copied to clipboard!
- Description
- PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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.74. .spec.containers[].lifecycle.postStart.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
12.1.75. .spec.containers[].lifecycle.postStart.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
12.1.76. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
12.1.77. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
12.1.78. .spec.containers[].lifecycle.postStart.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
12.1.79. .spec.containers[].lifecycle.postStart.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
12.1.80. .spec.containers[].lifecycle.preStop Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
12.1.82. .spec.containers[].lifecycle.preStop.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
12.1.83. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
12.1.84. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
12.1.85. .spec.containers[].lifecycle.preStop.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
12.1.86. .spec.containers[].lifecycle.preStop.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
12.1.87. .spec.containers[].livenessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
12.1.88. .spec.containers[].livenessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
12.1.89. .spec.containers[].livenessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
12.1.91. .spec.containers[].livenessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
12.1.92. .spec.containers[].livenessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
12.1.93. .spec.containers[].livenessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
12.1.94. .spec.containers[].ports Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ContainerPort represents a network port in a single container.
- Type
-
object - Required
-
containerPort
-
| Property | Type | Description |
|---|---|---|
|
|
| Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
|
|
| What host IP to bind the external port to. |
|
|
| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. |
|
|
| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
|
|
| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |
12.1.96. .spec.containers[].readinessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
12.1.97. .spec.containers[].readinessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
12.1.98. .spec.containers[].readinessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
12.1.100. .spec.containers[].readinessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
12.1.101. .spec.containers[].readinessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
12.1.102. .spec.containers[].readinessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
12.1.103. .spec.containers[].resizePolicy Copy linkLink copied to clipboard!
- Description
- Resources resize policy for the container.
- Type
-
array
12.1.104. .spec.containers[].resizePolicy[] Copy linkLink copied to clipboard!
- Description
- ContainerResizePolicy represents resource resize policy for the container.
- Type
-
object - Required
-
resourceName -
restartPolicy
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. |
|
|
| Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. |
12.1.105. .spec.containers[].resources Copy linkLink copied to clipboard!
- Description
- Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| ResourceClaim references one entry in PodSpec.ResourceClaims. |
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
12.1.106. .spec.containers[].resources.claims Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ContainerRestartRule describes how a container exit is handled.
- Type
-
object - Required
-
action
-
| Property | Type | Description |
|---|---|---|
|
|
| Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container. |
|
|
| Represents the exit codes to check on container exits. |
12.1.110. .spec.containers[].restartPolicyRules[].exitCodes Copy linkLink copied to clipboard!
- Description
- Represents the exit codes to check on container exits.
- Type
-
object - Required
-
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| Specifies the set of values to check for container exit codes. At most 255 elements are allowed. |
12.1.111. .spec.containers[].securityContext Copy linkLink copied to clipboard!
- Description
- SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
12.1.112. .spec.containers[].securityContext.appArmorProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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.113. .spec.containers[].securityContext.capabilities Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Added capabilities |
|
|
| Removed capabilities |
12.1.114. .spec.containers[].securityContext.seLinuxOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Level is SELinux level label that applies to the container. |
|
|
| Role is a SELinux role label that applies to the container. |
|
|
| Type is a SELinux type label that applies to the container. |
|
|
| User is a SELinux user label that applies to the container. |
12.1.115. .spec.containers[].securityContext.seccompProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. |
|
|
| type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
12.1.116. .spec.containers[].securityContext.windowsOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
| GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
| HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
|
|
| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
12.1.117. .spec.containers[].startupProbe Copy linkLink copied to clipboard!
- Description
- StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
12.1.118. .spec.containers[].startupProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
12.1.119. .spec.containers[].startupProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
12.1.121. .spec.containers[].startupProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
12.1.122. .spec.containers[].startupProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
12.1.123. .spec.containers[].startupProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
12.1.124. .spec.containers[].volumeDevices Copy linkLink copied to clipboard!
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
-
array
12.1.125. .spec.containers[].volumeDevices[] Copy linkLink copied to clipboard!
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
-
object - Required
-
devicePath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| devicePath is the path inside of the container that the device will be mapped to. |
|
|
| name must match the name of a persistentVolumeClaim in the pod |
12.1.126. .spec.containers[].volumeMounts Copy linkLink copied to clipboard!
- Description
- Pod volumes to mount into the container’s filesystem. Cannot be updated.
- Type
-
array
12.1.127. .spec.containers[].volumeMounts[] Copy linkLink copied to clipboard!
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). |
|
|
| This must match the Name of a Volume. |
|
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
| 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. |
|
|
| Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
| Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
12.1.128. .spec.dnsConfig Copy linkLink copied to clipboard!
- Description
- dnsConfig defines Defines the DNS configuration for the pods.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. |
|
|
| 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. |
|
|
| PodDNSConfigOption defines DNS resolver options of a pod. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- PodDNSConfigOption defines DNS resolver options of a pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| name is required and must be unique. |
|
|
| value is optional. |
12.1.131. .spec.excludedFromEnforcement Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.
- Type
-
object - Required
-
namespace -
resource
-
| Property | Type | Description |
|---|---|---|
|
|
|
group of the referent. When not specified, it defaults to |
|
|
| name of the referent. When not set, all resources in the namespace are matched. |
|
|
| namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| resource of the referent. |
12.1.133. .spec.grpcServerTlsConfig Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| caFile defines the path to the CA cert in the Prometheus container to use for the targets. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| certFile defines the path to the client cert file in the Prometheus container for the targets. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keyFile defines the path to the client key file in the Prometheus container for the targets. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
12.1.134. .spec.grpcServerTlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
12.1.135. .spec.grpcServerTlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.136. .spec.grpcServerTlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.137. .spec.grpcServerTlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
12.1.138. .spec.grpcServerTlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.139. .spec.grpcServerTlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.140. .spec.grpcServerTlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.141. .spec.hostAliases Copy linkLink copied to clipboard!
- Description
- hostAliases defines pods' hostAliases configuration
- Type
-
array
12.1.142. .spec.hostAliases[] Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| hostnames defines hostnames for the above IP address. |
|
|
| ip defines the IP address of the host file entry. |
12.1.143. .spec.imagePullSecrets Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- A single application container that you want to run within a pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Arguments to the entrypoint. The 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 |
|
|
| 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 |
|
|
| List of environment variables to set in the container. Cannot be updated. |
|
|
| EnvVar represents an environment variable present in a Container. |
|
|
| List of sources to populate environment variables in the container. The keys defined within a source 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. |
|
|
| EnvFromSource represents the source of a set of ConfigMaps or Secrets |
|
|
| 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. |
|
|
| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
|
| Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
|
|
| Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
|
|
| List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. |
|
|
| ContainerPort represents a network port in a single container. |
|
|
| 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 |
|
|
| Resources resize policy for the container. |
|
|
| ContainerResizePolicy represents resource resize policy for the container. |
|
|
| Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| 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. |
|
|
| 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. |
|
|
| ContainerRestartRule describes how a container exit is handled. |
|
|
| SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
|
|
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
|
|
| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
|
|
| Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
|
|
| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
|
|
| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
|
| volumeDevices is the list of block devices to be used by the container. |
|
|
| volumeDevice describes a mapping of a raw block device within a container. |
|
|
| Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
| VolumeMount describes a mounting of a Volume within a container. |
|
|
| Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. |
12.1.147. .spec.initContainers[].env Copy linkLink copied to clipboard!
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
-
array
12.1.148. .spec.initContainers[].env[] Copy linkLink copied to clipboard!
- Description
- EnvVar represents an environment variable present in a Container.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the environment variable. May consist of any printable ASCII characters except '='. |
|
|
| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
|
|
| Source for the environment variable’s value. Cannot be used if value is not empty. |
12.1.149. .spec.initContainers[].env[].valueFrom Copy linkLink copied to clipboard!
- Description
- Source for the environment variable’s value. Cannot be used if value is not empty.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Selects a key of a ConfigMap. |
|
|
|
Selects a field of the pod: supports metadata.name, metadata.namespace, |
|
|
| FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled. |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
| Selects a key of a secret in the pod’s namespace |
12.1.150. .spec.initContainers[].env[].valueFrom.configMapKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a ConfigMap.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.151. .spec.initContainers[].env[].valueFrom.fieldRef Copy linkLink copied to clipboard!
- Description
-
Selects a field of the pod: supports metadata.name, metadata.namespace,
metadata.labels['<KEY>'],metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
12.1.152. .spec.initContainers[].env[].valueFrom.fileKeyRef Copy linkLink copied to clipboard!
- Description
- FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
- Type
-
object - Required
-
key -
path -
volumeName
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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. |
|
|
| The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'. |
|
|
| The name of the volume mount containing the env file. |
12.1.153. .spec.initContainers[].env[].valueFrom.resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
12.1.154. .spec.initContainers[].env[].valueFrom.secretKeyRef Copy linkLink copied to clipboard!
- Description
- Selects a key of a secret in the pod’s namespace
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.155. .spec.initContainers[].envFrom Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- EnvFromSource represents the source of a set of ConfigMaps or Secrets
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| The ConfigMap to select from |
|
|
| Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='. |
|
|
| The Secret to select from |
12.1.157. .spec.initContainers[].envFrom[].configMapRef Copy linkLink copied to clipboard!
- Description
- The ConfigMap to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap must be defined |
12.1.158. .spec.initContainers[].envFrom[].secretRef Copy linkLink copied to clipboard!
- Description
- The Secret to select from
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret must be defined |
12.1.159. .spec.initContainers[].lifecycle Copy linkLink copied to clipboard!
- Description
- Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
|
|
| PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The 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 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.160. .spec.initContainers[].lifecycle.postStart Copy linkLink copied to clipboard!
- Description
- PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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.161. .spec.initContainers[].lifecycle.postStart.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
12.1.162. .spec.initContainers[].lifecycle.postStart.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
12.1.163. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
12.1.164. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
12.1.165. .spec.initContainers[].lifecycle.postStart.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
12.1.166. .spec.initContainers[].lifecycle.postStart.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
12.1.167. .spec.initContainers[].lifecycle.preStop Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Sleep represents a duration that the container should sleep. |
|
|
| 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.168. .spec.initContainers[].lifecycle.preStop.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
12.1.169. .spec.initContainers[].lifecycle.preStop.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
12.1.170. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
12.1.171. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
12.1.172. .spec.initContainers[].lifecycle.preStop.sleep Copy linkLink copied to clipboard!
- Description
- Sleep represents a duration that the container should sleep.
- Type
-
object - Required
-
seconds
-
| Property | Type | Description |
|---|---|---|
|
|
| Seconds is the number of seconds to sleep. |
12.1.173. .spec.initContainers[].lifecycle.preStop.tcpSocket Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
12.1.174. .spec.initContainers[].livenessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
12.1.175. .spec.initContainers[].livenessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
12.1.176. .spec.initContainers[].livenessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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.177. .spec.initContainers[].livenessProbe.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
12.1.178. .spec.initContainers[].livenessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
12.1.179. .spec.initContainers[].livenessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
12.1.180. .spec.initContainers[].livenessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
12.1.181. .spec.initContainers[].ports Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ContainerPort represents a network port in a single container.
- Type
-
object - Required
-
containerPort
-
| Property | Type | Description |
|---|---|---|
|
|
| Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
|
|
| What host IP to bind the external port to. |
|
|
| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. |
|
|
| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
|
|
| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |
12.1.183. .spec.initContainers[].readinessProbe Copy linkLink copied to clipboard!
- Description
- Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
12.1.184. .spec.initContainers[].readinessProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
12.1.185. .spec.initContainers[].readinessProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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.186. .spec.initContainers[].readinessProbe.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
12.1.187. .spec.initContainers[].readinessProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
12.1.188. .spec.initContainers[].readinessProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
12.1.189. .spec.initContainers[].readinessProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
12.1.190. .spec.initContainers[].resizePolicy Copy linkLink copied to clipboard!
- Description
- Resources resize policy for the container.
- Type
-
array
12.1.191. .spec.initContainers[].resizePolicy[] Copy linkLink copied to clipboard!
- Description
- ContainerResizePolicy represents resource resize policy for the container.
- Type
-
object - Required
-
resourceName -
restartPolicy
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. |
|
|
| Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. |
12.1.192. .spec.initContainers[].resources Copy linkLink copied to clipboard!
- Description
- Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| ResourceClaim references one entry in PodSpec.ResourceClaims. |
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
12.1.193. .spec.initContainers[].resources.claims Copy linkLink copied to clipboard!
- 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.194. .spec.initContainers[].resources.claims[] Copy linkLink copied to clipboard!
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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.195. .spec.initContainers[].restartPolicyRules Copy linkLink copied to clipboard!
- 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.196. .spec.initContainers[].restartPolicyRules[] Copy linkLink copied to clipboard!
- Description
- ContainerRestartRule describes how a container exit is handled.
- Type
-
object - Required
-
action
-
| Property | Type | Description |
|---|---|---|
|
|
| Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container. |
|
|
| Represents the exit codes to check on container exits. |
12.1.197. .spec.initContainers[].restartPolicyRules[].exitCodes Copy linkLink copied to clipboard!
- Description
- Represents the exit codes to check on container exits.
- Type
-
object - Required
-
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| Specifies the set of values to check for container exit codes. At most 255 elements are allowed. |
12.1.198. .spec.initContainers[].securityContext Copy linkLink copied to clipboard!
- Description
- SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
12.1.199. .spec.initContainers[].securityContext.appArmorProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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.200. .spec.initContainers[].securityContext.capabilities Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Added capabilities |
|
|
| Removed capabilities |
12.1.201. .spec.initContainers[].securityContext.seLinuxOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Level is SELinux level label that applies to the container. |
|
|
| Role is a SELinux role label that applies to the container. |
|
|
| Type is a SELinux type label that applies to the container. |
|
|
| User is a SELinux user label that applies to the container. |
12.1.202. .spec.initContainers[].securityContext.seccompProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. |
|
|
| type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
12.1.203. .spec.initContainers[].securityContext.windowsOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
| GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
| HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
|
|
| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
12.1.204. .spec.initContainers[].startupProbe Copy linkLink copied to clipboard!
- Description
- StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Exec specifies a command to execute in the container. |
|
|
| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
|
| GRPC specifies a GRPC HealthCheckRequest. |
|
|
| HTTPGet specifies an HTTP GET request to perform. |
|
|
| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
|
| TCPSocket specifies a connection to a TCP port. |
|
|
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. |
|
|
| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
12.1.205. .spec.initContainers[].startupProbe.exec Copy linkLink copied to clipboard!
- Description
- Exec specifies a command to execute in the container.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
12.1.206. .spec.initContainers[].startupProbe.grpc Copy linkLink copied to clipboard!
- Description
- GRPC specifies a GRPC HealthCheckRequest.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Port number of the gRPC service. Number must be in the range 1 to 65535. |
|
|
| 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.207. .spec.initContainers[].startupProbe.httpGet Copy linkLink copied to clipboard!
- Description
- HTTPGet specifies an HTTP GET request to perform.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
|
| Custom headers to set in the request. HTTP allows repeated headers. |
|
|
| HTTPHeader describes a custom header to be used in HTTP probes |
|
|
| Path to access on the HTTP server. |
|
|
| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
|
|
| Scheme to use for connecting to the host. Defaults to HTTP. |
12.1.208. .spec.initContainers[].startupProbe.httpGet.httpHeaders Copy linkLink copied to clipboard!
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
-
array
12.1.209. .spec.initContainers[].startupProbe.httpGet.httpHeaders[] Copy linkLink copied to clipboard!
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. |
|
|
| The header field value |
12.1.210. .spec.initContainers[].startupProbe.tcpSocket Copy linkLink copied to clipboard!
- Description
- TCPSocket specifies a connection to a TCP port.
- Type
-
object - Required
-
port
-
| Property | Type | Description |
|---|---|---|
|
|
| Optional: Host name to connect to, defaults to the pod IP. |
|
|
| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
12.1.211. .spec.initContainers[].volumeDevices Copy linkLink copied to clipboard!
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
-
array
12.1.212. .spec.initContainers[].volumeDevices[] Copy linkLink copied to clipboard!
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
-
object - Required
-
devicePath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| devicePath is the path inside of the container that the device will be mapped to. |
|
|
| name must match the name of a persistentVolumeClaim in the pod |
12.1.213. .spec.initContainers[].volumeMounts Copy linkLink copied to clipboard!
- Description
- Pod volumes to mount into the container’s filesystem. Cannot be updated.
- Type
-
array
12.1.214. .spec.initContainers[].volumeMounts[] Copy linkLink copied to clipboard!
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). |
|
|
| This must match the Name of a Volume. |
|
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
| 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. |
|
|
| Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
| Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
12.1.215. .spec.objectStorageConfig Copy linkLink copied to clipboard!
- 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.
objectStorageConfigFiletakes precedence over this field.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.216. .spec.podMetadata Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 Copy linkLink copied to clipboard!
- 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
12.1.218. .spec.prometheusRulesExcludedFromEnforce[] Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| ruleName defines the name of the excluded PrometheusRule object. |
|
|
| ruleNamespace defines the namespace of the excluded PrometheusRule object. |
12.1.219. .spec.queryConfig Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.220. .spec.remoteWrite Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- RemoteWriteSpec defines the configuration to write samples from Prometheus to a remote endpoint.
- Type
-
object - Required
-
url
-
| Property | Type | 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 |
|
|
| azureAd for the URL. It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.
Cannot be set at the same time as |
|
|
| basicAuth configuration for the URL.
Cannot be set at the same time as |
|
|
|
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 |
|
|
| bearerTokenFile defines the file from which to read bearer token for the URL.
Deprecated: this will be removed in a future release. Prefer using |
|
|
| enableHTTP2 defines whether to enable HTTP2. |
|
|
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. |
|
|
| 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 defines the Remote Write message’s version to use when writing to the endpoint.
When 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 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 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 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 configuration for the URL. It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.
Cannot be set at the same time as |
|
|
| 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| queueConfig allows tuning of the remote write queue parameters. |
|
|
| remoteTimeout defines the timeout for requests to the remote write endpoint. |
|
|
| 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 enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. |
|
|
| 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 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 |
|
|
| tlsConfig to use for the URL. |
|
|
| url defines the URL of the endpoint to send samples to. |
|
|
| writeRelabelConfigs defines the list of remote write relabel configurations. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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, orazureAd.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
|
credentialsFile defines the file to read a secret from, mutually exclusive with |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
12.1.223. .spec.remoteWrite[].authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.224. .spec.remoteWrite[].azureAd Copy linkLink copied to clipboard!
- 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, orsigv4.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. |
|
|
|
managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as |
|
|
|
oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0. |
|
|
|
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 It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0. |
12.1.225. .spec.remoteWrite[].azureAd.managedIdentity Copy linkLink copied to clipboard!
- Description
-
managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as
oauthorsdk. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 Copy linkLink copied to clipboard!
- Description
oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as
managedIdentityorsdk.It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.
- Type
-
object - Required
-
clientId -
clientSecret -
tenantId
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines the clientId of the Azure Active Directory application that is being used to authenticate. |
|
|
| clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate. |
|
|
| tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate. |
12.1.227. .spec.remoteWrite[].azureAd.oauth.clientSecret Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.228. .spec.remoteWrite[].azureAd.sdk Copy linkLink copied to clipboard!
- 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
oauthormanagedIdentity.It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| tenantId defines the tenant ID of the azure active directory application that is being used to authenticate. |
12.1.229. .spec.remoteWrite[].basicAuth Copy linkLink copied to clipboard!
- Description
basicAuth configuration for the URL.
Cannot be set at the same time as
sigv4,authorization,oauth2, orazureAd.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
12.1.230. .spec.remoteWrite[].basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.231. .spec.remoteWrite[].basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.232. .spec.remoteWrite[].metadataConfig Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| maxSamplesPerSend defines the maximum number of metadata samples per send. It requires Prometheus >= v2.29.0. |
|
|
| send defines whether metric metadata is sent to the remote storage or not. |
|
|
| sendInterval defines how frequently metric metadata is sent to the remote storage. |
12.1.233. .spec.remoteWrite[].oauth2 Copy linkLink copied to clipboard!
- 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, orazureAd.- Type
-
object - Required
-
clientId -
clientSecret -
tokenUrl
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| 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 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. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| 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 defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
12.1.234. .spec.remoteWrite[].oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
12.1.235. .spec.remoteWrite[].oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.236. .spec.remoteWrite[].oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.237. .spec.remoteWrite[].oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.238. .spec.remoteWrite[].oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- 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.239. .spec.remoteWrite[].oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
12.1.240. .spec.remoteWrite[].oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.241. .spec.remoteWrite[].oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
12.1.242. .spec.remoteWrite[].oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
12.1.243. .spec.remoteWrite[].oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.244. .spec.remoteWrite[].oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.245. .spec.remoteWrite[].oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
12.1.246. .spec.remoteWrite[].oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.247. .spec.remoteWrite[].oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.248. .spec.remoteWrite[].oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.249. .spec.remoteWrite[].proxyConnectHeader Copy linkLink copied to clipboard!
- 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{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
12.1.251. .spec.remoteWrite[].proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.252. .spec.remoteWrite[].queueConfig Copy linkLink copied to clipboard!
- Description
- queueConfig allows tuning of the remote write queue parameters.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| batchSendDeadline defines the maximum time a sample will wait in buffer. |
|
|
| capacity defines the number of samples to buffer per shard before we start dropping them. |
|
|
| maxBackoff defines the maximum retry delay. |
|
|
| maxRetries defines the maximum number of times to retry a batch on recoverable errors. |
|
|
| maxSamplesPerSend defines the maximum number of samples per send. |
|
|
| maxShards defines the maximum number of shards, i.e. amount of concurrency. |
|
|
| minBackoff defines the initial retry delay. Gets doubled for every retry. |
|
|
| minShards defines the minimum number of shards, i.e. amount of concurrency. |
|
|
| 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 drops samples older than the limit. It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0. |
12.1.253. .spec.remoteWrite[].sigv4 Copy linkLink copied to clipboard!
- 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, orazureAd.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
accessKey defines the AWS API key. If not specified, the environment variable |
|
|
| profile defines the named AWS profile used to authenticate. |
|
|
| region defines the AWS region. If blank, the region from the default credentials chain used. |
|
|
| roleArn defines the named AWS profile used to authenticate. |
|
|
|
secretKey defines the AWS API secret. If not specified, the environment variable |
|
|
| useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. It requires Prometheus >= v2.54.0. |
12.1.254. .spec.remoteWrite[].sigv4.accessKey Copy linkLink copied to clipboard!
- Description
-
accessKey defines the AWS API key. If not specified, the environment variable
AWS_ACCESS_KEY_IDis used. - Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.255. .spec.remoteWrite[].sigv4.secretKey Copy linkLink copied to clipboard!
- Description
-
secretKey defines the AWS API secret. If not specified, the environment variable
AWS_SECRET_ACCESS_KEYis used. - Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.256. .spec.remoteWrite[].tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig to use for the URL.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| caFile defines the path to the CA cert in the Prometheus container to use for the targets. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| certFile defines the path to the client cert file in the Prometheus container for the targets. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keyFile defines the path to the client key file in the Prometheus container for the targets. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
12.1.257. .spec.remoteWrite[].tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
12.1.258. .spec.remoteWrite[].tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.259. .spec.remoteWrite[].tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.260. .spec.remoteWrite[].tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
12.1.261. .spec.remoteWrite[].tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.262. .spec.remoteWrite[].tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.263. .spec.remoteWrite[].tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.264. .spec.remoteWrite[].writeRelabelConfigs Copy linkLink copied to clipboard!
- Description
- writeRelabelConfigs defines the list of remote write relabel configurations.
- Type
-
array
12.1.265. .spec.remoteWrite[].writeRelabelConfigs[] Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| 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 defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
12.1.266. .spec.resources Copy linkLink copied to clipboard!
- Description
- resources defines the resource requirements for single Pods. If not provided, no requests/limits will be set
- Type
-
object
| Property | Type | 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. |
|
|
| ResourceClaim references one entry in PodSpec.ResourceClaims. |
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
12.1.267. .spec.resources.claims Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.270. .spec.ruleNamespaceSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.271. .spec.ruleNamespaceSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.272. .spec.ruleSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.273. .spec.ruleSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.274. .spec.ruleSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.275. .spec.securityContext Copy linkLink copied to clipboard!
- Description
- securityContext defines the pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
- Type
-
object
| Property | Type | 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. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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 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. |
|
|
| 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. |
|
|
| The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows. |
|
|
| 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. |
|
|
| 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 hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows. |
|
|
| Sysctl defines a kernel parameter to be set |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Level is SELinux level label that applies to the container. |
|
|
| Role is a SELinux role label that applies to the container. |
|
|
| Type is a SELinux type label that applies to the container. |
|
|
| User is a SELinux user label that applies to the container. |
12.1.278. .spec.securityContext.seccompProfile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. |
|
|
| type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
12.1.279. .spec.securityContext.sysctls Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Sysctl defines a kernel parameter to be set
- Type
-
object - Required
-
name -
value
-
| Property | Type | Description |
|---|---|---|
|
|
| Name of a property to set |
|
|
| Value of a property to set |
12.1.281. .spec.securityContext.windowsOptions Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
| GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
| HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
|
|
| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
12.1.282. .spec.storage Copy linkLink copied to clipboard!
- Description
- storage defines the specification of how storage shall be used.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| disableMountSubPath deprecated: subPath usage will be removed in a future release. |
|
|
|
emptyDir to be used by the StatefulSet. If specified, it takes precedence over |
|
|
| 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 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 Copy linkLink copied to clipboard!
- Description
-
emptyDir to be used by the StatefulSet. If specified, it takes precedence over
ephemeralandvolumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
|
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be 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. |
12.1.285. .spec.storage.ephemeral.volumeClaimTemplate Copy linkLink copied to clipboard!
- Description
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be
<pod name>-<volume name>where<volume name>is the name from thePodSpec.Volumesarray entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
- Type
-
object - Required
-
spec
-
| Property | Type | Description |
|---|---|---|
|
|
| May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. |
|
|
| The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. |
12.1.286. .spec.storage.ephemeral.volumeClaimTemplate.metadata Copy linkLink copied to clipboard!
- 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
12.1.287. .spec.storage.ephemeral.volumeClaimTemplate.spec Copy linkLink copied to clipboard!
- Description
- The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
| 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 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 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 is a label query over volumes to consider for binding. |
|
|
| storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| 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 defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
| volumeName is the binding reference to the PersistentVolume backing this claim. |
12.1.288. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
12.1.289. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
|
|
| 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. |
12.1.290. .spec.storage.ephemeral.volumeClaimTemplate.spec.resources Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
12.1.291. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector Copy linkLink copied to clipboard!
- Description
- selector is a label query over volumes to consider for binding.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.292. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.293. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.294. .spec.storage.volumeClaimTemplate Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. |
|
|
| 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 is deprecated: this field is never set. |
12.1.295. .spec.storage.volumeClaimTemplate.metadata Copy linkLink copied to clipboard!
- Description
- metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
| 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 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 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 is a label query over volumes to consider for binding. |
|
|
| storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| 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 defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
| volumeName is the binding reference to the PersistentVolume backing this claim. |
12.1.297. .spec.storage.volumeClaimTemplate.spec.dataSource Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
12.1.298. .spec.storage.volumeClaimTemplate.spec.dataSourceRef Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
|
|
| 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. |
12.1.299. .spec.storage.volumeClaimTemplate.spec.resources Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
12.1.300. .spec.storage.volumeClaimTemplate.spec.selector Copy linkLink copied to clipboard!
- Description
- selector is a label query over volumes to consider for binding.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.301. .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.302. .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.303. .spec.storage.volumeClaimTemplate.status Copy linkLink copied to clipboard!
- Description
- status is deprecated: this field is never set.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 represents the actual resources of the underlying volume. |
|
|
| conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'. |
|
|
| PersistentVolumeClaimCondition contains details about state of pvc |
|
|
| currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim |
|
|
| ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. |
|
|
| phase represents the current phase of PersistentVolumeClaim. |
12.1.304. .spec.storage.volumeClaimTemplate.status.conditions Copy linkLink copied to clipboard!
- 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
12.1.305. .spec.storage.volumeClaimTemplate.status.conditions[] Copy linkLink copied to clipboard!
- Description
- PersistentVolumeClaimCondition contains details about state of pvc
- Type
-
object - Required
-
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastProbeTime is the time we probed the condition. |
|
|
| lastTransitionTime is the time the condition transitioned from one status to another. |
|
|
| message is the human-readable message indicating details about last transition. |
|
|
| 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 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 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 |
12.1.306. .spec.storage.volumeClaimTemplate.status.modifyVolumeStatus Copy linkLink copied to clipboard!
- Description
- ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.
- Type
-
object - Required
-
status
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the name of the VolumeAttributesClass the PVC currently being reconciled |
12.1.307. .spec.tolerations Copy linkLink copied to clipboard!
- Description
- tolerations defines when specified, the pod’s tolerations.
- Type
-
array
12.1.308. .spec.tolerations[] Copy linkLink copied to clipboard!
- Description
- The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
|
|
| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
|
|
| Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
|
|
| TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
|
|
| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
12.1.309. .spec.topologySpreadConstraints Copy linkLink copied to clipboard!
- Description
- topologySpreadConstraints defines the pod’s topology spread constraints.
- Type
-
array
12.1.310. .spec.topologySpreadConstraints[] Copy linkLink copied to clipboard!
- Description
- TopologySpreadConstraint specifies how to spread matching pods among the given topology.
- Type
-
object - Required
-
maxSkew -
topologyKey -
whenUnsatisfiable
-
| Property | Type | Description |
|---|---|---|
|
|
| LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. |
|
|
| 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 describes the degree to which pods may be unevenly distributed. When |
|
|
| 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 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 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 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 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. |
12.1.311. .spec.topologySpreadConstraints[].labelSelector Copy linkLink copied to clipboard!
- Description
- LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.312. .spec.topologySpreadConstraints[].labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.313. .spec.topologySpreadConstraints[].labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.314. .spec.tracingConfig Copy linkLink copied to clipboard!
- 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.
tracingConfigFiletakes precedence over this field.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.315. .spec.volumeMounts Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
mountPath -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). |
|
|
| This must match the Name of a Volume. |
|
|
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
| 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. |
|
|
| Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
| Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
12.1.317. .spec.volumes Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Volume represents a named volume in a pod that may be accessed by any container in the pod.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. 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 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 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 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 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 represents a configMap that should populate this volume |
|
|
| csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers. |
|
|
| downwardAPI represents downward API about the pod that should populate this volume |
|
|
| emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
|
| ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. |
|
|
| fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
|
|
| flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. |
|
|
| 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 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 represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container. |
|
|
| glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. |
|
|
| 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 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 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 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 represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
| photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. |
|
|
| 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 items for all in one resources secrets, configmaps, and downward API |
|
|
| quobyte represents a Quobyte mount on the host that shares a pod’s lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. |
|
|
| 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 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 represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
|
| storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| cachingMode is the Host Caching mode: None, Read Only, Read Write. |
|
|
| diskName is the Name of the data disk in the blob storage |
|
|
| diskURI is the URI of data disk in the blob storage |
|
|
| 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 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 Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
12.1.321. .spec.volumes[].azureFile Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| secretName is the name of secret that contains Azure Storage Account Name and Key |
|
|
| shareName is the azure share Name |
12.1.322. .spec.volumes[].cephfs Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
|
|
| 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 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 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 is optional: points to a secret object containing parameters used to connect to OpenStack. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- configMap represents a configMap that should populate this volume
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| optional specify whether the ConfigMap or its keys must be defined |
12.1.327. .spec.volumes[].configMap.items Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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 Copy linkLink copied to clipboard!
- Description
- csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
- Type
-
object - Required
-
driver
-
| Property | Type | Description |
|---|---|---|
|
|
| driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. |
|
|
| 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 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 specifies a read-only configuration for the volume. Defaults to false (read/write). |
|
|
| volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values. |
12.1.330. .spec.volumes[].csi.nodePublishSecretRef Copy linkLink copied to clipboard!
- Description
- nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- downwardAPI represents downward API about the pod that should populate this volume
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
| Items is a list of downward API volume file |
|
|
| DownwardAPIVolumeFile represents information to create the file containing the pod field |
12.1.332. .spec.volumes[].downwardAPI.items Copy linkLink copied to clipboard!
- Description
- Items is a list of downward API volume file
- Type
-
array
12.1.333. .spec.volumes[].downwardAPI.items[] Copy linkLink copied to clipboard!
- Description
- DownwardAPIVolumeFile represents information to create the file containing the pod field
- Type
-
object - Required
-
path
-
| Property | Type | Description |
|---|---|---|
|
|
| Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. |
|
|
| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
12.1.334. .spec.volumes[].downwardAPI.items[].fieldRef Copy linkLink copied to clipboard!
- Description
- Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
12.1.335. .spec.volumes[].downwardAPI.items[].resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
12.1.336. .spec.volumes[].emptyDir Copy linkLink copied to clipboard!
- Description
- emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
|
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be 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. |
12.1.338. .spec.volumes[].ephemeral.volumeClaimTemplate Copy linkLink copied to clipboard!
- Description
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be
<pod name>-<volume name>where<volume name>is the name from thePodSpec.Volumesarray entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
- Type
-
object - Required
-
spec
-
| Property | Type | Description |
|---|---|---|
|
|
| May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. |
|
|
| The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. |
12.1.339. .spec.volumes[].ephemeral.volumeClaimTemplate.metadata Copy linkLink copied to clipboard!
- 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
12.1.340. .spec.volumes[].ephemeral.volumeClaimTemplate.spec Copy linkLink copied to clipboard!
- Description
- The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
| 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 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 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 is a label query over volumes to consider for binding. |
|
|
| storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| 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 defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
| volumeName is the binding reference to the PersistentVolume backing this claim. |
12.1.341. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
12.1.342. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
|
| Kind is the type of resource being referenced |
|
|
| Name is the name of resource being referenced |
|
|
| 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. |
12.1.343. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
12.1.344. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector Copy linkLink copied to clipboard!
- Description
- selector is a label query over volumes to consider for binding.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.345. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.346. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.347. .spec.volumes[].fc Copy linkLink copied to clipboard!
- Description
- fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 is Optional: FC target lun number |
|
|
| readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| targetWWNs is Optional: FC target worldwide names (WWNs) |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| driver is the name of the driver to use for this volume. |
|
|
| 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 is Optional: this field holds extra command options if any. |
|
|
| readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| datasetName is Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated |
|
|
| datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset |
12.1.351. .spec.volumes[].gcePersistentDisk Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 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 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 Copy linkLink copied to clipboard!
- Description
- gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.
- Type
-
object - Required
-
repository
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the URL |
|
|
| revision is the commit hash for the specified revision. |
12.1.353. .spec.volumes[].glusterfs Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| endpoints is the endpoint name that details Glusterfs topology. |
|
|
| path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
|
| readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
12.1.354. .spec.volumes[].hostPath Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
|
| type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
12.1.355. .spec.volumes[].image Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication |
|
|
| chapAuthSession defines whether support iSCSI Session CHAP authentication |
|
|
| 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 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 is the target iSCSI Qualified Name. |
|
|
| iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). |
|
|
| lun represents iSCSI Target Lun number. |
|
|
| 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 here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
|
|
| secretRef is the CHAP Secret for iSCSI target and initiator authentication |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef is the CHAP Secret for iSCSI target and initiator authentication
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- Type
-
object - Required
-
path -
server
-
| Property | Type | Description |
|---|---|---|
|
|
| path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
12.1.359. .spec.volumes[].persistentVolumeClaim Copy linkLink copied to clipboard!
- Description
- persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- Type
-
object - Required
-
claimName
-
| Property | Type | Description |
|---|---|---|
|
|
| claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
| readOnly Will force the ReadOnly setting in VolumeMounts. Default false. |
12.1.360. .spec.volumes[].photonPersistentDisk Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the ID that identifies Photon Controller persistent disk |
12.1.361. .spec.volumes[].portworxVolume Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
| readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| volumeID uniquely identifies a Portworx volume |
12.1.362. .spec.volumes[].projected Copy linkLink copied to clipboard!
- Description
- projected items for all in one resources secrets, configmaps, and downward API
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the list of volume projections. Each entry in this list handles one source. |
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
|
ClusterTrustBundle allows a pod to access the 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 information about the configMap data to project |
|
|
| downwardAPI information about the downwardAPI data to project |
|
|
| 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 information about the secret data to project |
|
|
| serviceAccountToken is information about the serviceAccountToken data to project |
12.1.365. .spec.volumes[].projected.sources[].clusterTrustBundle Copy linkLink copied to clipboard!
- Description
ClusterTrustBundle allows a pod to access the
.spec.trustBundlefield 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
-
| Property | Type | 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". |
|
|
| Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector. |
|
|
| 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. |
|
|
| Relative path from the volume root to write the bundle. |
|
|
| Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated. |
12.1.366. .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
12.1.367. .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
12.1.368. .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[] Copy linkLink copied to clipboard!
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
key -
operator
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
12.1.369. .spec.volumes[].projected.sources[].configMap Copy linkLink copied to clipboard!
- Description
- configMap information about the configMap data to project
- Type
-
object
| Property | Type | 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 '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| optional specify whether the ConfigMap or its keys must be defined |
12.1.370. .spec.volumes[].projected.sources[].configMap.items Copy linkLink copied to clipboard!
- 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.371. .spec.volumes[].projected.sources[].configMap.items[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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.372. .spec.volumes[].projected.sources[].downwardAPI Copy linkLink copied to clipboard!
- Description
- downwardAPI information about the downwardAPI data to project
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Items is a list of DownwardAPIVolume file |
|
|
| DownwardAPIVolumeFile represents information to create the file containing the pod field |
12.1.373. .spec.volumes[].projected.sources[].downwardAPI.items Copy linkLink copied to clipboard!
- Description
- Items is a list of DownwardAPIVolume file
- Type
-
array
12.1.374. .spec.volumes[].projected.sources[].downwardAPI.items[] Copy linkLink copied to clipboard!
- Description
- DownwardAPIVolumeFile represents information to create the file containing the pod field
- Type
-
object - Required
-
path
-
| Property | Type | Description |
|---|---|---|
|
|
| Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. |
|
|
| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
|
|
| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
12.1.375. .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef Copy linkLink copied to clipboard!
- Description
- Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- Type
-
object - Required
-
fieldPath
-
| Property | Type | Description |
|---|---|---|
|
|
| Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
| Path of the field to select in the specified API version. |
12.1.376. .spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef Copy linkLink copied to clipboard!
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- Type
-
object - Required
-
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name: required for volumes, optional for env vars |
|
|
| Specifies the output format of the exposed resources, defaults to "1" |
|
|
| Required: resource to select |
12.1.377. .spec.volumes[].projected.sources[].podCertificate Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| The type of keypair Kubelet will generate for the pod. Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521", and "ED25519". |
|
|
| 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. |
|
|
| Kubelet’s generated CSRs will be addressed to this signer. |
12.1.378. .spec.volumes[].projected.sources[].secret Copy linkLink copied to clipboard!
- Description
- secret information about the secret data to project
- Type
-
object
| Property | Type | 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 '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| optional field specify whether the Secret or its key must be defined |
12.1.379. .spec.volumes[].projected.sources[].secret.items Copy linkLink copied to clipboard!
- 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.380. .spec.volumes[].projected.sources[].secret.items[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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.381. .spec.volumes[].projected.sources[].serviceAccountToken Copy linkLink copied to clipboard!
- Description
- serviceAccountToken is information about the serviceAccountToken data to project
- Type
-
object - Required
-
path
-
| Property | Type | Description |
|---|---|---|
|
|
| audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. |
|
|
| expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. |
|
|
| path is the path relative to the mount point of the file to project the token into. |
12.1.382. .spec.volumes[].quobyte Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| group to map volume access to Default is no group |
|
|
| readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
|
|
| registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
|
|
| tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin |
|
|
| user to map volume access to Defaults to serivceaccount user |
|
|
| volume is a string that references an already created Quobyte volume by name. |
12.1.383. .spec.volumes[].rbd Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the host address of the ScaleIO API Gateway. |
|
|
| protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. |
|
|
| readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
|
|
| sslEnabled Flag enable/disable SSL communication with Gateway, default false |
|
|
| storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. |
|
|
| storagePool is the ScaleIO Storage Pool associated with the protection domain. |
|
|
| system is the name of the storage system as configured in ScaleIO. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- Description
- secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| 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 If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
| Maps a string key to a path within a volume. |
|
|
| optional field specify whether the Secret or its keys must be defined |
|
|
| 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 Copy linkLink copied to clipboard!
- 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[] Copy linkLink copied to clipboard!
- Description
- Maps a string key to a path within a volume.
- Type
-
object - Required
-
key -
path
-
| Property | Type | Description |
|---|---|---|
|
|
| key is the key to project. |
|
|
| 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 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 Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| 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 defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
| secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. |
|
|
| volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. |
|
|
| volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |
12.1.391. .spec.volumes[].storageos.secretRef Copy linkLink copied to clipboard!
- Description
- secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of 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 Copy linkLink copied to clipboard!
- 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
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. |
|
|
| storagePolicyName is the storage Policy Based Management (SPBM) profile name. |
|
|
| volumePath is the path that identifies vSphere volume vmdk |
12.1.393. .spec.web Copy linkLink copied to clipboard!
- Description
- web defines the configuration of the ThanosRuler web server.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| httpConfig defines HTTP parameters for web server. |
|
|
| tlsConfig defines the TLS parameters for HTTPS. |
12.1.394. .spec.web.httpConfig Copy linkLink copied to clipboard!
- Description
- httpConfig defines HTTP parameters for web server.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| headers defines a list of headers that can be added to HTTP responses. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- headers defines a list of headers that can be added to HTTP responses.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. |
|
|
| 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 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 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 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 Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS parameters for HTTPS.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| cert defines the Secret or ConfigMap containing the TLS certificate for the web server.
Either
It is mutually exclusive with |
|
|
| certFile defines the path to the TLS certificate file in the container for the web server.
Either
It is mutually exclusive with |
|
|
| 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 defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType |
|
|
| clientCAFile defines the path to the CA certificate file for client certificate authentication to the server.
It is mutually exclusive with |
|
|
| client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server.
It is mutually exclusive with |
|
|
| 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 defines the path to the TLS private key file in the container for the web server.
If defined, either
It is mutually exclusive with |
|
|
| keySecret defines the secret containing the TLS private key for the web server.
Either
It is mutually exclusive with |
|
|
| maxVersion defines the Maximum TLS version that is acceptable. |
|
|
| minVersion defines the minimum TLS version that is acceptable. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
cert defines the Secret or ConfigMap containing the TLS certificate for the web server.
Either
keySecretorkeyFilemust be defined.It is mutually exclusive with
certFile.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
12.1.398. .spec.web.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.399. .spec.web.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.400. .spec.web.tlsConfig.client_ca Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
12.1.401. .spec.web.tlsConfig.client_ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
12.1.402. .spec.web.tlsConfig.client_ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.403. .spec.web.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
keySecret defines the secret containing the TLS private key for the web server.
Either
certorcertFilemust be defined.It is mutually exclusive with
keyFile.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
12.1.404. .status Copy linkLink copied to clipboard!
- 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
| Property | Type | Description |
|---|---|---|
|
|
| availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this ThanosRuler deployment. |
|
|
| conditions defines the current state of the ThanosRuler object. |
|
|
| Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource. |
|
|
| paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. |
|
|
| replicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment (their labels match the selector). |
|
|
| unavailableReplicas defines the total number of unavailable pods targeted by this ThanosRuler deployment. |
|
|
| 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 Copy linkLink copied to clipboard!
- Description
- conditions defines the current state of the ThanosRuler object.
- Type
-
array
12.1.406. .status.conditions[] Copy linkLink copied to clipboard!
- Description
- Condition represents the state of the resources associated with the Prometheus, Alertmanager or ThanosRuler resource.
- Type
-
object - Required
-
lastTransitionTime -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastTransitionTime is the time of the last update to the current status property. |
|
|
| message defines human-readable message indicating details for the condition’s last transition. |
|
|
|
observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if |
|
|
| reason for the condition’s last transition. |
|
|
| status of the condition. |
|
|
| type of the condition being reported. |
12.2. API endpoints Copy linkLink copied to clipboard!
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
-
12.2.1. /apis/monitoring.coreos.com/v1/thanosrulers Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind ThanosRuler
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
12.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of ThanosRuler
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind ThanosRuler
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a ThanosRuler
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
12.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ThanosRuler |
- HTTP method
-
DELETE - Description
- delete a ThanosRuler
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified ThanosRuler
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified ThanosRuler
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified ThanosRuler
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
12.2.4. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ThanosRuler |
- HTTP method
-
GET - Description
- read status of the specified ThanosRuler
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified ThanosRuler
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified ThanosRuler
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 13. NodeMetrics [metrics.k8s.io/v1beta1] Copy linkLink copied to clipboard!
- Description
- NodeMetrics sets resource usage metrics of a node.
- Type
-
object - Required
-
timestamp -
window -
usage
-
13.1. Specification Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp]. | |
|
| The memory usage is the memory working set. | |
|
|
13.2. API endpoints Copy linkLink copied to clipboard!
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 Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind NodeMetrics
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
13.2.2. /apis/metrics.k8s.io/v1beta1/nodes/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the NodeMetrics |
- HTTP method
-
GET - Description
- read the specified NodeMetrics
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
Chapter 14. PodMetrics [metrics.k8s.io/v1beta1] Copy linkLink copied to clipboard!
- Description
- PodMetrics sets resource usage metrics of a pod.
- Type
-
object - Required
-
timestamp -
window -
containers
-
14.1. Specification Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Metrics for all containers are collected within the same time window. |
|
|
| ContainerMetrics sets resource usage metrics of a container. |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp]. | |
|
|
14.1.1. .containers Copy linkLink copied to clipboard!
- Description
- Metrics for all containers are collected within the same time window.
- Type
-
array
14.1.2. .containers[] Copy linkLink copied to clipboard!
- Description
- ContainerMetrics sets resource usage metrics of a container.
- Type
-
object - Required
-
name -
usage
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name corresponding to the one from pod.spec.containers. |
|
| The memory usage is the memory working set. |
14.2. API endpoints Copy linkLink copied to clipboard!
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 Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind PodMetrics
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
14.2.2. /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind PodMetrics
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
14.2.3. /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the PodMetrics |
- HTTP method
-
GET - Description
- read the specified PodMetrics
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
Legal Notice
Copy linkLink copied to clipboard!
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.