← Back to index Esc
Kind
VMScrapeConfig
Group
operator.victoriametrics.com
Version
v1beta1
apiVersion: operator.victoriametrics.com/v1beta1 kind: VMScrapeConfig metadata: name: example
Tip: use .spec.authorization for path-only search
View raw schema
apiVersion string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata object
spec object
VMScrapeConfigSpec defines the desired state of VMScrapeConfig
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
azureSDConfigs []object
AzureSDConfigs defines a list of Azure service discovery configurations.
authenticationMethod string
# The authentication method, either OAuth or ManagedIdentity. See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
enum: OAuth, ManagedIdentity
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientID string
Optional client ID. Only required with the OAuth authentication method.
clientSecret object
Optional client secret. Only required with the OAuth authentication method.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
environment string
The Azure environment.
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
port integer
The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
format: int32
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
resourceGroup string
Optional resource group name. Limits discovery to this resource group.
subscriptionID string required
The subscription ID. Always required.
minLength: 1
tenantID string
Optional tenant ID. Only required with the OAuth authentication method.
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
basicAuth object
BasicAuth allow an endpoint to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenFile string
File to read bearer token for scraping targets.
bearerTokenSecret object
Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
consulSDConfigs []object
ConsulSDConfigs defines a list of Consul service discovery configurations.
allowStale boolean
Allow stale Consul results (see https://developer.hashicorp.com/consul/api-docs/features/consistency ). Will reduce load on Consul. If unset, use its default value.
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
datacenter string
Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter.
filter string
Filter defines filter for /v1/catalog/services requests See https://developer.hashicorp.com/consul/api-docs/features/filtering
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
namespace string
Namespaces are only supported in Consul Enterprise.
nodeMeta object
Node metadata key/value pairs to filter nodes for a given service.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
partition string
Admin Partitions are only supported in Consul Enterprise.
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
scheme string
HTTP Scheme default "http"
enum: HTTP, HTTPS
server string required
A valid string consisting of a hostname or IP followed by an optional port number.
minLength: 1
services []string
A list of services for which targets are retrieved. If omitted, all services are scraped.
tagSeparator string
The string by which Consul tags are joined into the tag label. If unset, use its default value.
tags []string
An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list.
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
tokenRef object
Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
digitalOceanSDConfigs []object
DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations.
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
port integer
The port to scrape metrics from.
format: int32
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
server string
Server is an optional DigitalOcean API server to query. By default, https://api.digitalocean.com is used.
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
dnsSDConfigs []object
DNSSDConfigs defines a list of DNS service discovery configurations.
names []string required
A list of DNS domain names to be queried.
minItems: 1
port integer
The port number used if the query type is not SRV Ignored for SRV records
format: int32
type string
enum: SRV, A, AAAA, MX
ec2SDConfigs []object
EC2SDConfigs defines a list of EC2 service discovery configurations.
accessKey object
AccessKey is the AWS API key.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
filters []object
Filters 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
name string required
values []string required
port integer
The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
format: int32
region string
The AWS region
roleARN string
AWS Role ARN, an alternative to using AWS API keys.
secretKey object
SecretKey is the AWS API secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
eurekaSDConfigs []object
EurekaSDConfigs defines a list of Eureka service discovery configurations.
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
server string
Server is an optional URL to connect to the Eureka server. By default, the http://localhost:8080/eureka/v2 is used.
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
fileSDConfigs []object
FileSDConfigs defines a list of file service discovery configurations.
files []string required
List of files to be used for file discovery.
minItems: 1
follow_redirects boolean
FollowRedirects controls redirects for scraping.
gceSDConfigs []object
GCESDConfigs defines a list of GCE service discovery configurations.
filter string
Filter 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
port integer
The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
format: int32
project string required
The Google Cloud Project ID
minLength: 1
tagSeparator string
The tag separator is used to separate the tags on concatenation
zone object required
The zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs.
hetznerSDConfigs []object
HetznerSDConfigs defines a list of Hetzner service discovery configurations.
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
port integer
Port is an optional port to scrape metrics from
format: int32
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
role string required
Role defines mandatory Hetzner role for entity discovery.
enum: robot, Robot, hcloud, Cloud
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
honorLabels boolean
HonorLabels chooses the metric's labels on collisions with target labels.
honorTimestamps boolean
HonorTimestamps controls whether vmagent or vmsingle respects the timestamps present in scraped data.
httpSDConfigs []object
HTTPSDConfigs defines a list of HTTP service discovery configurations.
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
url string required
URL from which the targets are fetched.
pattern: ^http(s)?://.+$
minLength: 1
interval string
Interval at which metrics should be scraped
kubernetesSDConfigs []object
KubernetesSDConfigs defines a list of Kubernetes service discovery configurations.
apiServer string
The API server address consisting of a hostname or IP address followed by an optional port number. If left empty, assuming process is running 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/.
attach_metadata object
AttachMetadata configures metadata attaching from service discovery
namespace boolean
Namespace instructs vmagent or vmsingle to add namespace specific metadata from service discovery Valid for roles: pod, service, endpoints, endpointslice, ingress.
node boolean
Node instructs vmagent or vmsingle to add node specific metadata from service discovery Valid for roles: pod, endpoints, endpointslice.
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
namespaces object
Optional namespace discovery. If omitted, discover targets across all namespaces.
names []string
List of namespaces where to watch for resources. If empty and `ownNamespace` isn't true, watch for resources in all namespaces.
ownNamespace boolean
Includes the namespace in which the pod exists to the list of watched namespaces.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
role string required
Role of the Kubernetes entities that should be discovered.
enum: node, pod, service, endpoints, endpointslice, ingress
selectors []object
Selector to select objects.
field string
label string
role string required
enum: node, pod, service, endpoints, endpointslice, ingress
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
kumaSDConfigs []object
KumaSDConfigs defines a list of Kuma service discovery configurations.
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientID string
ClientID is an optional client ID to send to Kuma Control Plane. The hostname of the server where vmagent runs is used if it isn't set. If the hostname is empty, then "vmagent" string is used as client_id.
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
server string required
Server must contain the URL of Kuma Control Plane's MADS xDS server.
minLength: 1
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
max_scrape_size string
MaxScrapeSize defines a maximum size of scraped data for a job
metricRelabelConfigs []object
MetricRelabelConfigs to apply to samples after scrapping.
action string
Action to perform based on regex matching. Default is 'replace'
if object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels object
Labels is used together with Match for `action: graphite`
match string
Match is used together with Labels for `action: graphite`
modulus integer
Modulus to take of the hash of the source label values.
format: int64
regex object
Regular expression against which the extracted value is matched. Default is '(.*)' victoriaMetrics supports multiline regex joined with | https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement string
Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
separator string
Separator placed between concatenated source label values. default is ';'.
sourceLabels []string
The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
source_labels []string
UnderScoreSourceLabels - additional form of source labels source_labels for compatibility with original relabel config. if set both sourceLabels and source_labels, sourceLabels has priority. for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel string
Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
target_label string
UnderScoreTargetLabel - additional form of target label - target_label for compatibility with original relabel config. if set both targetLabel and target_label, targetLabel has priority. for details https://github.com/VictoriaMetrics/operator/issues/131
nomadSDConfigs []object
NomadSDConfigs defines a list of Nomad service discovery configurations.
allowStale boolean
Allow stale Nomad results to reduce load on Nomad. If unset, use its default value.
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
namespace string
Namespace to use for Nomad service discovery.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
region string
Region to use for Nomad service discovery.
server string required
A valid string consisting of a hostname or IP followed by an optional port number.
minLength: 1
tagSeparator string
The string by which Nomad tags are joined into the tag label. If unset, use its default value.
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
openstackSDConfigs []object
OpenStackSDConfigs defines a list of OpenStack service discovery configurations.
allTenants boolean
Whether the service discovery should list all instances for all projects. It is only relevant for the 'instance' role and usually requires admin permissions.
applicationCredentialId string
ApplicationCredentialID
applicationCredentialName string
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.
applicationCredentialSecret object
The applicationCredentialSecret field is required if using an application credential to authenticate.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
availability string
Availability of the endpoint to connect to.
enum: Public, public, Admin, admin, Internal, internal
domainID string
DomainID
domainName string
At most one of domainId and domainName must be provided if using username with Identity V3. Otherwise, either are optional.
identityEndpoint string
IdentityEndpoint specifies the HTTP endpoint that is required to work with the Identity API of the appropriate version.
password object
Password for the Identity V2 and V3 APIs. Consult with your provider's control panel to discover your account's preferred method of authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
port integer
The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
format: int32
projectID string
ProjectID
projectName string
The ProjectId and ProjectName fields are optional 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.
region string required
The OpenStack Region.
minLength: 1
role string required
The OpenStack role of entities that should be discovered.
enum: Instance, instance, Hypervisor, hypervisor
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
userid string
UserID
username string
Username is 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 []object
OVHCloudSDConfigs defines a list of OVH Cloud service discovery configurations.
applicationKey string required
ApplicationKey defines a self generated token.
minLength: 1
applicationSecret object required
ApplicationSecret defines a generated secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
consumerKey object required
ConsumerKey holds user/app specific token
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpoint string
Endpoint defines OVH Cloud endpoint
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
service string required
Service could be either `vps` or `dedicated_server`
enum: vps, VPS, dedicated_server, DedicatedServer
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
params object
Optional HTTP URL parameters
path string
HTTP path to scrape for metrics.
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
puppetDBSDConfigs []object
PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations.
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
includeParameters boolean
IncludeParameters defines if parameters should be included as meta labels.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
port integer
Port defines port to scrape metrics from
format: int32
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
query string required
Query defines PQL query that allows to filter discovered resources.
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
url string required
URL of the PuppetDB root query endpoint
relabelConfigs []object
RelabelConfigs to apply to samples during service discovery.
action string
Action to perform based on regex matching. Default is 'replace'
if object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels object
Labels is used together with Match for `action: graphite`
match string
Match is used together with Labels for `action: graphite`
modulus integer
Modulus to take of the hash of the source label values.
format: int64
regex object
Regular expression against which the extracted value is matched. Default is '(.*)' victoriaMetrics supports multiline regex joined with | https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement string
Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
separator string
Separator placed between concatenated source label values. default is ';'.
sourceLabels []string
The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
source_labels []string
UnderScoreSourceLabels - additional form of source labels source_labels for compatibility with original relabel config. if set both sourceLabels and source_labels, sourceLabels has priority. for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel string
Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
target_label string
UnderScoreTargetLabel - additional form of target label - target_label for compatibility with original relabel config. if set both targetLabel and target_label, targetLabel has priority. for details https://github.com/VictoriaMetrics/operator/issues/131
sampleLimit integer
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
scheme string
HTTP scheme to use for scraping.
enum: http, https, HTTPS, HTTP
scrapeClass string
ScrapeClass defined scrape class to apply
scrapeTimeout string
Timeout after which the scrape is ended
scrape_interval string
ScrapeInterval is the same as Interval and has priority over it. one of scrape_interval or interval can be used
seriesLimit integer
SeriesLimit defines per-scrape limit on number of unique time series a single target can expose during all the scrapes on the time window of 24h.
staticConfigs []object
StaticConfigs defines a list of static targets with a common label set.
labels object
Labels assigned to all metrics scraped from the targets.
targets []string
List of targets for this static configuration.
tlsConfig object
TLSConfig configuration to use when scraping the endpoint
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
vm_scrape_params object
VMScrapeParams defines VictoriaMetrics specific scrape parameters
disable_compression boolean
DisableCompression
disable_keep_alive boolean
disable_keepalive allows disabling HTTP keep-alive when scraping targets. By default, HTTP keep-alive is enabled, so TCP connections to scrape targets could be reused. See https://docs.victoriametrics.com/victoriametrics/vmagent/#scrape_config-enhancements
headers []string
Headers allows sending custom headers to scrape targets must be in of semicolon separated header with it's value eg: headerName: headerValue vmagent and vmsingle support since 1.79.0 version
no_stale_markers boolean
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See feature description https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
scrape_align_interval string
scrape_offset string
stream_parse boolean
vultrSDConfigs []object
VultrSDConfigs defines a list of Vultr service discovery configurations.
authorization object
Authorization header to use on every scrape request.
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basicAuth object
BasicAuth information to use on every scrape request.
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
firewallGroupID string
FirewallGroupID is an optional query arguments to filter instances by firewall group id.
followRedirects boolean
Configure whether HTTP requests follow HTTP 3xx redirects.
hostname string
Hostname is an optional query arguments to filter instances by hostname.
label string
Label is an optional query arguments to filter instances by label.
mainIP string
MainIP is an optional query arguments to filter instances by main ip address.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
port integer
Port is an optional port to scrape metrics from.
format: int32
proxyURL string
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
proxy_client_config object
ProxyClientConfig configures proxy auth settings for scraping See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy)
authorization object
Authorization with http header Authorization
credentials object
Reference to the secret with value for authorization
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
credentialsFile string
File with value for authorization
type string
Type of authorization, default to bearer
basic_auth object
BasicAuth allows proxy to authenticate over basic authentication
password object
Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
password_file string
PasswordFile defines path to password file at disk must be pre-mounted
username object
Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token object
Secret to mount to read bearer token for scraping targets proxy auth. The secret needs to be in the same namespace as the scrape object and accessible by the victoria-metrics operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearer_token_file string
BearerTokenFile defines file to read bearer token from for proxy auth.
oauth2 object
OAuth2 defines auth configuration
client_id object required
The secret or configmap containing the OAuth2 client id
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret object
The secret containing the OAuth2 client secret
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
client_secret_file string
ClientSecretFile defines path for client secret file.
endpoint_params object
Parameters to append to the token URL
proxy_url string
The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
scopes []string
OAuth2 scopes used for the token request
tls_config object
TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family
token_url string required
The URL to fetch the token from
minLength: 1
tls_config object
TLSConfig configuration to use when scraping the endpoint
region string
Region is an optional query arguments to filter instances by region id.
tlsConfig object
TLS configuration to use on every scrape request
ca object
Struct containing the CA cert to use for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
caFile string
Path to the CA cert in the container to use for the targets.
cert object
Struct containing the client cert file for the targets.
configMap object
ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
certFile string
Path to the client cert file in the container for the targets.
insecureSkipVerify boolean
Disable target certificate validation.
keyFile string
Path to the client key file in the container for the targets.
keySecret object
Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
serverName string
Used to verify the hostname for the targets.
status object
ScrapeObjectStatus defines the observed state of ScrapeObjects
conditions []object
Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
lastTransitionTime string required
lastTransitionTime is the last time the condition transitioned from one status to another.
format: date-time
lastUpdateTime string required
LastUpdateTime is the last time of given type update. This value is used for status TTL update and removal
format: date-time
message string
message is a human readable message indicating details about the transition. This may be an empty string.
maxLength: 32768
observedGeneration integer
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
format: int64
minimum: 0
reason string required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
minLength: 1
maxLength: 1024
status string required
status of the condition, one of True, False, Unknown.
enum: True, False, Unknown
type string required
Type of condition in CamelCase or in name.namespace.resource.victoriametrics.com/CamelCase.
maxLength: 316
observedGeneration integer
ObservedGeneration defines current generation picked by operator for the reconcile
format: int64
reason string
Reason defines human readable error reason
updateStatus string
UpdateStatus defines a status for update rollout

No matches. Try .spec.authorization for an exact path

Copied!