ScrapeConfig

com.coreos.monitoring.v1alpha1.ScrapeConfig

ScrapeConfig defines a namespaced Prometheus scrape_config to be aggregated across multiple namespaces into the Prometheus configuration.

apiVersionstring = "monitoring.coreos.com/v1alpha1"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kindstring = "ScrapeConfig"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to.Cannot be updated. In CamelCase.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadataobject
specobject requiredspec defines the specification of ScrapeConfigSpec.
authorizationobjectauthorization defines the header to use on every scrape request.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
azureSDConfigs[]objectazureSDConfigs defines a list of Azure service discovery configurations.
authenticationMethodstringauthenticationMethod defines the authentication method, either `OAuth` or `ManagedIdentity` or `SDK`. See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview SDK authentication method uses environment variables by default. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication
authorizationobjectauthorization defines the authorization header configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `oAuth2`, or `basicAuth`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines the information to authenticate against the target HTTP endpoint.More info: https://prometheus.io/docs/operating/configuration/#endpoints Cannot be set at the same time as `authorization`, or `oAuth2`.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
clientIDstringclientID defines client ID. Only required with the OAuth authentication method.
clientSecretobjectclientSecret defines client secret. Only required with the OAuth authentication method.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
environmentstringenvironment defines the Azure environment.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
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.
oauth2objectoauth2 defines the configuration to use on every scrape request.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
resourceGroupstringresourceGroup defines resource group name. Limits discovery to this resource group. Requires Prometheus v2.35.0 and above
subscriptionIDstring requiredsubscriptionID defines subscription ID. Always required.
tenantIDstringtenantID defines tenant ID. Only required with the OAuth authentication method.
tlsConfigobjecttlsConfig defines the TLS configuration applying to the target HTTP endpoint.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
basicAuthobjectbasicAuth defines information to use on every scrape request.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
bodySizeLimitstringbodySizeLimit defines a per-scrape limit on the size of the uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail.It requires Prometheus >= v2.28.0.
consulSDConfigs[]objectconsulSDConfigs defines a list of Consul service discovery configurations.
allowStalebooleanallowStale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. If unset, Prometheus uses its default value.
authorizationobjectauthorization defines the header configuration to authenticate against the Consul Server. Cannot be set at the same time as `basicAuth`, or `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines the information to authenticate against the Consul Server.More info: https://prometheus.io/docs/operating/configuration/#endpoints Cannot be set at the same time as `authorization`, or `oauth2`.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
datacenterstringdatacenter defines the consul Datacenter name, if not provided it will use the local Consul Agent Datacenter.
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
filterstringfilter defines the filter expression used to filter the catalog results. See https://developer.hashicorp.com/consul/api-docs/catalog#filtering It requires Prometheus >= 3.0.0.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
healthFilterstringhealthFilter defines the filter expression used to filter the health results. See https://developer.hashicorp.com/consul/api-docs/health#filtering It requires Prometheus >= 3.11.2.
namespacestringnamespace are only supported in Consul Enterprise.It requires Prometheus >= 2.28.0.
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.
nodeMetamap[string]stringnodeMeta defines the node metadata key/value pairs to filter nodes for a given service. Starting with Consul 1.14, it is recommended to use `filter` with the `NodeMeta` selector instead.
oauth2objectoauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
partitionstringpartition defines the admin Partitions are only supported in Consul Enterprise.
pathPrefixstringpathPrefix defines the prefix for URIs for when consul is behind an API gateway (reverse proxy).It requires Prometheus >= 2.45.0.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
schemestringscheme defines the HTTP Scheme.
serverstring requiredserver defines the consul server address. A valid string consisting of a hostname or IP followed by an optional port number.
services[]stringservices defines a list of services for which targets are retrieved. If omitted, all services are scraped.
tagSeparatorstringtagSeparator defines the string by which Consul tags are joined into the tag label. If unset, Prometheus uses its default value.
tags[]stringtags defines an optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. Starting with Consul 1.14, it is recommended to use `filter` with the `ServiceTags` selector instead.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Consul API.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenRefobjecttokenRef defines the consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent.
keystring requiredThe 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
convertClassicHistogramsToNHCBbooleanconvertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.
digitalOceanSDConfigs[]objectdigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations.
authorizationobjectauthorization defines the header configuration to authenticate against the DigitalOcean API. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
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.
oauth2objectoauth2 defines the configuration to use on every scrape request.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the DigitalOcean API.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
dnsSDConfigs[]objectdnsSDConfigs defines a list of DNS service discovery configurations.
names[]string requirednames defines a list of DNS domain names to be queried.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must Ignored for SRV records
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
typestringtype defines the type of DNS query to perform. One of SRV, A, AAAA, MX or NS. If not set, Prometheus uses its default value.When set to NS, it requires Prometheus >= v2.49.0. When set to MX, it requires Prometheus >= v2.38.0
dockerSDConfigs[]objectdockerSDConfigs defines a list of Docker service discovery configurations.
authorizationobjectauthorization defines the header configuration to authenticate against the Docker daemon. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines information to use on every scrape request.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
filters[]objectfilters defines filters to limit the discovery process to a subset of the available resources.
namestring requiredname of the Filter.
values[]string requiredvalues defines values to filter on.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
hoststring requiredhost defines the address of the docker daemon.
hostNetworkingHoststringhostNetworkingHost defines the host to use if the container is in host networking mode.
matchFirstNetworkbooleanmatchFirstNetwork defines whether to match the first network if the container has multiple networks defined. If unset, Prometheus uses true by default. It requires Prometheus >= v2.54.1.
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.
oauth2objectoauth2 defines the configuration to use on every scrape request.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Docker daemon.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
dockerSwarmSDConfigs[]objectdockerSwarmSDConfigs defines a list of Dockerswarm service discovery configurations.
authorizationobjectauthorization defines the header configuration to authenticate against the Docker Swarm API. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines information to use on every scrape request.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
filters[]objectfilters defines the filters to limit the discovery process to a subset of available resources. The available filters are listed in the upstream documentation: Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList Tasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList Nodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList
namestring requiredname of the Filter.
values[]string requiredvalues defines values to filter on.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
hoststring requiredhost defines the address of the Docker daemon
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.
oauth2objectoauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must tasks and services that don't have published ports.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
rolestring requiredrole of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Docker Swarm daemon.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
ec2SDConfigs[]objectec2SDConfigs defines a list of EC2 service discovery configurations.
accessKeyobjectaccessKey defines the AWS API key.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2. It requires Prometheus >= v2.41.0
filters[]objectfilters can be used optionally to filter the instance list by other criteria. Available filter criteria can be found here: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html Filter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html It requires Prometheus >= v2.3.0
namestring requiredname of the Filter.
values[]string requiredvalues defines values to filter on.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.41.0
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.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
regionstringregion defines the AWS region.
roleARNstringroleARN defines an alternative to using AWS API keys.
secretKeyobjectsecretKey defines the AWS API secret.
keystring requiredThe 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
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the EC2 API. It requires Prometheus >= v2.41.0
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
enableCompressionbooleanenableCompression when false, Prometheus will request uncompressed response from the scraped target.It requires Prometheus >= v2.49.0.If unset, Prometheus uses true by default.
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
eurekaSDConfigs[]objecteurekaSDConfigs defines a list of Eureka service discovery configurations.
authorizationobjectauthorization defines the header configuration to authenticate against the Eureka server. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines the BasicAuth information to use on every scrape request.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
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.
oauth2objectoauth2 defines the configuration to use on every scrape request.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
serverstring requiredserver defines the URL to connect to the Eureka server.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Eureka server.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
fallbackScrapeProtocolstringfallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.It requires Prometheus >= v3.0.0.
fileSDConfigs[]objectfileSDConfigs defines a list of file service discovery configurations.
files[]string requiredfiles defines the list of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the prometheus-operator project makes no guarantees about the working directory where the configuration file is stored. Files must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
gceSDConfigs[]objectgceSDConfigs defines a list of GCE service discovery configurations.
filterstringfilter defines the filter that can be used optionally to filter the instance list by other criteria Syntax of this filter is described in the filter query parameter section: https://cloud.google.com/compute/docs/reference/latest/instances/list
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
projectstring requiredproject defines the Google Cloud Project ID
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
tagSeparatorstringtagSeparator defines the tag separator is used to separate the tags on concatenation
zonestring requiredzone defines the zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs.
hetznerSDConfigs[]objecthetznerSDConfigs defines a list of Hetzner service discovery configurations.
authorizationobjectauthorization defines the header configuration to authenticate against the Hetzner API. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines information to use on every scrape request.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
labelSelectorstringlabelSelector defines the label selector used to filter the servers when fetching them from the API. It requires Prometheus >= v3.5.0.
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.
oauth2objectoauth2 defines the configuration to use on every scrape request.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
rolestring requiredrole defines the Hetzner role of entities that should be discovered.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Hetzner API.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
honorLabelsbooleanhonorLabels defines when true the metric's labels when they collide with the target's labels.
honorTimestampsbooleanhonorTimestamps defines whether Prometheus preserves the timestamps when exposed by the target.
httpSDConfigs[]objecthttpSDConfigs defines a list of HTTP service discovery configurations.
authorizationobjectauthorization defines the authorization header configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `oAuth2`, or `basicAuth`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines information to use on every scrape request.More info: https://prometheus.io/docs/operating/configuration/#endpoints Cannot be set at the same time as `authorization`, or `oAuth2`.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
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.
oauth2objectoauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
tlsConfigobjecttlsConfig defines the TLS configuration applying to the target HTTP endpoint.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
urlstring requiredurl defines the URL from which the targets are fetched.
ionosSDConfigs[]objectionosSDConfigs defines a list of IONOS service discovery configurations.
authorizationobject requiredauthorization defines the header configuration to authenticate against the IONOS API. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
datacenterIDstring requireddatacenterID defines the unique ID of the IONOS data center.
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
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.
oauth2objectoauth2 defines the configuration to use on every scrape request.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the IONOS API.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
jobNamestringjobName defines the value of the `job` label assigned to the scraped metrics by default.The `job_name` field in the rendered scrape configuration is always controlled by the operator to prevent duplicate job names, which Prometheus does not allow. Instead the `job` label is set by means of relabeling configs.
keepDroppedTargetsinteger (int64)keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.It requires Prometheus >= v2.47.0.
kubernetesSDConfigs[]objectkubernetesSDConfigs defines a list of Kubernetes service discovery configurations.
apiServerstringapiServer defines the API server address consisting of a hostname or IP address followed by an optional port number. If left empty, Prometheus is assumed to run inside of the cluster. It will discover API servers automatically and use the pod's CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.
attachMetadataobjectattachMetadata defines the metadata to attach to discovered targets. It requires Prometheus >= v2.35.0 when using the `Pod` role and Prometheus >= v2.37.0 for `Endpoints` and `Endpointslice` roles.
nodebooleannode attaches node metadata to discovered targets. When set to true, Prometheus must have the `get` permission on the `Nodes` objects. Only valid for Pod, Endpoint and Endpointslice roles.
authorizationobjectauthorization defines the authorization header to use on every scrape request. Cannot be set at the same time as `basicAuth`, or `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines information to use on every scrape request. Cannot be set at the same time as `authorization`, or `oauth2`.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
namespacesobjectnamespaces defines the namespace discovery. If omitted, Prometheus discovers targets across all namespaces.
names[]stringnames defines a list of namespaces where to watch for resources. If empty and `ownNamespace` isn't true, Prometheus watches for resources in all namespaces.
ownNamespacebooleanownNamespace includes the namespace in which the Prometheus pod runs to the list of watched namespaces.
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.
oauth2objectoauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
rolestring requiredrole defines the Kubernetes role of the entities that should be discovered. Role `Endpointslice` requires Prometheus >= v2.21.0
selectors[]objectselectors defines the selector to select objects. It requires Prometheus >= v2.17.0
fieldstringfield defines an optional field selector to limit the service discovery to resources which have fields with specific values. e.g: `metadata.name=foobar`
labelstringlabel defines an optional label selector to limit the service discovery to resources with specific labels and label values. e.g: `node.kubernetes.io/instance-type=master`
rolestring requiredrole defines the type of Kubernetes resource to limit the service discovery to. Accepted values are: Node, Pod, Endpoints, EndpointSlice, Service, Ingress.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Kubernetes API.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
kumaSDConfigs[]objectkumaSDConfigs defines a list of Kuma service discovery configurations.
authorizationobjectauthorization defines the header configuration to authenticate against the Kuma control plane. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines information to use on every scrape request.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
clientIDstringclientID is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend. It requires Prometheus >= v2.50.0.
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
fetchTimeoutstringfetchTimeout defines the time after which the monitoring assignments are refreshed.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
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.
oauth2objectoauth2 defines the configuration to use on every scrape request.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
serverstring requiredserver defines the address of the Kuma Control Plane's MADS xDS server.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Kuma control plane.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
labelLimitinteger (int64)labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
labelNameLengthLimitinteger (int64)labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
labelValueLengthLimitinteger (int64)labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
lightSailSDConfigs[]objectlightSailSDConfigs defines a list of Lightsail service discovery configurations.
accessKeyobjectaccessKey defines the AWS API key.
keystring requiredThe 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
authorizationobjectauthorization defines the header configuration to authenticate against the Lightsail API. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines information to use on every scrape request. Cannot be set at the same time as `authorization`, or `oauth2`.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
endpointstringendpoint defines the custom endpoint to be used.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
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.
oauth2objectoauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
regionstringregion defines the AWS region.
roleARNstringroleARN defines the AWS Role ARN, an alternative to using AWS API keys.
secretKeyobjectsecretKey defines the AWS API secret.
keystring requiredThe 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
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Lightsail API.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
linodeSDConfigs[]objectlinodeSDConfigs defines a list of Linode service discovery configurations.
authorizationobjectauthorization defines the header configuration to authenticate against the Linode API. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
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.
oauth2objectoauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
regionstringregion defines the region to filter on.
tagSeparatorstringtagSeparator defines the string by which Linode Instance tags are joined into the tag label.el.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Linode API.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
metricRelabelings[]objectmetricRelabelings defines the metricRelabelings to apply to samples before ingestion.
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"
modulusinteger (int64)modulus 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.
sourceLabels[]stringsourceLabels 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.
metricsPathstringmetricsPath defines the HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics).
nameEscapingSchemestringnameEscapingScheme defines the metric name escaping mode to request through content negotiation.It requires Prometheus >= v3.4.0.
nameValidationSchemestringnameValidationScheme defines the validation scheme for metric and label names.It requires Prometheus >= v3.0.0.
nativeHistogramBucketLimitinteger (int64)nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0.
nativeHistogramMinBucketFactorobjectnativeHistogramMinBucketFactor 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.
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.
nomadSDConfigs[]objectnomadSDConfigs defines a list of Nomad service discovery configurations.
allowStalebooleanallowStale defines the information to access the Nomad API. It is to be defined as the Nomad documentation requires.
authorizationobjectauthorization defines the header configuration to authenticate against the Nomad API. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines information to use on every scrape request.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
namespacestringnamespace defines the Nomad namespace to query for service discovery. When specified, only resources within this namespace will be discovered.
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.
oauth2objectoauth2 defines the configuration to use on every scrape request.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
regionstringregion defines the Nomad region to query for service discovery. When specified, only resources within this region will be discovered.
serverstring requiredserver defines the Nomad server address to connect to for service discovery. This should be the full URL including protocol (e.g., "https://nomad.example.com:4646";).
tagSeparatorstringtagSeparator defines the separator used to join multiple tags. This determines how Nomad service tags are concatenated into Prometheus labels.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Nomad API.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
oauth2objectoauth2 defines the configuration to use on every scrape request.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
openstackSDConfigs[]objectopenstackSDConfigs defines a list of OpenStack service discovery configurations.
allTenantsbooleanallTenants defines whether the service discovery should list all instances for all projects. It is only relevant for the 'instance' role and usually requires admin permissions.
applicationCredentialIdstringapplicationCredentialId defines the OpenStack applicationCredentialId.
applicationCredentialNamestringapplicationCredentialName defines the ApplicationCredentialID or ApplicationCredentialName fields are required if using an application credential to authenticate. Some providers allow you to create an application credential to authenticate rather than a password.
applicationCredentialSecretobjectapplicationCredentialSecret defines the required field if using an application credential to authenticate.
keystring requiredThe 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
availabilitystringavailability defines the availability of the endpoint to connect to.
domainIDstringdomainID defines The OpenStack domainID.
domainNamestringdomainName defines at most one of domainId and domainName that must be provided if using username with Identity V3. Otherwise, either are optional.
identityEndpointstringidentityEndpoint defines the HTTP endpoint that is required to work with the Identity API of the appropriate version.
passwordobjectpassword defines the password for the Identity V2 and V3 APIs. Consult with your provider's control panel to discover your account's preferred method of authentication.
keystring requiredThe 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
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
projectIDstringprojectID defines the OpenStack projectID.
projectNamestringprojectName defines an optional field for the Identity V2 API. Some providers allow you to specify a ProjectName instead of the ProjectId. Some require both. Your provider's authentication policies will determine how these fields influence authentication.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
regionstring requiredregion defines the OpenStack Region.
rolestring requiredrole defines the OpenStack role of entities that should be discovered.Note: The `LoadBalancer` role requires Prometheus >= v3.2.0.
tlsConfigobjecttlsConfig defines the TLS configuration applying to the target HTTP endpoint.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
useridstringuserid defines the OpenStack userid.
usernamestringusername defines the username required if using Identity V2 API. Consult with your provider's control panel to discover your account's username. In Identity V3, either userid or a combination of username and domainId or domainName are needed
ovhcloudSDConfigs[]objectovhcloudSDConfigs defines a list of OVHcloud service discovery configurations.
applicationKeystring requiredapplicationKey defines the access key to use for OVHCloud API authentication. This is obtained from the OVHCloud API credentials at https://api.ovh.com.
applicationSecretobject requiredapplicationSecret defines the secret key for OVHCloud API authentication. This contains the application secret obtained during OVHCloud API credential creation.
keystring requiredThe 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
consumerKeyobject requiredconsumerKey defines the consumer key for OVHCloud API authentication. This is the third component of OVHCloud's three-key authentication system.
keystring requiredThe 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
endpointstringendpoint defines a custom API endpoint to be used. When not specified, defaults to the standard OVHCloud API endpoint for the region.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
servicestring requiredservice defines the service type of the targets to retrieve. Must be either `VPS` or `DedicatedServer` to specify which OVHCloud resources to discover.
paramsmap[string][]stringparams defines optional HTTP URL parameters
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
puppetDBSDConfigs[]objectpuppetDBSDConfigs defines a list of PuppetDB service discovery configurations.
authorizationobjectauthorization defines the header configuration to authenticate against the PuppetDB API. Cannot be set at the same time as `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe 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
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines information to use on every scrape request. Cannot be set at the same time as `authorization`, or `oauth2`.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe 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
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe 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
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
includeParametersbooleanincludeParameters defines whether to include the parameters as meta labels. Note: Enabling this exposes parameters in the Prometheus UI and API. Make sure that you don't have secrets exposed as parameters if you enable this.
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.
oauth2objectoauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe 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
endpointParamsmap[string]stringendpointParams 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
scopes[]stringscopes 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.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
querystring requiredquery defines the Puppet Query Language (PQL) query. Only resources are supported. https://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the PuppetDB server.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
urlstring requiredurl defines the URL of the PuppetDB root query endpoint.
relabelings[]objectrelabelings defines how to rewrite the target's labels before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job's name is available via the `__tmp_prometheus_job_name` label.More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
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"
modulusinteger (int64)modulus 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.
sourceLabels[]stringsourceLabels 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.
sampleLimitinteger (int64)sampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
scalewaySDConfigs[]objectscalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations.
accessKeystring requiredaccessKey defines the access key to use. https://console.scaleway.com/project/credentials
apiURLstringapiURL defines the API URL to use when doing the server listing requests.
enableHTTP2booleanenableHTTP2 defines whether to enable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects.
nameFilterstringnameFilter defines a name filter (works as a LIKE) to apply on the server listing request.
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.
portinteger (int32)port defines the port to scrape metrics from. If using the public IP address, this must
projectIDstring requiredprojectID defines the Project ID of the targets.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
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.
refreshIntervalstringrefreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
rolestring requiredrole defines the service of the targets to retrieve. Must be `Instance` or `Baremetal`.
secretKeyobject requiredsecretKey defines the secret key to use when listing targets.
keystring requiredThe 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
tagsFilter[]stringtagsFilter defines a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request.
tlsConfigobjecttlsConfig defines the TLS configuration to connect to the Scaleway API.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
zonestringzone defines the availability zone of your targets (e.g. fr-par-1).
schemestringscheme defines the protocol scheme used for requests.
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.
scrapeIntervalstringscrapeInterval defines the interval between consecutive scrapes.
scrapeNativeHistogramsbooleanscrapeNativeHistograms defines whether to enable scraping of native histograms. It requires Prometheus >= v3.8.0.
scrapeProtocols[]stringscrapeProtocols 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 number of seconds to wait until a scrape request times out. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
staticConfigs[]objectstaticConfigs defines a list of static targets with a common label set.
labelsmap[string]stringlabels defines labels assigned to all metrics scraped from the targets.
targets[]string requiredtargets defines the list of targets for this static configuration.
targetLimitinteger (int64)targetLimit defines a limit on the number of scraped targets that will be accepted.
tlsConfigobjecttlsConfig defines the TLS configuration to use on every scrape request
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe 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
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe 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
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe 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
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.
trackTimestampsStalenessbooleantrackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if `honorTimestamps` is false. It requires Prometheus >= v2.48.0.
statusobject read-onlystatus 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 ScrapeConfig.Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
bindings[]object read-onlybindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
conditions[]object read-onlyconditions defines the current state of the configuration resource when bound to the referenced Workload object.
lastTransitionTimestring (date-time) required read-onlylastTransitionTime defines the time of the last update to the current status property.
messagestring read-onlymessage defines the human-readable message indicating details for the condition's last transition.
observedGenerationinteger (int64) read-onlyobservedGeneration 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.
reasonstring read-onlyreason for the condition's last transition.
statusstring required read-onlystatus of the condition.
typestring required read-onlytype of the condition being reported. Currently, only "Accepted" is supported.
groupstring required read-onlygroup defines the group of the referenced resource.
namestring required read-onlyname defines the name of the referenced object.
namespacestring required read-onlynamespace defines the namespace of the referenced object.
resourcestring required read-onlyresource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).