Probe [monitoring.coreos.com/v1]
Esc
Start typing to search...
On this page

Probe [monitoring.coreos.com/v1]

Description

The Probe custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the blackbox exporter.

The Probe resource needs 2 pieces of information:

  • The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects.
  • The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics.

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

Type
`object`
Required
  • spec

Specification

PropertyTypeDescription
apiVersionstringAPIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kindstringKind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadataObjectMetaStandard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specobjectspec defines the specification of desired Ingress selection for target discovery by Prometheus.
statusobjectstatus defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.
Most recent observed status of the Probe. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

.spec

Description

spec defines the specification of desired Ingress selection for target discovery by Prometheus.

Type
`object`
PropertyTypeDescription
authorizationobjectauthorization configures the Authorization header credentials used by the client.
Cannot be set at the same time as basicAuth, bearerTokenSecret or oauth2.
basicAuthobjectbasicAuth defines the Basic Authentication credentials used by the client.
Cannot be set at the same time as authorization, bearerTokenSecret or oauth2.
bearerTokenSecretobjectbearerTokenSecret defines a key of a Secret containing the bearer token used by the client for authentication. The secret needs to be in the same namespace as the custom resource and readable by the Prometheus Operator.
Cannot be set at the same time as authorization, basicAuth or oauth2.
Deprecated: use authorization instead.
convertClassicHistogramsToNHCBbooleanconvertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
fallbackScrapeProtocolstringfallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.
It requires Prometheus >= v3.0.0.
followRedirectsbooleanfollowRedirects defines whether the client should follow HTTP 3xx redirects.
intervalstringinterval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used.
jobNamestringjobName assigned to scraped metrics by default.
keepDroppedTargetsintegerkeepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.
It requires Prometheus >= v2.47.0.
labelLimitintegerlabelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
labelNameLengthLimitintegerlabelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
labelValueLengthLimitintegerlabelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
metricRelabelingsarraymetricRelabelings defines the RelabelConfig to apply to samples before ingestion.
metricRelabelings[]objectRelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
modulestringmodule 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
nativeHistogramBucketLimitintegernativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0.
nativeHistogramMinBucketFactorinteger-or-stringnativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0.
oauth2objectoauth2 defines the OAuth2 settings used by the client.
It requires Prometheus >= 2.27.0.
Cannot be set at the same time as authorization, basicAuth or bearerTokenSecret.
paramsarrayparams defines the list of HTTP query parameters for the scrape. Please note that the .spec.module field takes precedence over the module parameter from this list when both are defined. The module name must be added using Module under ProbeSpec.
params[]objectProbeParam defines specification of extra parameters for a Probe.
proberobjectprober defines the specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.
sampleLimitintegersampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
scrapeClassstringscrapeClass defines the scrape class to apply.
scrapeClassicHistogramsbooleanscrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.
Notice: scrapeClassicHistograms corresponds to the always_scrape_classic_histograms field in the Prometheus configuration.
scrapeNativeHistogramsbooleanscrapeNativeHistograms defines whether to enable scraping of native histograms. It requires Prometheus >= v3.8.0.
scrapeProtocolsarray (string)scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred).
If unset, Prometheus uses its default value.
It requires Prometheus >= v2.49.0.
scrapeTimeoutstringscrapeTimeout defines the timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape timeout is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
targetLimitintegertargetLimit defines a limit on the number of scraped targets that will be accepted.
targetsobjecttargets defines a set of static or dynamically discovered targets to probe.
tlsConfigobjecttlsConfig defines the TLS configuration used by the client.

.spec.authorization

Description

authorization configures the Authorization header credentials used by the client.

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

Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.authorization.credentials

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.basicAuth

Description

basicAuth defines the Basic Authentication credentials used by the client.

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

Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.basicAuth.password

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.basicAuth.username

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.bearerTokenSecret

Description

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

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

Deprecated: use authorization instead.

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.metricRelabelings

Description

metricRelabelings defines the RelabelConfig to apply to samples before ingestion.

Type
`array`

.spec.metricRelabelings[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
`object`
PropertyTypeDescription
actionstringaction to perform based on the regex matching.
Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.
Default: "Replace"
modulusintegermodulus to take of the hash of the source label values.
Only applicable when the action is HashMod.
regexstringregex defines the regular expression against which the extracted value is matched.
replacementstringreplacement value against which a Replace action is performed if the regular expression matches.
Regex capture groups are available.
separatorstringseparator defines the string between concatenated SourceLabels.
sourceLabelsarray (string)sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.
targetLabelstringtargetLabel defines the label to which the resulting string is written in a replacement.
It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.
Regex capture groups are available.

.spec.oauth2

Description

oauth2 defines the OAuth2 settings used by the client.

It requires Prometheus >= 2.27.0.

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

Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.oauth2.clientId

Description

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

Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.oauth2.clientId.configMap

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.oauth2.clientId.secret

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.oauth2.clientSecret

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.oauth2.proxyConnectHeader

Description

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

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

Type
`object`

.spec.oauth2.proxyConnectHeader{}

Description

Type
`array`

.spec.oauth2.proxyConnectHeader{}[]

Description

SecretKeySelector selects a key of a Secret.

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.oauth2.tlsConfig

Description

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

Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.oauth2.tlsConfig.ca

Description

ca defines the Certificate authority used when verifying server certificates.

Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.oauth2.tlsConfig.ca.configMap

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.oauth2.tlsConfig.ca.secret

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.oauth2.tlsConfig.cert

Description

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

Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.oauth2.tlsConfig.cert.configMap

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.oauth2.tlsConfig.cert.secret

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.oauth2.tlsConfig.keySecret

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.params

Description

params defines the list of HTTP query parameters for the scrape. Please note that the .spec.module field takes precedence over the module parameter from this list when both are defined. The module name must be added using Module under ProbeSpec.

Type
`array`

.spec.params[]

Description

ProbeParam defines specification of extra parameters for a Probe.

Type
`object`
Required
  • name
PropertyTypeDescription
namestringname defines the parameter name
valuesarray (string)values defines the parameter values

.spec.prober

Description

prober defines the specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.

Type
`object`
Required
  • url
PropertyTypeDescription
noProxystringnoProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
pathstringpath to collect metrics from. Defaults to /probe.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
schemestringscheme defines the HTTP scheme to use when scraping the prober.
urlstringurl defines the address of the prober.
Unlike what the name indicates, the value should be in the form of address:port without any scheme which should be specified in the scheme field.

.spec.prober.proxyConnectHeader

Description

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

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

Type
`object`

.spec.prober.proxyConnectHeader{}

Description

Type
`array`

.spec.prober.proxyConnectHeader{}[]

Description

SecretKeySelector selects a key of a Secret.

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.targets

Description

targets defines a set of static or dynamically discovered targets to probe.

Type
`object`
PropertyTypeDescription
ingressobjectingress defines the Ingress objects to probe and the relabeling configuration. If staticConfig is also defined, staticConfig takes precedence.
staticConfigobjectstaticConfig defines the static list of targets to probe and the relabeling configuration. If ingress is also defined, staticConfig takes precedence. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config.

.spec.targets.ingress

Description

ingress defines the Ingress objects to probe and the relabeling configuration. If staticConfig is also defined, staticConfig takes precedence.

Type
`object`
PropertyTypeDescription
namespaceSelectorobjectnamespaceSelector defines from which namespaces to select Ingress objects.
relabelingConfigsarrayrelabelingConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the \__tmp_prometheus_ingress_address label. It can be used to customize the probed URL. The original scrape job’s name is available via the \__tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
relabelingConfigs[]objectRelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
selectorobjectselector to select the Ingress objects.

.spec.targets.ingress.namespaceSelector

Description

namespaceSelector defines from which namespaces to select Ingress objects.

Type
`object`
PropertyTypeDescription
anybooleanany defines the boolean describing whether all namespaces are selected in contrast to a list restricting them.
matchNamesarray (string)matchNames defines the list of namespace names to select from.

.spec.targets.ingress.relabelingConfigs

Description

relabelingConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the \__tmp_prometheus_ingress_address label. It can be used to customize the probed URL. The original scrape job’s name is available via the \__tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
`array`

.spec.targets.ingress.relabelingConfigs[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
`object`
PropertyTypeDescription
actionstringaction to perform based on the regex matching.
Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.
Default: "Replace"
modulusintegermodulus to take of the hash of the source label values.
Only applicable when the action is HashMod.
regexstringregex defines the regular expression against which the extracted value is matched.
replacementstringreplacement value against which a Replace action is performed if the regular expression matches.
Regex capture groups are available.
separatorstringseparator defines the string between concatenated SourceLabels.
sourceLabelsarray (string)sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.
targetLabelstringtargetLabel defines the label to which the resulting string is written in a replacement.
It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.
Regex capture groups are available.

.spec.targets.ingress.selector

Description

selector to select the Ingress objects.

Type
`object`
PropertyTypeDescription
matchExpressionsarraymatchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions[]objectA label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
matchLabelsobject (string)matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.targets.ingress.selector.matchExpressions

Description

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

Type
`array`

.spec.targets.ingress.selector.matchExpressions[]

Description

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

Type
`object`
Required
  • key
  • operator
PropertyTypeDescription
keystringkey is the label key that the selector applies to.
operatorstringoperator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
valuesarray (string)values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.targets.staticConfig

Description

staticConfig defines the static list of targets to probe and the relabeling configuration. If ingress is also defined, staticConfig takes precedence. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config.

Type
`object`
PropertyTypeDescription
labelsobject (string)labels defines all labels assigned to all metrics scraped from the targets.
relabelingConfigsarrayrelabelingConfigs defines relabelings to be apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
relabelingConfigs[]objectRelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
staticarray (string)static defines the list of hosts to probe.

.spec.targets.staticConfig.relabelingConfigs

Description

relabelingConfigs defines relabelings to be apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
`array`

.spec.targets.staticConfig.relabelingConfigs[]

Description

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Type
`object`
PropertyTypeDescription
actionstringaction to perform based on the regex matching.
Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0.
Default: "Replace"
modulusintegermodulus to take of the hash of the source label values.
Only applicable when the action is HashMod.
regexstringregex defines the regular expression against which the extracted value is matched.
replacementstringreplacement value against which a Replace action is performed if the regular expression matches.
Regex capture groups are available.
separatorstringseparator defines the string between concatenated SourceLabels.
sourceLabelsarray (string)sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.
targetLabelstringtargetLabel defines the label to which the resulting string is written in a replacement.
It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions.
Regex capture groups are available.

.spec.tlsConfig

Description

tlsConfig defines the TLS configuration used by the client.

Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.tlsConfig.ca

Description

ca defines the Certificate authority used when verifying server certificates.

Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.tlsConfig.ca.configMap

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.tlsConfig.ca.secret

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.tlsConfig.cert

Description

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

Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.tlsConfig.cert.configMap

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.tlsConfig.cert.secret

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.tlsConfig.keySecret

Description

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

Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.status

Description

status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.

Most recent observed status of the Probe. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Type
`object`
PropertyTypeDescription
bindingsarraybindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
bindings[]objectWorkloadBinding is a link between a configuration resource and a workload resource.

.status.bindings

Description

bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.

Type
`array`

.status.bindings[]

Description

WorkloadBinding is a link between a configuration resource and a workload resource.

Type
`object`
Required
  • group
  • name
  • namespace
  • resource
PropertyTypeDescription
conditionsarrayconditions defines the current state of the configuration resource when bound to the referenced Workload object.
conditions[]objectConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
groupstringgroup defines the group of the referenced resource.
namestringname defines the name of the referenced object.
namespacestringnamespace defines the namespace of the referenced object.
resourcestringresource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).

.status.bindings[].conditions

Description

conditions defines the current state of the configuration resource when bound to the referenced Workload object.

Type
`array`

.status.bindings[].conditions[]

Description

ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.

Type
`object`
Required
  • lastTransitionTime
  • status
  • type
PropertyTypeDescription
lastTransitionTimestringlastTransitionTime defines the time of the last update to the current status property.
messagestringmessage defines the human-readable message indicating details for the condition’s last transition.
observedGenerationintegerobservedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[].observedGeneration is 9, the condition is out of date with respect to the current state of the object.
reasonstringreason for the condition’s last transition.
statusstringstatus of the condition.
typestringtype of the condition being reported. Currently, only "Accepted" is supported.

API endpoints

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1/probes
    • GET: list objects of kind Probe
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes
    • DELETE: delete collection of Probe
    • GET: list objects of kind Probe
    • POST: create a Probe
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}
    • DELETE: delete a Probe
    • GET: read the specified Probe
    • PATCH: partially update the specified Probe
    • PUT: replace the specified Probe
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}/status
    • GET: read status of the specified Probe
    • PATCH: partially update status of the specified Probe
    • PUT: replace status of the specified Probe

/apis/monitoring.coreos.com/v1/probes

HTTP method
`GET`
Description
list objects of kind Probe

HTTP responses

HTTP codeReponse body
200 - OKProbeList schema
401 - UnauthorizedEmpty

/apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes

HTTP method
`DELETE`
Description
delete collection of Probe

HTTP responses

HTTP codeReponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
list objects of kind Probe

HTTP responses

HTTP codeReponse body
200 - OKProbeList schema
401 - UnauthorizedEmpty
HTTP method
`POST`
Description
create a Probe

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

ParameterTypeDescription
bodyProbe schema

HTTP responses

HTTP codeReponse body
200 - OKProbe schema
201 - CreatedProbe schema
202 - AcceptedProbe schema
401 - UnauthorizedEmpty

/apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}

Global path parameters

ParameterTypeDescription
namestringname of the Probe
HTTP method
`DELETE`
Description
delete a Probe

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP codeReponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
read the specified Probe

HTTP responses

HTTP codeReponse body
200 - OKProbe schema
401 - UnauthorizedEmpty
HTTP method
`PATCH`
Description
partially update the specified Probe

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP codeReponse body
200 - OKProbe schema
401 - UnauthorizedEmpty
HTTP method
`PUT`
Description
replace the specified Probe

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

ParameterTypeDescription
bodyProbe schema

HTTP responses

HTTP codeReponse body
200 - OKProbe schema
201 - CreatedProbe schema
401 - UnauthorizedEmpty

/apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}/status

Global path parameters

ParameterTypeDescription
namestringname of the Probe
HTTP method
`GET`
Description
read status of the specified Probe

HTTP responses

HTTP codeReponse body
200 - OKProbe schema
401 - UnauthorizedEmpty
HTTP method
`PATCH`
Description
partially update status of the specified Probe

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP codeReponse body
200 - OKProbe schema
401 - UnauthorizedEmpty
HTTP method
`PUT`
Description
replace status of the specified Probe

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

ParameterTypeDescription
bodyProbe schema

HTTP responses

HTTP codeReponse body
200 - OKProbe schema
201 - CreatedProbe schema
401 - UnauthorizedEmpty