Probe [monitoring.coreos.com/v1]

authorization

object

Authorization section for this endpoint

basicAuth

object

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

bearerTokenSecret

object

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.

interval

string

Interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used.

jobName

string

The job name assigned to scraped metrics by default.

keepDroppedTargets

integer

Per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0.

labelLimit

integer

Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.

labelNameLengthLimit

integer

Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.

labelValueLengthLimit

integer

Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.

metricRelabelings

array

MetricRelabelConfigs to apply to samples before ingestion.

metricRelabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

module

string

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

oauth2

object

OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.

prober

object

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

sampleLimit

integer

SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.

scrapeClass

string

The scrape class to apply.

scrapeProtocols

array (string)

scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. It requires Prometheus >= v2.49.0.

scrapeTimeout

string

Timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape timeout is used.

targetLimit

integer

TargetLimit defines a limit on the number of scraped targets that will be accepted.

targets

object

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

tlsConfig

object

TLS configuration to use when scraping the endpoint.

credentials

object

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

type

string

Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

password

object

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

username

object

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

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

action

string

Action to perform based on the regex matching. Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0. Default: "Replace"

modulus

integer

Modulus to take of the hash of the source label values. Only applicable when the action is HashMod.

regex

string

Regular expression against which the extracted value is matched.

replacement

string

Replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available.

separator

string

Separator is the string between concatenated SourceLabels.

sourceLabels

array (string)

The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

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.

clientId

object

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

clientSecret

object

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

endpointParams

object (string)

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

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tokenUrl

string

tokenURL configures the URL to fetch the token from.

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

path

string

Path to collect metrics from. Defaults to /probe.

proxyUrl

string

Optional ProxyURL.

scheme

string

HTTP scheme to use for scraping. http and https are the expected values unless you rewrite the scheme label via relabeling. If empty, Prometheus uses the default value http.

url

string

Mandatory URL of the prober.

ingress

object

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

staticConfig

object

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

namespaceSelector

object

From which namespaces to select Ingress objects.

relabelingConfigs

array

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

relabelingConfigs[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

selector

object

Selector to select the Ingress objects.

any

boolean

Boolean describing whether all namespaces are selected in contrast to a list restricting them.

matchNames

array (string)

List of namespace names to select from.

action

string

Action to perform based on the regex matching. Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0. Default: "Replace"

modulus

integer

Modulus to take of the hash of the source label values. Only applicable when the action is HashMod.

regex

string

Regular expression against which the extracted value is matched.

replacement

string

Replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available.

separator

string

Separator is the string between concatenated SourceLabels.

sourceLabels

array (string)

The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

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.

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key

string

key is the label key that the selector applies to.

operator

string

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

values

array (string)

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

labels

object (string)

Labels assigned to all metrics scraped from the targets.

relabelingConfigs

array

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

relabelingConfigs[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

static

array (string)

The list of hosts to probe.

action

string

Action to perform based on the regex matching. Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0. Default: "Replace"

modulus

integer

Modulus to take of the hash of the source label values. Only applicable when the action is HashMod.

regex

string

Regular expression against which the extracted value is matched.

replacement

string

Replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available.

separator

string

Separator is the string between concatenated SourceLabels.

sourceLabels

array (string)

The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

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.

ca

object

Certificate authority used when verifying server certificates.

cert

object

Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

200 - OK

ProbeList schema

401 - Unauthorized

Empty

200 - OK

Status schema

401 - Unauthorized

Empty

200 - OK

ProbeList schema

401 - Unauthorized

Empty

dryRun

string

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

Probe schema

200 - OK

Probe schema

201 - Created

Probe schema

202 - Accepted

Probe schema

401 - Unauthorized

Empty

name

string

name of the Probe

dryRun

string

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

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

200 - OK

Probe schema

401 - Unauthorized

Empty

dryRun

string

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

200 - OK

Probe schema

401 - Unauthorized

Empty

dryRun

string

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

Probe schema

200 - OK

Probe schema

201 - Created

Probe schema

401 - Unauthorized

Empty