api.md

title	description	lead	date	draft	images	menu	weight	toc
API	Generated API docs for the Prometheus Operator		2021-03-08 08:49:31 +0000	false		docs parent operator	1000	true

This Document documents the types introduced by the Prometheus Operator to be consumed by users.

Note this document is generated from code comments. When contributing a change to this document please do so by changing the code comments.

Table of Contents

• APIServerConfig
• AlertingSpec
• Alertmanager
• AlertmanagerEndpoints
• AlertmanagerList
• AlertmanagerSpec
• AlertmanagerStatus
• ArbitraryFSAccessThroughSMsConfig
• Authorization
• BasicAuth
• EmbeddedObjectMetadata
• EmbeddedPersistentVolumeClaim
• Endpoint
• MetadataConfig
• NamespaceSelector
• OAuth2
• PodMetricsEndpoint
• PodMetricsEndpointTLSConfig
• PodMonitor
• PodMonitorList
• PodMonitorSpec
• Probe
• ProbeList
• ProbeSpec
• ProbeTLSConfig
• ProbeTargetIngress
• ProbeTargetStaticConfig
• ProbeTargets
• ProberSpec
• Prometheus
• PrometheusList
• PrometheusRule
• PrometheusRuleExcludeConfig
• PrometheusRuleList
• PrometheusRuleSpec
• PrometheusSpec
• PrometheusStatus
• QuerySpec
• QueueConfig
• RelabelConfig
• RemoteReadSpec
• RemoteWriteSpec
• Rule
• RuleGroup
• Rules
• RulesAlert
• SafeAuthorization
• SafeTLSConfig
• SecretOrConfigMap
• ServiceMonitor
• ServiceMonitorList
• ServiceMonitorSpec
• StorageSpec
• TLSConfig
• ThanosSpec
• WebSpec
• WebTLSConfig
• ThanosRuler
• ThanosRulerList
• ThanosRulerSpec
• ThanosRulerStatus
• AlertmanagerConfig
• AlertmanagerConfigList
• AlertmanagerConfigSpec
• EmailConfig
• HTTPConfig
• InhibitRule
• KeyValue
• Matcher
• OpsGenieConfig
• OpsGenieConfigResponder
• PagerDutyConfig
• PushoverConfig
• Receiver
• Route
• SlackAction
• SlackConfig
• SlackConfirmationField
• SlackField
• VictorOpsConfig
• WeChatConfig
• WebhookConfig

APIServerConfig

APIServerConfig defines a host and auth methods to access apiserver. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kubernetes_sd_config

appears in: PrometheusSpec

Field	Description	Scheme	Required
host	Host of apiserver. A valid string consisting of a hostname or IP followed by an optional port number	string	true
basicAuth	BasicAuth allow an endpoint to authenticate over basic authentication	*BasicAuth	false
bearerToken	Bearer token for accessing apiserver.	string	false
bearerTokenFile	File to read bearer token for accessing apiserver.	string	false
tlsConfig	TLS Config to use for accessing apiserver.	*TLSConfig	false
authorization	Authorization section for accessing apiserver	*Authorization	false

Back to TOC

AlertingSpec

AlertingSpec defines parameters for alerting configuration of Prometheus servers.

appears in: PrometheusSpec

Field	Description	Scheme	Required
alertmanagers	AlertmanagerEndpoints Prometheus should fire alerts against.	[]AlertmanagerEndpoints	true

Back to TOC

Alertmanager

Alertmanager describes an Alertmanager cluster.

appears in: AlertmanagerList

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec	Specification of the desired behavior of the Alertmanager cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status	AlertmanagerSpec	true
status	Most recent observed status of the Alertmanager cluster. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status	*AlertmanagerStatus	false

Back to TOC

AlertmanagerEndpoints

AlertmanagerEndpoints defines a selection of a single Endpoints object containing alertmanager IPs to fire alerts against.

appears in: AlertingSpec

Field	Description	Scheme	Required
namespace	Namespace of Endpoints object.	string	true
name	Name of Endpoints object in Namespace.	string	true
port	Port the Alertmanager API is exposed on.	intstr.IntOrString	true
scheme	Scheme to use when firing alerts.	string	false
pathPrefix	Prefix for the HTTP path alerts are pushed to.	string	false
tlsConfig	TLS Config to use for alertmanager connection.	*TLSConfig	false
bearerTokenFile	BearerTokenFile to read from filesystem to use when authenticating to Alertmanager.	string	false
authorization	Authorization section for this alertmanager endpoint	*SafeAuthorization	false
apiVersion	Version of the Alertmanager API that Prometheus uses to send alerts. It can be "v1" or "v2".	string	false
timeout	Timeout is a per-target Alertmanager timeout when pushing alerts.	*string	false

Back to TOC

AlertmanagerList

AlertmanagerList is a list of Alertmanagers.

Field	Description	Scheme	Required
metadata	Standard list metadata More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata	metav1.ListMeta	false
items	List of Alertmanagers	[]Alertmanager	true

Back to TOC

AlertmanagerSpec

AlertmanagerSpec is a 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

appears in: Alertmanager

Field	Description	Scheme	Required
podMetadata	PodMetadata configures Labels and Annotations which are propagated to the alertmanager pods.	*EmbeddedObjectMetadata	false
image	Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Alertmanager is being configured.	*string	false
version	Version the cluster should be on.	string	false
tag	Tag of Alertmanager container image to be deployed. Defaults to the value of version. Version is ignored if Tag is set. Deprecated: use 'image' instead. The image tag can be specified as part of the image URL.	string	false
sha	SHA of Alertmanager container image to be deployed. Defaults to the value of version. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use 'image' instead. The image digest can be specified as part of the image URL.	string	false
baseImage	Base image that is used to deploy pods, without tag. Deprecated: use 'image' instead	string	false
imagePullSecrets	An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod	[]v1.LocalObjectReference	false
secrets	Secrets is a list of Secrets in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. The Secrets are mounted into /etc/alertmanager/secrets/.	[]string	false
configMaps	ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. The ConfigMaps are mounted into /etc/alertmanager/configmaps/.	[]string	false
configSecret	ConfigSecret is the name of a Kubernetes Secret in the same namespace as the Alertmanager object, which contains configuration for this Alertmanager instance. Defaults to 'alertmanager-' The secret is mounted into /etc/alertmanager/config.	string	false
logLevel	Log level for Alertmanager to be configured with.	string	false
logFormat	Log format for Alertmanager to be configured with.	string	false
replicas	Size is the expected size of the alertmanager cluster. The controller will eventually make the size of the running cluster equal to the expected size.	*int32	false
retention	Time duration Alertmanager shall retain data for. Default is '120h', and must match the regular expression [0-9]+(ms|s|m|h) (milliseconds seconds minutes hours).	string	false
storage	Storage is the definition of how storage will be used by the Alertmanager instances.	*StorageSpec	false
volumes	Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.	[]v1.Volume	false
volumeMounts	VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the alertmanager container, that are generated as a result of StorageSpec objects.	[]v1.VolumeMount	false
externalUrl	The external URL the Alertmanager instances will be available under. This is necessary to generate correct URLs. This is necessary if Alertmanager is not served from root of a DNS name.	string	false
routePrefix	The route prefix Alertmanager registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with kubectl proxy.	string	false
paused	If set to true all actions on the underlying managed objects are not goint to be performed, except for delete actions.	bool	false
nodeSelector	Define which Nodes the Pods are scheduled on.	map[string]string	false
resources	Define resources requests and limits for single Pods.	v1.ResourceRequirements	false
affinity	If specified, the pod's scheduling constraints.	*v1.Affinity	false
tolerations	If specified, the pod's tolerations.	[]v1.Toleration	false
topologySpreadConstraints	If specified, the pod's topology spread constraints.	[]v1.TopologySpreadConstraint	false
securityContext	SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.	*v1.PodSecurityContext	false
serviceAccountName	ServiceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.	string	false
listenLocal	ListenLocal makes the Alertmanager server listen on loopback, so that it does not bind against the Pod IP. Note this is only for the Alertmanager UI, not the gossip communication.	bool	false
containers	Containers allows injecting additional containers. This is meant to allow adding an authentication proxy to an Alertmanager pod. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch. The current container names are: alertmanager and config-reloader. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.	[]v1.Container	false
initContainers	InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Alertmanager configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ 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.	[]v1.Container	false
priorityClassName	Priority class assigned to the Pods	string	false
additionalPeers	AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster.	[]string	false
clusterAdvertiseAddress	ClusterAdvertiseAddress is the explicit address to advertise in cluster. Needs to be provided for non RFC1918 [1] (public) addresses. [1] RFC1918: https://tools.ietf.org/html/rfc1918	string	false
clusterGossipInterval	Interval between gossip attempts.	string	false
clusterPushpullInterval	Interval between pushpull attempts.	string	false
clusterPeerTimeout	Timeout for cluster peering.	string	false
portName	Port name used for the pods and governing service. This defaults to web	string	false
forceEnableClusterMode	ForceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica. Use case is e.g. spanning an Alertmanager cluster across Kubernetes clusters with a single replica in each.	bool	false
alertmanagerConfigSelector	AlertmanagerConfigs to be selected for to merge and configure Alertmanager with.	*metav1.LabelSelector	false
alertmanagerConfigNamespaceSelector	Namespaces to be selected for AlertmanagerConfig discovery. If nil, only check own namespace.	*metav1.LabelSelector	false
minReadySeconds	Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.	*uint32	false

Back to TOC

AlertmanagerStatus

AlertmanagerStatus is the most recent observed status of the Alertmanager cluster. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

appears in: Alertmanager

Field	Description	Scheme	Required
paused	Represents whether any actions on the underlying managed objects are being performed. Only delete actions will be performed.	bool	true
replicas	Total number of non-terminated pods targeted by this Alertmanager cluster (their labels match the selector).	int32	true
updatedReplicas	Total number of non-terminated pods targeted by this Alertmanager cluster that have the desired version spec.	int32	true
availableReplicas	Total number of available pods (ready for at least minReadySeconds) targeted by this Alertmanager cluster.	int32	true
unavailableReplicas	Total number of unavailable pods targeted by this Alertmanager cluster.	int32	true

Back to TOC

ArbitraryFSAccessThroughSMsConfig

ArbitraryFSAccessThroughSMsConfig enables users to configure, whether a service monitor selected by the Prometheus instance is allowed to use arbitrary files on the file system of the Prometheus container. This is the case when e.g. a service monitor specifies a BearerTokenFile in an endpoint. A malicious user could create a service monitor selecting arbitrary secret files in the Prometheus container. Those secrets would then be sent with a scrape request by Prometheus to a malicious target. Denying the above would prevent the attack, users can instead use the BearerTokenSecret field.

appears in: PrometheusSpec

Field	Description	Scheme	Required
deny		bool	false

Back to TOC

Authorization

Authorization contains optional Authorization header configuration. This section is only understood by versions of Prometheus >= 2.26.0.

appears in: APIServerConfig, RemoteReadSpec, RemoteWriteSpec

Field	Description	Scheme	Required
type	Set the authentication type. Defaults to Bearer, Basic will cause an error	string	false
credentials	The secret's key that contains the credentials of the request	*v1.SecretKeySelector	false
credentialsFile	File to read a secret from, mutually exclusive with Credentials (from SafeAuthorization)	string	false

Back to TOC

BasicAuth

BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints

appears in: APIServerConfig, Endpoint, PodMetricsEndpoint, ProbeSpec, RemoteReadSpec, RemoteWriteSpec

Field	Description	Scheme	Required
username	The secret in the service monitor namespace that contains the username for authentication.	v1.SecretKeySelector	false
password	The secret in the service monitor namespace that contains the password for authentication.	v1.SecretKeySelector	false

Back to TOC

EmbeddedObjectMetadata

EmbeddedObjectMetadata contains a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta Only fields which are relevant to embedded resources are included.

appears in: AlertmanagerSpec, EmbeddedPersistentVolumeClaim, PrometheusSpec, ThanosRulerSpec

Field	Description	Scheme	Required
name	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names	string	false
labels	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels	map[string]string	false
annotations	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations	map[string]string	false

Back to TOC

EmbeddedPersistentVolumeClaim

EmbeddedPersistentVolumeClaim is an embedded version of k8s.io/api/core/v1.PersistentVolumeClaim. It contains TypeMeta and a reduced ObjectMeta.

appears in: StorageSpec

Field	Description	Scheme	Required
metadata	EmbeddedMetadata contains metadata relevant to an EmbeddedResource.	EmbeddedObjectMetadata	false
spec	Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	v1.PersistentVolumeClaimSpec	false
status	Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	v1.PersistentVolumeClaimStatus	false

Back to TOC

Endpoint

Endpoint defines a scrapeable endpoint serving Prometheus metrics.

appears in: ServiceMonitorSpec

Field	Description	Scheme	Required
port	Name of the service port this endpoint refers to. Mutually exclusive with targetPort.	string	false
targetPort	Name or number of the target port of the Pod behind the Service, the port must be specified with container port property. Mutually exclusive with port.	*intstr.IntOrString	false
path	HTTP path to scrape for metrics.	string	false
scheme	HTTP scheme to use for scraping.	string	false
params	Optional HTTP URL parameters	map[string][]string	false
interval	Interval at which metrics should be scraped	string	false
scrapeTimeout	Timeout after which the scrape is ended	string	false
tlsConfig	TLS configuration to use when scraping the endpoint	*TLSConfig	false
bearerTokenFile	File to read bearer token for scraping targets.	string	false
bearerTokenSecret	Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator.	v1.SecretKeySelector	false
authorization	Authorization section for this endpoint	*SafeAuthorization	false
honorLabels	HonorLabels chooses the metric's labels on collisions with target labels.	bool	false
honorTimestamps	HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.	*bool	false
basicAuth	BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints	*BasicAuth	false
oauth2	OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.	*OAuth2	false
metricRelabelings	MetricRelabelConfigs to apply to samples before ingestion.	[]*RelabelConfig	false
relabelings	RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config	[]*RelabelConfig	false
proxyUrl	ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.	*string	false

Back to TOC

MetadataConfig

Configures the sending of series metadata to remote storage.

appears in: RemoteWriteSpec

Field	Description	Scheme	Required
send	Whether metric metadata is sent to remote storage or not.	bool	false
sendInterval	How frequently metric metadata is sent to remote storage.	string	false

Back to TOC

NamespaceSelector

NamespaceSelector is a selector for selecting either all namespaces or a list of namespaces.

appears in: PodMonitorSpec, ProbeTargetIngress, ServiceMonitorSpec

Field	Description	Scheme	Required
any	Boolean describing whether all namespaces are selected in contrast to a list restricting them.	bool	false
matchNames	List of namespace names.	[]string	false

Back to TOC

OAuth2

OAuth2 allows an endpoint to authenticate with OAuth2. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#oauth2

appears in: Endpoint, PodMetricsEndpoint, ProbeSpec, RemoteReadSpec, RemoteWriteSpec

Field	Description	Scheme	Required
clientId	The secret or configmap containing the OAuth2 client id	SecretOrConfigMap	true
clientSecret	The secret containing the OAuth2 client secret	v1.SecretKeySelector	true
tokenUrl	The URL to fetch the token from	string	true
scopes	OAuth2 scopes used for the token request	[]string	false
endpointParams	Parameters to append to the token URL	map[string]string	false

Back to TOC

PodMetricsEndpoint

PodMetricsEndpoint defines a scrapeable endpoint of a Kubernetes Pod serving Prometheus metrics.

appears in: PodMonitorSpec

Field	Description	Scheme	Required
port	Name of the pod port this endpoint refers to. Mutually exclusive with targetPort.	string	false
targetPort	Deprecated: Use 'port' instead.	*intstr.IntOrString	false
path	HTTP path to scrape for metrics.	string	false
scheme	HTTP scheme to use for scraping.	string	false
params	Optional HTTP URL parameters	map[string][]string	false
interval	Interval at which metrics should be scraped	string	false
scrapeTimeout	Timeout after which the scrape is ended	string	false
tlsConfig	TLS configuration to use when scraping the endpoint.	*PodMetricsEndpointTLSConfig	false
bearerTokenSecret	Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the pod monitor and accessible by the Prometheus Operator.	v1.SecretKeySelector	false
honorLabels	HonorLabels chooses the metric's labels on collisions with target labels.	bool	false
honorTimestamps	HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.	*bool	false
basicAuth	BasicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint	*BasicAuth	false
oauth2	OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.	*OAuth2	false
authorization	Authorization section for this endpoint	*SafeAuthorization	false
metricRelabelings	MetricRelabelConfigs to apply to samples before ingestion.	[]*RelabelConfig	false
relabelings	RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config	[]*RelabelConfig	false
proxyUrl	ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.	*string	false

Back to TOC

PodMetricsEndpointTLSConfig

PodMetricsEndpointTLSConfig specifies TLS configuration parameters.

appears in: PodMetricsEndpoint

Field	Description	Scheme	Required
ca	Struct containing the CA cert to use for the targets.	SecretOrConfigMap	false
cert	Struct containing the client cert file for the targets.	SecretOrConfigMap	false
keySecret	Secret containing the client key file for the targets.	*v1.SecretKeySelector	false
serverName	Used to verify the hostname for the targets.	string	false
insecureSkipVerify	Disable target certificate validation.	bool	false

Back to TOC

PodMonitor

PodMonitor defines monitoring for a set of pods.

appears in: PodMonitorList

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec	Specification of desired Pod selection for target discovery by Prometheus.	PodMonitorSpec	true

Back to TOC

PodMonitorList

PodMonitorList is a list of PodMonitors.

Field	Description	Scheme	Required
metadata	Standard list metadata More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata	metav1.ListMeta	false
items	List of PodMonitors	[]*PodMonitor	true

Back to TOC

PodMonitorSpec

PodMonitorSpec contains specification parameters for a PodMonitor.

appears in: PodMonitor

Field	Description	Scheme	Required
jobLabel	The label to use to retrieve the job name from.	string	false
podTargetLabels	PodTargetLabels transfers labels on the Kubernetes Pod onto the target.	[]string	false
podMetricsEndpoints	A list of endpoints allowed as part of this PodMonitor.	[]PodMetricsEndpoint	true
selector	Selector to select Pod objects.	metav1.LabelSelector	true
namespaceSelector	Selector to select which namespaces the Endpoints objects are discovered from.	NamespaceSelector	false
sampleLimit	SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.	uint64	false
targetLimit	TargetLimit defines a limit on the number of scraped targets that will be accepted.	uint64	false
labelLimit	Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.	uint64	false
labelNameLengthLimit	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.	uint64	false
labelValueLengthLimit	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.	uint64	false

Back to TOC

Probe

Probe defines monitoring for a set of static targets or ingresses.

appears in: ProbeList

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec	Specification of desired Ingress selection for target discovery by Prometheus.	ProbeSpec	true

Back to TOC

ProbeList

ProbeList is a list of Probes.

Field	Description	Scheme	Required
metadata	Standard list metadata More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata	metav1.ListMeta	false
items	List of Probes	[]*Probe	true

Back to TOC

ProbeSpec

ProbeSpec contains specification parameters for a Probe.

appears in: Probe

Field	Description	Scheme	Required
jobName	The job name assigned to scraped metrics by default.	string	false
prober	Specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.	ProberSpec	false
module	The 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	string	false
targets	Targets defines a set of static and/or dynamically discovered targets to be probed using the prober.	ProbeTargets	false
interval	Interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used.	string	false
scrapeTimeout	Timeout for scraping metrics from the Prometheus exporter.	string	false
tlsConfig	TLS configuration to use when scraping the endpoint.	*ProbeTLSConfig	false
bearerTokenSecret	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.	v1.SecretKeySelector	false
basicAuth	BasicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint	*BasicAuth	false
oauth2	OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.	*OAuth2	false
metricRelabelings	MetricRelabelConfigs to apply to samples before ingestion.	[]*RelabelConfig	false
authorization	Authorization section for this endpoint	*SafeAuthorization	false
sampleLimit	SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.	uint64	false
targetLimit	TargetLimit defines a limit on the number of scraped targets that will be accepted.	uint64	false
labelLimit	Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.	uint64	false
labelNameLengthLimit	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.	uint64	false
labelValueLengthLimit	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.	uint64	false

Back to TOC

ProbeTLSConfig

ProbeTLSConfig specifies TLS configuration parameters.

appears in: ProbeSpec

Field	Description	Scheme	Required
ca	Struct containing the CA cert to use for the targets.	SecretOrConfigMap	false
cert	Struct containing the client cert file for the targets.	SecretOrConfigMap	false
keySecret	Secret containing the client key file for the targets.	*v1.SecretKeySelector	false
serverName	Used to verify the hostname for the targets.	string	false
insecureSkipVerify	Disable target certificate validation.	bool	false

Back to TOC

ProbeTargetIngress

ProbeTargetIngress defines the set of Ingress objects considered for probing.

appears in: ProbeTargets

Field	Description	Scheme	Required
selector	Select Ingress objects by labels.	metav1.LabelSelector	false
namespaceSelector	Select Ingress objects by namespace.	NamespaceSelector	false
relabelingConfigs	RelabelConfigs to apply to samples before ingestion. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config	[]*RelabelConfig	false

Back to TOC

ProbeTargetStaticConfig

ProbeTargetStaticConfig defines the set of static targets considered for probing.

appears in: ProbeTargets

Field	Description	Scheme	Required
static	Targets is a list of URLs to probe using the configured prober.	[]string	false
labels	Labels assigned to all metrics scraped from the targets.	map[string]string	false
relabelingConfigs	RelabelConfigs to apply to samples before ingestion. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config	[]*RelabelConfig	false

Back to TOC

ProbeTargets

ProbeTargets defines a set of static and dynamically discovered targets for the prober.

appears in: ProbeSpec

Field	Description	Scheme	Required
staticConfig	StaticConfig defines static targets which are considers for probing. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config.	*ProbeTargetStaticConfig	false
ingress	Ingress defines the set of dynamically discovered ingress objects which hosts are considered for probing.	*ProbeTargetIngress	false

Back to TOC

ProberSpec

ProberSpec contains specification parameters for the Prober used for probing.

appears in: ProbeSpec

Field	Description	Scheme	Required
url	Mandatory URL of the prober.	string	true
scheme	HTTP scheme to use for scraping. Defaults to http.	string	false
path	Path to collect metrics from. Defaults to /probe.	string	false
proxyUrl	Optional ProxyURL.	string	false

Back to TOC

Prometheus

Prometheus defines a Prometheus deployment.

appears in: PrometheusList

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec	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	PrometheusSpec	true
status	Most recent observed status of the Prometheus cluster. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status	*PrometheusStatus	false

Back to TOC

PrometheusList

PrometheusList is a list of Prometheuses.

Field	Description	Scheme	Required
metadata	Standard list metadata More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata	metav1.ListMeta	false
items	List of Prometheuses	[]*Prometheus	true

Back to TOC

PrometheusRule

PrometheusRule defines recording and alerting rules for a Prometheus instance

appears in: PrometheusRuleList

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec	Specification of desired alerting rule definitions for Prometheus.	PrometheusRuleSpec	true

Back to TOC

PrometheusRuleExcludeConfig

PrometheusRuleExcludeConfig enables users to configure excluded PrometheusRule names and their namespaces to be ignored while enforcing namespace label for alerts and metrics.

appears in: PrometheusSpec, ThanosRulerSpec

Field	Description	Scheme	Required
ruleNamespace	RuleNamespace - namespace of excluded rule	string	true
ruleName	RuleNamespace - name of excluded rule	string	true

Back to TOC

PrometheusRuleList

PrometheusRuleList is a list of PrometheusRules.

Field	Description	Scheme	Required
metadata	Standard list metadata More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata	metav1.ListMeta	false
items	List of Rules	[]*PrometheusRule	true

Back to TOC

PrometheusRuleSpec

PrometheusRuleSpec contains specification parameters for a Rule.

appears in: PrometheusRule

Field	Description	Scheme	Required
groups	Content of Prometheus rule file	[]RuleGroup	false

Back to TOC

PrometheusSpec

PrometheusSpec is a 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

appears in: Prometheus

Field	Description	Scheme	Required
podMetadata	PodMetadata configures Labels and Annotations which are propagated to the prometheus pods.	*EmbeddedObjectMetadata	false
serviceMonitorSelector	ServiceMonitors to be selected for target discovery. Deprecated: if neither this nor podMonitorSelector are specified, configuration is unmanaged.	*metav1.LabelSelector	false
serviceMonitorNamespaceSelector	Namespace's labels to match for ServiceMonitor discovery. If nil, only check own namespace.	*metav1.LabelSelector	false
podMonitorSelector	Experimental PodMonitors to be selected for target discovery. Deprecated: if neither this nor serviceMonitorSelector are specified, configuration is unmanaged.	*metav1.LabelSelector	false
podMonitorNamespaceSelector	Namespace's labels to match for PodMonitor discovery. If nil, only check own namespace.	*metav1.LabelSelector	false
probeSelector	Experimental Probes to be selected for target discovery.	*metav1.LabelSelector	false
probeNamespaceSelector	Experimental Namespaces to be selected for Probe discovery. If nil, only check own namespace.	*metav1.LabelSelector	false
version	Version of Prometheus to be deployed.	string	false
tag	Tag of Prometheus container image to be deployed. Defaults to the value of version. Version is ignored if Tag is set. Deprecated: use 'image' instead. The image tag can be specified as part of the image URL.	string	false
sha	SHA of Prometheus container image to be deployed. Defaults to the value of version. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use 'image' instead. The image digest can be specified as part of the image URL.	string	false
paused	When a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects.	bool	false
image	Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Prometheus is being configured.	*string	false
baseImage	Base image to use for a Prometheus deployment. Deprecated: use 'image' instead	string	false
imagePullSecrets	An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod	[]v1.LocalObjectReference	false
replicas	Number of replicas of each shard to deploy for a Prometheus deployment. Number of replicas multiplied by shards is the total number of Pods created.	*int32	false
shards	EXPERIMENTAL: Number of shards to distribute targets onto. Number of replicas multiplied by shards is the total number of Pods created. Note that scaling down shards will not reshard data onto 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 Thanos sidecar and Thanos querier or remote write data to a central location. Sharding is done on the content of the __address__ target meta-label.	*int32	false
replicaExternalLabelName	Name of Prometheus external label used to denote replica name. Defaults to the value of prometheus_replica. External label will not be added when value is set to empty string (\"\").	*string	false
prometheusExternalLabelName	Name of Prometheus external label used to denote Prometheus instance name. Defaults to the value of prometheus. External label will not be added when value is set to empty string (\"\").	*string	false
retention	Time duration Prometheus shall retain data for. Default is '24h', and must match the regular expression [0-9]+(ms|s|m|h|d|w|y) (milliseconds seconds minutes hours days weeks years).	string	false
retentionSize	Maximum amount of disk space used by blocks. Supported units: B, KB, MB, GB, TB, PB, EB. Ex: 512MB.	string	false
disableCompaction	Disable prometheus compaction.	bool	false
walCompression	Enable compression of the write-ahead log using Snappy. This flag is only available in versions of Prometheus >= 2.11.0.	*bool	false
logLevel	Log level for Prometheus to be configured with.	string	false
logFormat	Log format for Prometheus to be configured with.	string	false
scrapeInterval	Interval between consecutive scrapes. Default: 1m	string	false
scrapeTimeout	Number of seconds to wait for target to respond before erroring.	string	false
evaluationInterval	Interval between consecutive evaluations. Default: 1m	string	false
rules	/--rules.*/ command-line arguments.	Rules	false
externalLabels	The labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager).	map[string]string	false
enableAdminAPI	Enable access to prometheus web admin API. Defaults to the value of false. 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 see https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis	bool	false
enableFeatures	Enable access to Prometheus disabled features. By default, no features are enabled. Enabling disabled features 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/disabled_features/	[]string	false
externalUrl	The external URL the Prometheus instances will be available under. This is necessary to generate correct URLs. This is necessary if Prometheus is not served from root of a DNS name.	string	false
routePrefix	The route prefix Prometheus registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with kubectl proxy.	string	false
query	QuerySpec defines the query command line flags when starting Prometheus.	*QuerySpec	false
storage	Storage spec to specify how storage shall be used.	*StorageSpec	false
volumes	Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.	[]v1.Volume	false
volumeMounts	VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the prometheus container, that are generated as a result of StorageSpec objects.	[]v1.VolumeMount	false
web	WebSpec defines the web command line flags when starting Prometheus.	*WebSpec	false
ruleSelector	A selector to select which PrometheusRules to mount for loading alerting/recording rules from. Until (excluding) Prometheus Operator v0.24.0 Prometheus Operator will migrate any legacy rule ConfigMaps to PrometheusRule custom resources selected by RuleSelector. Make sure it does not match any config maps that you do not want to be migrated.	*metav1.LabelSelector	false
ruleNamespaceSelector	Namespaces to be selected for PrometheusRules discovery. If unspecified, only the same namespace as the Prometheus object is in is used.	*metav1.LabelSelector	false
alerting	Define details regarding alerting.	*AlertingSpec	false
resources	Define resources requests and limits for single Pods.	v1.ResourceRequirements	false
nodeSelector	Define which Nodes the Pods are scheduled on.	map[string]string	false
serviceAccountName	ServiceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.	string	false
secrets	Secrets is a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. The Secrets are mounted into /etc/prometheus/secrets/.	[]string	false
configMaps	ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. The ConfigMaps are mounted into /etc/prometheus/configmaps/.	[]string	false
affinity	If specified, the pod's scheduling constraints.	*v1.Affinity	false
tolerations	If specified, the pod's tolerations.	[]v1.Toleration	false
topologySpreadConstraints	If specified, the pod's topology spread constraints.	[]v1.TopologySpreadConstraint	false
remoteWrite	If specified, the remote_write spec. This is an experimental feature, it may change in any upcoming release in a breaking way.	[]RemoteWriteSpec	false
remoteRead	If specified, the remote_read spec. This is an experimental feature, it may change in any upcoming release in a breaking way.	[]RemoteReadSpec	false
securityContext	SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.	*v1.PodSecurityContext	false
listenLocal	ListenLocal makes the Prometheus server listen on loopback, so that it does not bind against the Pod IP.	bool	false
containers	Containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a Prometheus 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: prometheus, config-reloader, and thanos-sidecar. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.	[]v1.Container	false
initContainers	InitContainers allows adding 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 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.	[]v1.Container	false
additionalScrapeConfigs	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.	*v1.SecretKeySelector	false
additionalAlertRelabelConfigs	AdditionalAlertRelabelConfigs allows specifying a key of a Secret containing additional Prometheus alert relabel configurations. Alert relabel configurations specified are appended to the configurations generated by the Prometheus Operator. Alert relabel configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs. As alert relabel 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 alert relabel configs are going to break Prometheus after the upgrade.	*v1.SecretKeySelector	false
additionalAlertManagerConfigs	AdditionalAlertManagerConfigs allows specifying a key of a Secret containing additional Prometheus AlertManager configurations. AlertManager 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/#alertmanager_config. As AlertManager 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 AlertManager configs are going to break Prometheus after the upgrade.	*v1.SecretKeySelector	false
apiserverConfig	APIServerConfig allows specifying a host and auth methods to access apiserver. If left empty, Prometheus is assumed to run inside of the cluster and will discover API servers automatically and use the pod's CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.	*APIServerConfig	false
thanos	Thanos configuration allows configuring various aspects of a Prometheus server in a Thanos environment.\n\nThis section is experimental, it may change significantly without deprecation notice in any release.\n\nThis is experimental and may change significantly without backward compatibility in any release.	*ThanosSpec	false
priorityClassName	Priority class assigned to the Pods	string	false
portName	Port name used for the pods and governing service. This defaults to web	string	false
arbitraryFSAccessThroughSMs	ArbitraryFSAccessThroughSMs configures whether configuration based on a service monitor can access arbitrary files on the file system of the Prometheus container e.g. bearer token files.	ArbitraryFSAccessThroughSMsConfig	false
overrideHonorLabels	OverrideHonorLabels if set to true overrides all user configured honor_labels. If HonorLabels is set in ServiceMonitor or PodMonitor to true, this overrides honor_labels to false.	bool	false
overrideHonorTimestamps	OverrideHonorTimestamps allows to globally enforce honoring timestamps in all scrape configs.	bool	false
ignoreNamespaceSelectors	IgnoreNamespaceSelectors if set to true will ignore NamespaceSelector settings from the podmonitor and servicemonitor configs, and they will only discover endpoints within their current namespace. Defaults to false.	bool	false
enforcedNamespaceLabel	EnforcedNamespaceLabel If set, a label will be added to\n\n1. all user-metrics (created by ServiceMonitor, PodMonitor and ProbeConfig object) and 2. in all PrometheusRule objects (except the ones excluded in prometheusRulesExcludedFromEnforce) to\n * alerting & recording rules and\n * the metrics used in their expressions (expr).\n\nLabel name is this field's value. Label value is the namespace of the created object (mentioned above).	string	false
prometheusRulesExcludedFromEnforce	PrometheusRulesExcludedFromEnforce - 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	[]PrometheusRuleExcludeConfig	false
queryLogFile	QueryLogFile specifies the file to which PromQL queries are logged. Note that this location must be writable, and can be persisted using an attached volume. Alternatively, the location can be set to a stdout location such as /dev/stdout to log querie information to the default Prometheus log stream. This is only available in versions of Prometheus >= 2.16.0. For more details, see the Prometheus docs (https://prometheus.io/docs/guides/query-log/)	string	false
enforcedSampleLimit	EnforcedSampleLimit defines global limit on number of scraped samples that will be accepted. This overrides any SampleLimit set per ServiceMonitor or/and PodMonitor. It is meant to be used by admins to enforce the SampleLimit to keep overall number of samples/series under the desired limit. Note that if SampleLimit is lower that value will be taken instead.	*uint64	false
allowOverlappingBlocks	AllowOverlappingBlocks enables vertical compaction and vertical query merge in Prometheus. This is still experimental in Prometheus so it may change in any upcoming release.	bool	false
enforcedTargetLimit	EnforcedTargetLimit defines a global limit on the number of scraped targets. This overrides any TargetLimit set per ServiceMonitor or/and PodMonitor. It is meant to be used by admins to enforce the TargetLimit to keep the overall number of targets under the desired limit. Note that if TargetLimit is lower, that value will be taken instead, except if either value is zero, in which case the non-zero value will be used. If both values are zero, no limit is enforced.	*uint64	false
enforcedLabelLimit	Per-scrape limit on number of labels that will be accepted for a sample. If more than this number of labels are present post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer.	*uint64	false
enforcedLabelNameLengthLimit	Per-scrape limit on length of labels name that will be accepted for a sample. If a label name is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer.	*uint64	false
enforcedLabelValueLengthLimit	Per-scrape limit on length of labels value that will be accepted for a sample. If a label value is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer.	*uint64	false
minReadySeconds	Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.	*uint32	false

Back to TOC

PrometheusStatus

PrometheusStatus is the most recent observed status of the Prometheus cluster. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

appears in: Prometheus

Field	Description	Scheme	Required
paused	Represents whether any actions on the underlying managed objects are being performed. Only delete actions will be performed.	bool	true
replicas	Total number of non-terminated pods targeted by this Prometheus deployment (their labels match the selector).	int32	true
updatedReplicas	Total number of non-terminated pods targeted by this Prometheus deployment that have the desired version spec.	int32	true
availableReplicas	Total number of available pods (ready for at least minReadySeconds) targeted by this Prometheus deployment.	int32	true
unavailableReplicas	Total number of unavailable pods targeted by this Prometheus deployment.	int32	true

Back to TOC

QuerySpec

QuerySpec defines the query command line flags when starting Prometheus.

appears in: PrometheusSpec

Field	Description	Scheme	Required
lookbackDelta	The delta difference allowed for retrieving metrics during expression evaluations.	*string	false
maxConcurrency	Number of concurrent queries that can be run at once.	*int32	false
maxSamples	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.	*int32	false
timeout	Maximum time a query may take before being aborted.	*string	false

Back to TOC

QueueConfig

QueueConfig allows the tuning of remote_write queue_config parameters. This object is referenced in the RemoteWriteSpec object.

appears in: RemoteWriteSpec

Field	Description	Scheme	Required
capacity	Capacity is the number of samples to buffer per shard before we start dropping them.	int	false
minShards	MinShards is the minimum number of shards, i.e. amount of concurrency.	int	false
maxShards	MaxShards is the maximum number of shards, i.e. amount of concurrency.	int	false
maxSamplesPerSend	MaxSamplesPerSend is the maximum number of samples per send.	int	false
batchSendDeadline	BatchSendDeadline is the maximum time a sample will wait in buffer.	string	false
maxRetries	MaxRetries is the maximum number of times to retry a batch on recoverable errors.	int	false
minBackoff	MinBackoff is the initial retry delay. Gets doubled for every retry.	string	false
maxBackoff	MaxBackoff is the maximum retry delay.	string	false

Back to TOC

RelabelConfig

RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines <metric_relabel_configs>-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

appears in: Endpoint, PodMetricsEndpoint, ProbeSpec, ProbeTargetIngress, ProbeTargetStaticConfig, RemoteWriteSpec

Field	Description	Scheme	Required
sourceLabels	The source labels 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.	[]string	false
separator	Separator placed between concatenated source label values. default is ';'.	string	false
targetLabel	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.	string	false
regex	Regular expression against which the extracted value is matched. Default is '(.*)'	string	false
modulus	Modulus to take of the hash of the source label values.	uint64	false
replacement	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'	string	false
action	Action to perform based on regex matching. Default is 'replace'	string	false

Back to TOC

RemoteReadSpec

RemoteReadSpec defines the remote_read configuration for prometheus.

appears in: PrometheusSpec

Field	Description	Scheme	Required
url	The URL of the endpoint to send samples to.	string	true
name	The name of the remote read queue, must be unique if specified. The name is used in metrics and logging in order to differentiate read configurations. Only valid in Prometheus versions 2.15.0 and newer.	string	false
requiredMatchers	An optional list of equality matchers which have to be present in a selector to query the remote read endpoint.	map[string]string	false
remoteTimeout	Timeout for requests to the remote read endpoint.	string	false
readRecent	Whether reads should be made for queries for time ranges that the local storage should have complete data for.	bool	false
basicAuth	BasicAuth for the URL.	*BasicAuth	false
oauth2	OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.	*OAuth2	false
bearerToken	Bearer token for remote read.	string	false
bearerTokenFile	File to read bearer token for remote read.	string	false
authorization	Authorization section for remote read	*Authorization	false
tlsConfig	TLS Config to use for remote read.	*TLSConfig	false
proxyUrl	Optional ProxyURL	string	false

Back to TOC

RemoteWriteSpec

RemoteWriteSpec defines the remote_write configuration for prometheus.

appears in: PrometheusSpec

Field	Description	Scheme	Required
url	The URL of the endpoint to send samples to.	string	true
name	The name of the remote write queue, must be unique if specified. The name is used in metrics and logging in order to differentiate queues. Only valid in Prometheus versions 2.15.0 and newer.	string	false
sendExemplars	Enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the enableFeature option for exemplars to be scraped in the first place. Only valid in Prometheus versions 2.27.0 and newer.	*bool	false
remoteTimeout	Timeout for requests to the remote write endpoint.	string	false
headers	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. Only valid in Prometheus versions 2.25.0 and newer.	map[string]string	false
writeRelabelConfigs	The list of remote write relabel configurations.	[]RelabelConfig	false
oauth2	OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.	*OAuth2	false
basicAuth	BasicAuth for the URL.	*BasicAuth	false
bearerToken	Bearer token for remote write.	string	false
bearerTokenFile	File to read bearer token for remote write.	string	false
authorization	Authorization section for remote write	*Authorization	false
tlsConfig	TLS Config to use for remote write.	*TLSConfig	false
proxyUrl	Optional ProxyURL	string	false
queueConfig	QueueConfig allows tuning of the remote write queue parameters.	*QueueConfig	false
metadataConfig	MetadataConfig configures the sending of series metadata to remote storage.	*MetadataConfig	false

Back to TOC

Rule

Rule describes an alerting or recording rule See Prometheus documentation: alerting or recording rule

appears in: RuleGroup

Field	Description	Scheme	Required
record		string	false
alert		string	false
expr		intstr.IntOrString	true
for		string	false
labels		map[string]string	false
annotations		map[string]string	false

Back to TOC

RuleGroup

RuleGroup is a list of sequentially evaluated recording and alerting rules. Note: PartialResponseStrategy is only used by ThanosRuler and will be ignored by Prometheus instances. Valid values for this field are 'warn' or 'abort'. More info: https://github.com/thanos-io/thanos/blob/master/docs/components/rule.md#partial-response

appears in: PrometheusRuleSpec

Field	Description	Scheme	Required
name		string	true
interval		string	false
rules		[]Rule	true
partial_response_strategy		string	false

Back to TOC

Rules

/--rules.*/ command-line arguments

appears in: PrometheusSpec

Field	Description	Scheme	Required
alert		RulesAlert	false

Back to TOC

RulesAlert

/--rules.alert.*/ command-line arguments

appears in: Rules

Field	Description	Scheme	Required
forOutageTolerance	Max time to tolerate prometheus outage for restoring 'for' state of alert.	string	false
forGracePeriod	Minimum duration between alert and restored 'for' state. This is maintained only for alerts with configured 'for' time greater than grace period.	string	false
resendDelay	Minimum amount of time to wait before resending an alert to Alertmanager.	string	false

Back to TOC

SafeAuthorization

SafeAuthorization specifies a subset of the Authorization struct, that is safe for use in Endpoints (no CredentialsFile field)

appears in: AlertmanagerEndpoints, Authorization, Endpoint, PodMetricsEndpoint, ProbeSpec

Field	Description	Scheme	Required
type	Set the authentication type. Defaults to Bearer, Basic will cause an error	string	false
credentials	The secret's key that contains the credentials of the request	*v1.SecretKeySelector	false

Back to TOC

SafeTLSConfig

SafeTLSConfig specifies safe TLS configuration parameters.

appears in: PodMetricsEndpointTLSConfig, ProbeTLSConfig, TLSConfig

Field	Description	Scheme	Required
ca	Struct containing the CA cert to use for the targets.	SecretOrConfigMap	false
cert	Struct containing the client cert file for the targets.	SecretOrConfigMap	false
keySecret	Secret containing the client key file for the targets.	*v1.SecretKeySelector	false
serverName	Used to verify the hostname for the targets.	string	false
insecureSkipVerify	Disable target certificate validation.	bool	false

Back to TOC

SecretOrConfigMap

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

appears in: OAuth2, SafeTLSConfig, WebTLSConfig

Field	Description	Scheme	Required
secret	Secret containing data to use for the targets.	*v1.SecretKeySelector	false
configMap	ConfigMap containing data to use for the targets.	*v1.ConfigMapKeySelector	false

Back to TOC

ServiceMonitor

ServiceMonitor defines monitoring for a set of services.

appears in: ServiceMonitorList

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec	Specification of desired Service selection for target discovery by Prometheus.	ServiceMonitorSpec	true

Back to TOC

ServiceMonitorList

ServiceMonitorList is a list of ServiceMonitors.

Field	Description	Scheme	Required
metadata	Standard list metadata More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata	metav1.ListMeta	false
items	List of ServiceMonitors	[]*ServiceMonitor	true

Back to TOC

ServiceMonitorSpec

ServiceMonitorSpec contains specification parameters for a ServiceMonitor.

appears in: ServiceMonitor

Field	Description	Scheme	Required
jobLabel	Chooses the label of the Kubernetes Endpoints. Its value will be used for the job-label's value of the created metrics.\n\nDefault & fallback value: the name of the respective Kubernetes Endpoint.	string	false
targetLabels	TargetLabels transfers labels from the Kubernetes Service onto the created metrics. All labels set in selector.matchLabels are automatically transferred.	[]string	false
podTargetLabels	PodTargetLabels transfers labels on the Kubernetes Pod onto the created metrics.	[]string	false
endpoints	A list of endpoints allowed as part of this ServiceMonitor.	[]Endpoint	true
selector	Selector to select Endpoints objects.	metav1.LabelSelector	true
namespaceSelector	Selector to select which namespaces the Kubernetes Endpoints objects are discovered from.	NamespaceSelector	false
sampleLimit	SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.	uint64	false
targetLimit	TargetLimit defines a limit on the number of scraped targets that will be accepted.	uint64	false
labelLimit	Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.	uint64	false
labelNameLengthLimit	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.	uint64	false
labelValueLengthLimit	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.	uint64	false

Back to TOC

StorageSpec

StorageSpec defines the configured storage for a group Prometheus servers. If neither emptyDir nor volumeClaimTemplate is specified, then by default an EmptyDir will be used.

appears in: AlertmanagerSpec, PrometheusSpec, ThanosRulerSpec

Field	Description	Scheme	Required
disableMountSubPath	Deprecated: subPath usage will be disabled by default in a future release, this option will become unnecessary. DisableMountSubPath allows to remove any subPath usage in volume mounts.	bool	false
emptyDir	EmptyDirVolumeSource to be used by the Prometheus StatefulSets. If specified, used in place of any volumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir	*v1.EmptyDirVolumeSource	false
volumeClaimTemplate	A PVC spec to be used by the Prometheus StatefulSets.	EmbeddedPersistentVolumeClaim	false

Back to TOC

TLSConfig

TLSConfig extends the safe TLS configuration with file parameters.

appears in: APIServerConfig, AlertmanagerEndpoints, Endpoint, RemoteReadSpec, RemoteWriteSpec, ThanosSpec, ThanosRulerSpec

Field	Description	Scheme	Required
ca	Struct containing the CA cert to use for the targets.	SecretOrConfigMap	false
cert	Struct containing the client cert file for the targets.	SecretOrConfigMap	false
keySecret	Secret containing the client key file for the targets.	*v1.SecretKeySelector	false
serverName	Used to verify the hostname for the targets.	string	false
insecureSkipVerify	Disable target certificate validation.	bool	false
caFile	Path to the CA cert in the Prometheus container to use for the targets.	string	false
certFile	Path to the client cert file in the Prometheus container for the targets.	string	false
keyFile	Path to the client key file in the Prometheus container for the targets.	string	false

Back to TOC

ThanosSpec

ThanosSpec defines parameters for a Prometheus server within a Thanos deployment.

appears in: PrometheusSpec

Field	Description	Scheme	Required
image	Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Thanos is being configured.	*string	false
version	Version describes the version of Thanos to use.	*string	false
tag	Tag of Thanos sidecar container image to be deployed. Defaults to the value of version. Version is ignored if Tag is set. Deprecated: use 'image' instead. The image tag can be specified as part of the image URL.	*string	false
sha	SHA of Thanos container image to be deployed. Defaults to the value of version. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use 'image' instead. The image digest can be specified as part of the image URL.	*string	false
baseImage	Thanos base image if other than default. Deprecated: use 'image' instead	*string	false
resources	Resources defines the resource requirements for the Thanos sidecar. If not provided, no requests/limits will be set	v1.ResourceRequirements	false
objectStorageConfig	ObjectStorageConfig configures object storage in Thanos. Alternative to ObjectStorageConfigFile, and lower order priority.	*v1.SecretKeySelector	false
objectStorageConfigFile	ObjectStorageConfigFile specifies the path of the object storage configuration file. When used alongside with ObjectStorageConfig, ObjectStorageConfigFile takes precedence.	*string	false
listenLocal	ListenLocal makes the Thanos sidecar listen on loopback, so that it does not bind against the Pod IP.	bool	false
tracingConfig	TracingConfig configures tracing in Thanos. This is an experimental feature, it may change in any upcoming release in a breaking way.	*v1.SecretKeySelector	false
tracingConfigFile	TracingConfig specifies the path of the tracing configuration file. When used alongside with TracingConfig, TracingConfigFile takes precedence.	string	false
grpcServerTlsConfig	GRPCServerTLSConfig configures 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.	*TLSConfig	false
logLevel	LogLevel for Thanos sidecar to be configured with.	string	false
logFormat	LogFormat for Thanos sidecar to be configured with.	string	false
minTime	MinTime for Thanos sidecar to be configured with. Option can be a constant time in RFC3339 format or time duration relative to current time, such as -1d or 2h45m. Valid duration units are ms, s, m, h, d, w, y.	string	false
readyTimeout	ReadyTimeout is the maximum time Thanos sidecar will wait for Prometheus to start. Eg 10m	string	false
volumeMounts	VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the thanos-sidecar container.	[]v1.VolumeMount	false

Back to TOC

WebSpec

WebSpec defines the query command line flags when starting Prometheus.

appears in: PrometheusSpec

Field	Description	Scheme	Required
pageTitle	The prometheus web page title	*string	false
tlsConfig		*WebTLSConfig	false

Back to TOC

WebTLSConfig

WebTLSConfig defines the TLS parameters for HTTPS.

appears in: WebSpec

Field	Description	Scheme	Required
keySecret	Secret containing the TLS key for the server.	v1.SecretKeySelector	true
cert	Contains the TLS certificate for the server.	SecretOrConfigMap	true
clientAuthType	Server policy for client authentication. Maps to ClientAuth Policies. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType	string	false
client_ca	Contains the CA certificate for client certificate authentication to the server.	SecretOrConfigMap	false
minVersion	Minimum TLS version that is acceptable. Defaults to TLS12.	string	false
maxVersion	Maximum TLS version that is acceptable. Defaults to TLS13.	string	false
cipherSuites	List of supported cipher suites for TLS versions up to TLS 1.2. If empty, Go default cipher suites are used. Available cipher suites are documented in the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants	[]string	false
preferServerCipherSuites	Controls whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in the order of elements in cipherSuites, is used.	*bool	false
curvePreferences	Elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the go documentation: https://golang.org/pkg/crypto/tls/#CurveID	[]string	false

Back to TOC

ThanosRuler

ThanosRuler defines a ThanosRuler deployment.

appears in: ThanosRulerList

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec	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	ThanosRulerSpec	true
status	Most recent observed status of the ThanosRuler cluster. Read-only. Not included when requesting from the apiserver, only from the ThanosRuler Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status	*ThanosRulerStatus	false

Back to TOC

ThanosRulerList

ThanosRulerList is a list of ThanosRulers.

Field	Description	Scheme	Required
metadata	Standard list metadata More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata	metav1.ListMeta	false
items	List of Prometheuses	[]*ThanosRuler	true

Back to TOC

ThanosRulerSpec

ThanosRulerSpec is a specification of the desired behavior of the ThanosRuler. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

appears in: ThanosRuler

Field	Description	Scheme	Required
podMetadata	PodMetadata contains Labels and Annotations gets propagated to the thanos ruler pods.	*EmbeddedObjectMetadata	false
image	Thanos container image URL.	string	false
imagePullSecrets	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	[]v1.LocalObjectReference	false
paused	When a ThanosRuler deployment is paused, no actions except for deletion will be performed on the underlying objects.	bool	false
replicas	Number of thanos ruler instances to deploy.	*int32	false
nodeSelector	Define which Nodes the Pods are scheduled on.	map[string]string	false
resources	Resources defines the resource requirements for single Pods. If not provided, no requests/limits will be set	v1.ResourceRequirements	false
affinity	If specified, the pod's scheduling constraints.	*v1.Affinity	false
tolerations	If specified, the pod's tolerations.	[]v1.Toleration	false
topologySpreadConstraints	If specified, the pod's topology spread constraints.	[]v1.TopologySpreadConstraint	false
securityContext	SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.	*v1.PodSecurityContext	false
priorityClassName	Priority class assigned to the Pods	string	false
serviceAccountName	ServiceAccountName is the name of the ServiceAccount to use to run the Thanos Ruler Pods.	string	false
storage	Storage spec to specify how storage shall be used.	*StorageSpec	false
volumes	Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.	[]v1.Volume	false
objectStorageConfig	ObjectStorageConfig configures object storage in Thanos. Alternative to ObjectStorageConfigFile, and lower order priority.	*v1.SecretKeySelector	false
objectStorageConfigFile	ObjectStorageConfigFile specifies the path of the object storage configuration file. When used alongside with ObjectStorageConfig, ObjectStorageConfigFile takes precedence.	*string	false
listenLocal	ListenLocal makes the Thanos ruler listen on loopback, so that it does not bind against the Pod IP.	bool	false
queryEndpoints	QueryEndpoints defines Thanos querier endpoints from which to query metrics. Maps to the --query flag of thanos ruler.	[]string	false
queryConfig	Define configuration for connecting to thanos query instances. If this is defined, the QueryEndpoints field will be ignored. Maps to the query.config CLI argument. Only available with thanos v0.11.0 and higher.	*v1.SecretKeySelector	false
alertmanagersUrl	Define URLs to send alerts to Alertmanager. For Thanos v0.10.0 and higher, AlertManagersConfig should be used instead. Note: this field will be ignored if AlertManagersConfig is specified. Maps to the alertmanagers.url arg.	[]string	false
alertmanagersConfig	Define configuration for connecting to alertmanager. Only available with thanos v0.10.0 and higher. Maps to the alertmanagers.config arg.	*v1.SecretKeySelector	false
ruleSelector	A label selector to select which PrometheusRules to mount for alerting and recording.	*metav1.LabelSelector	false
ruleNamespaceSelector	Namespaces to be selected for Rules discovery. If unspecified, only the same namespace as the ThanosRuler object is in is used.	*metav1.LabelSelector	false
enforcedNamespaceLabel	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.	string	false
prometheusRulesExcludedFromEnforce	PrometheusRulesExcludedFromEnforce - 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	[]PrometheusRuleExcludeConfig	false
logLevel	Log level for ThanosRuler to be configured with.	string	false
logFormat	Log format for ThanosRuler to be configured with.	string	false
portName	Port name used for the pods and governing service. This defaults to web	string	false
evaluationInterval	Interval between consecutive evaluations.	string	false
retention	Time duration ThanosRuler shall retain data for. Default is '24h', and must match the regular expression [0-9]+(ms|s|m|h|d|w|y) (milliseconds seconds minutes hours days weeks years).	string	false
containers	Containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch. The current container names are: thanos-ruler and config-reloader. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.	[]v1.Container	false
initContainers	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.	[]v1.Container	false
tracingConfig	TracingConfig configures tracing in Thanos. This is an experimental feature, it may change in any upcoming release in a breaking way.	*v1.SecretKeySelector	false
labels	Labels configure the external label pairs to ThanosRuler. If not provided, default replica label thanos_ruler_replica will be added as a label and be dropped in alerts.	map[string]string	false
alertDropLabels	AlertDropLabels configure the label names which should be dropped in ThanosRuler alerts. If labels field is not provided, thanos_ruler_replica will be dropped in alerts by default.	[]string	false
externalPrefix	The external URL 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.	string	false
routePrefix	The route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path.	string	false
grpcServerTlsConfig	GRPCServerTLSConfig configures 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.	*TLSConfig	false
alertQueryUrl	The external Query URL the Thanos Ruler will set in the 'Source' field of all alerts. Maps to the '--alert.query-url' CLI arg.	string	false
minReadySeconds	Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.	*uint32	false

Back to TOC

ThanosRulerStatus

ThanosRulerStatus is the most recent observed status of the ThanosRuler. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

appears in: ThanosRuler

Field	Description	Scheme	Required
paused	Represents whether any actions on the underlying managed objects are being performed. Only delete actions will be performed.	bool	true
replicas	Total number of non-terminated pods targeted by this ThanosRuler deployment (their labels match the selector).	int32	true
updatedReplicas	Total number of non-terminated pods targeted by this ThanosRuler deployment that have the desired version spec.	int32	true
availableReplicas	Total number of available pods (ready for at least minReadySeconds) targeted by this ThanosRuler deployment.	int32	true
unavailableReplicas	Total number of unavailable pods targeted by this ThanosRuler deployment.	int32	true

Back to TOC

AlertmanagerConfig

AlertmanagerConfig defines a namespaced AlertmanagerConfig to be aggregated across multiple namespaces configuring one Alertmanager cluster.

appears in: AlertmanagerConfigList

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec		AlertmanagerConfigSpec	true

Back to TOC

AlertmanagerConfigList

AlertmanagerConfigList is a list of AlertmanagerConfig.

Field	Description	Scheme	Required
metadata	Standard list metadata More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata	metav1.ListMeta	false
items	List of AlertmanagerConfig	[]*AlertmanagerConfig	true

Back to TOC

AlertmanagerConfigSpec

AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the namespace label is equal to the namespace of the AlertmanagerConfig resource.

appears in: AlertmanagerConfig

Field	Description	Scheme	Required
route	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.	*Route	true
receivers	List of receivers.	[]Receiver	true
inhibitRules	List of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.	[]InhibitRule	false

Back to TOC

EmailConfig

EmailConfig configures notifications via Email.

appears in: Receiver

Field	Description	Scheme	Required
sendResolved	Whether or not to notify about resolved alerts.	*bool	false
to	The email address to send notifications to.	string	false
from	The sender address.	string	false
hello	The hostname to identify to the SMTP server.	string	false
smarthost	The SMTP host through which emails are sent.	string	false
authUsername	The username to use for authentication.	string	false
authPassword	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.	*v1.SecretKeySelector	false
authSecret	The secret's key that contains the CRAM-MD5 secret. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.	*v1.SecretKeySelector	false
authIdentity	The identity to use for authentication.	string	false
headers	Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation.	[]KeyValue	false
html	The HTML body of the email notification.	string	false
text	The text body of the email notification.	string	false
requireTLS	The SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.	*bool	false
tlsConfig	TLS configuration	*monitoringv1.SafeTLSConfig	false

Back to TOC

HTTPConfig

HTTPConfig defines a client HTTP configuration. See https://prometheus.io/docs/alerting/latest/configuration/#http_config

appears in: OpsGenieConfig, PagerDutyConfig, PushoverConfig, SlackConfig, VictorOpsConfig, WeChatConfig, WebhookConfig

Field	Description	Scheme	Required
authorization	Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.	*monitoringv1.SafeAuthorization	false
basicAuth	BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.	*monitoringv1.BasicAuth	false
bearerTokenSecret	The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.	*v1.SecretKeySelector	false
tlsConfig	TLS configuration for the client.	*monitoringv1.SafeTLSConfig	false
proxyURL	Optional proxy URL.	string	false

Back to TOC

InhibitRule

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

appears in: AlertmanagerConfigSpec

Field	Description	Scheme	Required
targetMatch	Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace.	[]Matcher	false
sourceMatch	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.	[]Matcher	false
equal	Labels that must have an equal value in the source and target alert for the inhibition to take effect.	[]string	false

Back to TOC

KeyValue

KeyValue defines a (key, value) tuple.

appears in: EmailConfig, OpsGenieConfig, PagerDutyConfig, VictorOpsConfig

Field	Description	Scheme	Required
key	Key of the tuple.	string	true
value	Value of the tuple.	string	true

Back to TOC

Matcher

Matcher defines how to match on alert's labels.

appears in: InhibitRule, Route

Field	Description	Scheme	Required
name	Label to match.	string	true
value	Label value to match.	string	true
regex	Whether to match on equality (false) or regular-expression (true).	bool	false

Back to TOC

OpsGenieConfig

OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config

appears in: Receiver

Field	Description	Scheme	Required
sendResolved	Whether or not to notify about resolved alerts.	*bool	false
apiKey	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.	*v1.SecretKeySelector	false
apiURL	The URL to send OpsGenie API requests to.	string	false
message	Alert text limited to 130 characters.	string	false
description	Description of the incident.	string	false
source	Backlink to the sender of the notification.	string	false
tags	Comma separated list of tags attached to the notifications.	string	false
note	Additional alert note.	string	false
priority	Priority level of alert. Possible values are P1, P2, P3, P4, and P5.	string	false
details	A set of arbitrary key/value pairs that provide further detail about the incident.	[]KeyValue	false
responders	List of responders responsible for notifications.	[]OpsGenieConfigResponder	false
httpConfig	HTTP client configuration.	*HTTPConfig	false

Back to TOC

OpsGenieConfigResponder

OpsGenieConfigResponder defines a responder to an incident. One of id, name or username has to be defined.

appears in: OpsGenieConfig

Field	Description	Scheme	Required
id	ID of the responder.	string	false
name	Name of the responder.	string	false
username	Username of the responder.	string	false
type	Type of responder.	string	true

Back to TOC

PagerDutyConfig

PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config

appears in: Receiver

Field	Description	Scheme	Required
sendResolved	Whether or not to notify about resolved alerts.	*bool	false
routingKey	The secret's key that contains the PagerDuty integration key (when using Events API v2). Either this field or serviceKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.	*v1.SecretKeySelector	false
serviceKey	The secret's key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or routingKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.	*v1.SecretKeySelector	false
url	The URL to send requests to.	string	false
client	Client identification.	string	false
clientURL	Backlink to the sender of notification.	string	false
description	Description of the incident.	string	false
severity	Severity of the incident.	string	false
class	The class/type of the event.	string	false
group	A cluster or grouping of sources.	string	false
component	The part or component of the affected system that is broken.	string	false
details	Arbitrary key/value pairs that provide further detail about the incident.	[]KeyValue	false
httpConfig	HTTP client configuration.	*HTTPConfig	false

Back to TOC

PushoverConfig

PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config

appears in: Receiver

Field	Description	Scheme	Required
sendResolved	Whether or not to notify about resolved alerts.	*bool	false
userKey	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.	*v1.SecretKeySelector	false
token	The secret's key that contains the registered application’s API token, see https://pushover.net/apps. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.	*v1.SecretKeySelector	false
title	Notification title.	string	false
message	Notification message.	string	false
url	A supplementary URL shown alongside the message.	string	false
urlTitle	A title for supplementary URL, otherwise just the URL is shown	string	false
sound	The name of one of the sounds supported by device clients to override the user's default sound choice	string	false
priority	Priority, see https://pushover.net/api#priority	string	false
retry	How often the Pushover servers will send the same notification to the user. Must be at least 30 seconds.	string	false
expire	How long your notification will continue to be retried for, unless the user acknowledges the notification.	string	false
html	Whether notification message is HTML or plain text.	bool	false
httpConfig	HTTP client configuration.	*HTTPConfig	false

Back to TOC

Receiver

Receiver defines one or more notification integrations.

appears in: AlertmanagerConfigSpec

Field	Description	Scheme	Required
name	Name of the receiver. Must be unique across all items from the list.	string	true
opsgenieConfigs	List of OpsGenie configurations.	[]OpsGenieConfig	false
pagerdutyConfigs	List of PagerDuty configurations.	[]PagerDutyConfig	false
slackConfigs	List of Slack configurations.	[]SlackConfig	false
webhookConfigs	List of webhook configurations.	[]WebhookConfig	false
wechatConfigs	List of WeChat configurations.	[]WeChatConfig	false
emailConfigs	List of Email configurations.	[]EmailConfig	false
victoropsConfigs	List of VictorOps configurations.	[]VictorOpsConfig	false
pushoverConfigs	List of Pushover configurations.	[]PushoverConfig	false

Back to TOC

Route

Route defines a node in the routing tree.

appears in: AlertmanagerConfigSpec

Field	Description	Scheme	Required
receiver	Name of the receiver for this route. If not empty, it should be listed in the receivers field.	string	true
groupBy	List of labels to group by.	[]string	false
groupWait	How long to wait before sending the initial notification. Must match the regular expression [0-9]+(ms|s|m|h) (milliseconds seconds minutes hours).	string	false
groupInterval	How long to wait before sending an updated notification. Must match the regular expression [0-9]+(ms|s|m|h) (milliseconds seconds minutes hours).	string	false
repeatInterval	How long to wait before repeating the last notification. Must match the regular expression [0-9]+(ms|s|m|h) (milliseconds seconds minutes hours).	string	false
matchers	List of matchers that the alert’s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher.	[]Matcher	false
continue	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.	bool	false
routes	Child routes.	[]apiextensionsv1.JSON	false

Back to TOC

SlackAction

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.

appears in: SlackConfig

Field	Description	Scheme	Required
type		string	true
text		string	true
url		string	false
style		string	false
name		string	false
value		string	false
confirm		*SlackConfirmationField	false

Back to TOC

SlackConfig

SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config

appears in: Receiver

Field	Description	Scheme	Required
sendResolved	Whether or not to notify about resolved alerts.	*bool	false
apiURL	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.	*v1.SecretKeySelector	false
channel	The channel or user to send notifications to.	string	false
username		string	false
color		string	false
title		string	false
titleLink		string	false
pretext		string	false
text		string	false
fields	A list of Slack fields that are sent with each notification.	[]SlackField	false
shortFields		bool	false
footer		string	false
fallback		string	false
callbackId		string	false
iconEmoji		string	false
iconURL		string	false
imageURL		string	false
thumbURL		string	false
linkNames		bool	false
mrkdwnIn		[]string	false
actions	A list of Slack actions that are sent with each notification.	[]SlackAction	false
httpConfig	HTTP client configuration.	*HTTPConfig	false

Back to TOC

SlackConfirmationField

SlackConfirmationField protect users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time. See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields for more information.

appears in: SlackAction

Field	Description	Scheme	Required
text		string	true
title		string	false
okText		string	false
dismissText		string	false

Back to TOC

SlackField

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.

appears in: SlackConfig

Field	Description	Scheme	Required
title		string	true
value		string	true
short		*bool	false

Back to TOC

VictorOpsConfig

VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config

appears in: Receiver

Field	Description	Scheme	Required
sendResolved	Whether or not to notify about resolved alerts.	*bool	false
apiKey	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.	*v1.SecretKeySelector	false
apiUrl	The VictorOps API URL.	string	false
routingKey	A key used to map the alert to a team.	string	true
messageType	Describes the behavior of the alert (CRITICAL, WARNING, INFO).	string	false
entityDisplayName	Contains summary of the alerted problem.	string	false
stateMessage	Contains long explanation of the alerted problem.	string	false
monitoringTool	The monitoring tool the state message is from.	string	false
customFields	Additional custom fields for notification.	[]KeyValue	false
httpConfig	The HTTP client's configuration.	*HTTPConfig	false

Back to TOC

WeChatConfig

WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config

appears in: Receiver

Field	Description	Scheme	Required
sendResolved	Whether or not to notify about resolved alerts.	*bool	false
apiSecret	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.	*v1.SecretKeySelector	false
apiURL	The WeChat API URL.	string	false
corpID	The corp id for authentication.	string	false
agentID		string	false
toUser		string	false
toParty		string	false
toTag		string	false
message	API request data as defined by the WeChat API.	string	false
messageType		string	false
httpConfig	HTTP client configuration.	*HTTPConfig	false

Back to TOC

WebhookConfig

WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config

appears in: Receiver

Field	Description	Scheme	Required
sendResolved	Whether or not to notify about resolved alerts.	*bool	false
url	The URL to send HTTP POST requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined.	*string	false
urlSecret	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.	*v1.SecretKeySelector	false
httpConfig	HTTP client configuration.	*HTTPConfig	false
maxAlerts	Maximum number of alerts to be sent per webhook message. When 0, all alerts are included.	int32	false

Back to TOC