diff --git a/docs/api.md b/docs/api.md
index 73862308a9..c067500e1b 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -26,114 +26,114 @@ tags:
Package v1 contains API Schema definitions for the operator v1 API group
### Resource Types
-- [VLAgent](#vlagent)
-- [VLCluster](#vlcluster)
-- [VLSingle](#vlsingle)
-- [VMAnomaly](#vmanomaly)
-- [VMAnomalyConfig](#vmanomalyconfig)
-- [VTCluster](#vtcluster)
-- [VTSingle](#vtsingle)
+- [VLAgent](#v1-vlagent)
+- [VLCluster](#v1-vlcluster)
+- [VLSingle](#v1-vlsingle)
+- [VMAnomaly](#v1-vmanomaly)
+- [VMAnomalyConfig](#v1-vmanomalyconfig)
+- [VTCluster](#v1-vtcluster)
+- [VTSingle](#v1-vtsingle)
-#### FieldsListString
+#### FieldsListString {#v1-fieldsliststring}
_Underlying type:_ _string_
FieldsListString represents list of json encoded strings
["field"] or ["field1","field2"]
-Appears in: [SyslogTCPListener](#syslogtcplistener), [SyslogUDPListener](#syslogudplistener)
+Appears in: [SyslogTCPListener (v1)](#v1-syslogtcplistener), [SyslogUDPListener (v1)](#v1-syslogudplistener)
-#### OAuth2
+#### OAuth2 {#v1-oauth2}
OAuth2 defines OAuth2 configuration parameters
with optional references to secrets with corresponding sensitive values
-Appears in: [VLAgentRemoteWriteSpec](#vlagentremotewritespec), [VLDistributedZoneRemoteWriteSpec](#vldistributedzoneremotewritespec)
+Appears in: [VLAgentRemoteWriteSpec (v1)](#v1-vlagentremotewritespec), [VLDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vldistributedzoneremotewritespec)
| Field | Description |
| --- | --- |
-| clientIDFile#
_string_ | _(Optional)_
ClientIDFile defines path to pre-mounted OAuth2 client id |
-| clientIDSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
ClientIDSecret defines secret or configmap containing the OAuth2 client id |
-| clientSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
The secret containing the OAuth2 client secret |
-| clientSecretFile#
_string_ | _(Optional)_
ClientSecretFile defines path to pre-mounted OAuth2 client secret |
-| endpointParams#
_object (keys:string, values:string)_ | _(Optional)_
EndpointParams to append to the token URL |
-| scopes#
_string array_ | _(Optional)_
Scopes used for the token request |
-| tokenURL#
_string_ | _(Required)_
TokenURL defines URL to fetch the token from |
+| clientIDFile#
_string_ | _(Optional)_
ClientIDFile defines path to pre-mounted OAuth2 client id |
+| clientIDSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
ClientIDSecret defines secret or configmap containing the OAuth2 client id |
+| clientSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
The secret containing the OAuth2 client secret |
+| clientSecretFile#
_string_ | _(Optional)_
ClientSecretFile defines path to pre-mounted OAuth2 client secret |
+| endpointParams#
_object (keys:string, values:string)_ | _(Optional)_
EndpointParams to append to the token URL |
+| scopes#
_string array_ | _(Optional)_
Scopes used for the token request |
+| tokenURL#
_string_ | _(Required)_
TokenURL defines URL to fetch the token from |
-#### SyslogServerSpec
+#### SyslogServerSpec {#v1-syslogserverspec}
SyslogServerSpec defines syslog servers configuration
-Appears in: [VLAgentSpec](#vlagentspec), [VLInsert](#vlinsert), [VLSingleSpec](#vlsinglespec)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec), [VLInsert (v1)](#v1-vlinsert), [VLSingleSpec (v1)](#v1-vlsinglespec)
| Field | Description |
| --- | --- |
-| tcpListeners#
_[SyslogTCPListener](#syslogtcplistener) array_ | _(Required)_
TCPListeners defines syslog server TCP listener configuration |
-| udpListeners#
_[SyslogUDPListener](#syslogudplistener) array_ | _(Required)_
UDPListeners defines syslog server UDP listener configuration |
+| tcpListeners#
_[SyslogTCPListener (v1)](#v1-syslogtcplistener) array_ | _(Required)_
TCPListeners defines syslog server TCP listener configuration |
+| udpListeners#
_[SyslogUDPListener (v1)](#v1-syslogudplistener) array_ | _(Required)_
UDPListeners defines syslog server UDP listener configuration |
-#### SyslogTCPListener
+#### SyslogTCPListener {#v1-syslogtcplistener}
SyslogTCPListener defines configuration for TCP syslog server listen
-Appears in: [SyslogServerSpec](#syslogserverspec)
+Appears in: [SyslogServerSpec (v1)](#v1-syslogserverspec)
| Field | Description |
| --- | --- |
-| compressMethod#
_string_ | _(Optional)_
CompressMethod for syslog messages
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#compression |
-| decolorizeFields#
_[FieldsListString](#fieldsliststring)_ | _(Optional)_
DecolorizeFields to remove ANSI color codes across logs
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#decolorizing-fields |
-| ignoreFields#
_[FieldsListString](#fieldsliststring)_ | _(Optional)_
IgnoreFields to ignore at logs
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#dropping-fields |
-| listenPort#
_integer_ | _(Required)_
ListenPort defines listen port |
-| streamFields#
_[FieldsListString](#fieldsliststring)_ | _(Optional)_
StreamFields to use as log stream labels
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#stream-fields |
-| tenantID#
_string_ | _(Optional)_
TenantID for logs ingested in form of accountID:projectID
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#multiple-configs |
-| tlsConfig#
_[TLSServerConfig](#tlsserverconfig)_ | _(Optional)_
|
+| compressMethod#
_string_ | _(Optional)_
CompressMethod for syslog messages
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#compression |
+| decolorizeFields#
_[FieldsListString (v1)](#v1-fieldsliststring)_ | _(Optional)_
DecolorizeFields to remove ANSI color codes across logs
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#decolorizing-fields |
+| ignoreFields#
_[FieldsListString (v1)](#v1-fieldsliststring)_ | _(Optional)_
IgnoreFields to ignore at logs
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#dropping-fields |
+| listenPort#
_integer_ | _(Required)_
ListenPort defines listen port |
+| streamFields#
_[FieldsListString (v1)](#v1-fieldsliststring)_ | _(Optional)_
StreamFields to use as log stream labels
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#stream-fields |
+| tenantID#
_string_ | _(Optional)_
TenantID for logs ingested in form of accountID:projectID
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#multiple-configs |
+| tlsConfig#
_[TLSServerConfig (v1)](#v1-tlsserverconfig)_ | _(Optional)_
|
-#### SyslogUDPListener
+#### SyslogUDPListener {#v1-syslogudplistener}
SyslogUDPListener defines configuration for UDP syslog server listen
-Appears in: [SyslogServerSpec](#syslogserverspec)
+Appears in: [SyslogServerSpec (v1)](#v1-syslogserverspec)
| Field | Description |
| --- | --- |
-| compressMethod#
_string_ | _(Optional)_
CompressMethod for syslog messages
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#compression |
-| decolorizeFields#
_[FieldsListString](#fieldsliststring)_ | _(Optional)_
DecolorizeFields to remove ANSI color codes across logs
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#decolorizing-fields |
-| ignoreFields#
_[FieldsListString](#fieldsliststring)_ | _(Optional)_
IgnoreFields to ignore at logs
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#dropping-fields |
-| listenPort#
_integer_ | _(Required)_
ListenPort defines listen port |
-| streamFields#
_[FieldsListString](#fieldsliststring)_ | _(Optional)_
StreamFields to use as log stream labels
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#stream-fields |
-| tenantID#
_string_ | _(Optional)_
TenantID for logs ingested in form of accountID:projectID
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#multiple-configs |
+| compressMethod#
_string_ | _(Optional)_
CompressMethod for syslog messages
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#compression |
+| decolorizeFields#
_[FieldsListString (v1)](#v1-fieldsliststring)_ | _(Optional)_
DecolorizeFields to remove ANSI color codes across logs
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#decolorizing-fields |
+| ignoreFields#
_[FieldsListString (v1)](#v1-fieldsliststring)_ | _(Optional)_
IgnoreFields to ignore at logs
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#dropping-fields |
+| listenPort#
_integer_ | _(Required)_
ListenPort defines listen port |
+| streamFields#
_[FieldsListString (v1)](#v1-fieldsliststring)_ | _(Optional)_
StreamFields to use as log stream labels
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#stream-fields |
+| tenantID#
_string_ | _(Optional)_
TenantID for logs ingested in form of accountID:projectID
see https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/#multiple-configs |
-#### TLSConfig
+#### TLSConfig {#v1-tlsconfig}
TLSConfig specifies TLS configuration parameters
with optional references to secrets with corresponding sensitive values
-Appears in: [VLAgentRemoteWriteSpec](#vlagentremotewritespec), [VLDistributedZoneRemoteWriteSpec](#vldistributedzoneremotewritespec)
+Appears in: [VLAgentRemoteWriteSpec (v1)](#v1-vlagentremotewritespec), [VLDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vldistributedzoneremotewritespec)
| Field | Description |
| --- | --- |
-| caFile#
_string_ | _(Optional)_
CAFile defines path to the pre-mounted file with TLS ca certificate |
-| caSecretKeyRef#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
CASecret defines secret reference with tls CA key by given key |
-| certFile#
_string_ | _(Optional)_
CertFile defines path to the pre-mounted file with TLS certificate
mutually exclusive with CertSecret |
-| certSecretKeyRef#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
CertSecret defines secret reference with TLS cert by given key
mutually exclusive with CASecret |
-| insecureSkipVerify#
_boolean_ | _(Optional)_
Disable target certificate validation. |
-| keyFile#
_string_ | _(Optional)_
KeyFile defines path to the pre-mounted file with TLS cert key
mutually exclusive with CertSecret |
-| keySecretKeyRef#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
CertSecret defines secret reference with TLS key by given key |
-| serverName#
_string_ | _(Optional)_
Used to verify the hostname for the targets. |
+| caFile#
_string_ | _(Optional)_
CAFile defines path to the pre-mounted file with TLS ca certificate |
+| caSecretKeyRef#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
CASecret defines secret reference with tls CA key by given key |
+| certFile#
_string_ | _(Optional)_
CertFile defines path to the pre-mounted file with TLS certificate
mutually exclusive with CertSecret |
+| certSecretKeyRef#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
CertSecret defines secret reference with TLS cert by given key
mutually exclusive with CASecret |
+| insecureSkipVerify#
_boolean_ | _(Optional)_
Disable target certificate validation. |
+| keyFile#
_string_ | _(Optional)_
KeyFile defines path to the pre-mounted file with TLS cert key
mutually exclusive with CertSecret |
+| keySecretKeyRef#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
CertSecret defines secret reference with TLS key by given key |
+| serverName#
_string_ | _(Optional)_
Used to verify the hostname for the targets. |
-#### TLSServerConfig
+#### TLSServerConfig {#v1-tlsserverconfig}
TLSServerConfig defines VictoriaMetrics TLS configuration for the application's server
-Appears in: [SyslogTCPListener](#syslogtcplistener)
+Appears in: [SyslogTCPListener (v1)](#v1-syslogtcplistener)
| Field | Description |
| --- | --- |
-| certFile#
_string_ | _(Optional)_
CertFile defines path to the pre-mounted file with certificate
mutually exclusive with CertSecret |
-| certSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
CertSecretRef defines reference for secret with certificate content under given key
mutually exclusive with CertFile |
-| keyFile#
_string_ | _(Optional)_
KeyFile defines path to the pre-mounted file with certificate key
mutually exclusive with KeySecretRef |
-| keySecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Key defines reference for secret with certificate key content under given key
mutually exclusive with KeyFile |
+| certFile#
_string_ | _(Optional)_
CertFile defines path to the pre-mounted file with certificate
mutually exclusive with CertSecret |
+| certSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
CertSecretRef defines reference for secret with certificate content under given key
mutually exclusive with CertFile |
+| keyFile#
_string_ | _(Optional)_
KeyFile defines path to the pre-mounted file with certificate key
mutually exclusive with KeySecretRef |
+| keySecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Key defines reference for secret with certificate key content under given key
mutually exclusive with KeyFile |
-#### VLAgent
+#### VLAgent {#v1-vlagent}
VLAgent - is a tiny but brave agent, which helps you collect logs from various sources and stores them in VictoriaLogs.
@@ -141,138 +141,138 @@ VLAgent - is a tiny but brave agent, which helps you collect logs from various s
| --- | --- |
| apiVersion
_string_ | (Required)
`operator.victoriametrics.com/v1` |
| kind
_string_ | (Required)
`VLAgent` |
-| metadata#
_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[VLAgentSpec](#vlagentspec)_ | _(Required)_
|
+| metadata#
_[ObjectMeta (v1)](#v1-objectmeta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[VLAgentSpec (v1)](#v1-vlagentspec)_ | _(Required)_
|
-#### VLAgentK8sCollector
+#### VLAgentK8sCollector {#v1-vlagentk8scollector}
-Appears in: [VLAgentSpec](#vlagentspec)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec)
| Field | Description |
| --- | --- |
-| checkpointsPath#
_string_ | _(Required)_
CheckpointsPath configures path to file where logs checkpoints are stored.
By default it's stored at host's /var/lib/vlagent-data/checkpoints.json. |
-| decolorizeFields#
_string array_ | _(Required)_
DecolorizeFields defines fields to remove ANSI color codes across logs ingested from Kubernetes |
-| enabled#
_boolean_ | _(Required)_
Enabled switches VLAgent to log collection mode.
Note, for this purpose operator uses DaemonSet, while by default VLAgent uses StatefulSet.
Switching this option will drop all persisted data. |
-| excludeFilter#
_string_ | _(Required)_
ExcludeFilter defines logsql expression that allows to filter out containers to collect logs from |
-| extraFields
_string_ | _(Required)_
ExtraFields defines extra fields as JSON string which should be added to each collected log line
Example: '\{"env":"dev","cluster":"staging"\}' |
-| ignoreFields#
_string array_ | _(Required)_
IgnoreFields defines fields to ignore across logs ingested from Kubernetes |
-| includeNodeAnnotations#
_boolean_ | _(Required)_
IncludeNodeAnnotations enables attachment of node annotations to log entries |
-| includeNodeLabels#
_boolean_ | _(Required)_
IncludeNodeLabels enables attachment of node labels to log entries |
-| includePodAnnotations#
_boolean_ | _(Required)_
IncludePodAnnotations enables attachment of pod annotations to log entries |
-| includePodLabels#
_boolean_ | _(Required)_
IncludePodLabels enables attachment of pod labels to log entries |
-| logsPath#
_string_ | _(Required)_
LogsPath configures root for logs path
By default VLAgent collects logs from /var/log/containers |
-| msgFields#
_string array_ | _(Required)_
MsgField defines fields that may contain the _msg field |
-| streamFields#
_string array_ | _(Required)_
StreamFields defines list of fields to use as log stream fields for logs ingested from Kubernetes Pods |
-| tenantID#
_string_ | _(Required)_
TenantID defines default tenant ID to use for logs collected from pods in format: : |
-| timeFields#
_string array_ | _(Required)_
TimeFields defines fields that may contain the _time field |
+| checkpointsPath#
_string_ | _(Required)_
CheckpointsPath configures path to file where logs checkpoints are stored.
By default it's stored at host's /var/lib/vlagent-data/checkpoints.json. |
+| decolorizeFields#
_string array_ | _(Required)_
DecolorizeFields defines fields to remove ANSI color codes across logs ingested from Kubernetes |
+| enabled#
_boolean_ | _(Required)_
Enabled switches VLAgent to log collection mode.
Note, for this purpose operator uses DaemonSet, while by default VLAgent uses StatefulSet.
Switching this option will drop all persisted data. |
+| excludeFilter#
_string_ | _(Required)_
ExcludeFilter defines logsql expression that allows to filter out containers to collect logs from |
+| extraFields
_string_ | _(Required)_
ExtraFields defines extra fields as JSON string which should be added to each collected log line
Example: '\{"env":"dev","cluster":"staging"\}' |
+| ignoreFields#
_string array_ | _(Required)_
IgnoreFields defines fields to ignore across logs ingested from Kubernetes |
+| includeNodeAnnotations#
_boolean_ | _(Required)_
IncludeNodeAnnotations enables attachment of node annotations to log entries |
+| includeNodeLabels#
_boolean_ | _(Required)_
IncludeNodeLabels enables attachment of node labels to log entries |
+| includePodAnnotations#
_boolean_ | _(Required)_
IncludePodAnnotations enables attachment of pod annotations to log entries |
+| includePodLabels#
_boolean_ | _(Required)_
IncludePodLabels enables attachment of pod labels to log entries |
+| logsPath#
_string_ | _(Required)_
LogsPath configures root for logs path
By default VLAgent collects logs from /var/log/containers |
+| msgFields#
_string array_ | _(Required)_
MsgField defines fields that may contain the _msg field |
+| streamFields#
_string array_ | _(Required)_
StreamFields defines list of fields to use as log stream fields for logs ingested from Kubernetes Pods |
+| tenantID#
_string_ | _(Required)_
TenantID defines default tenant ID to use for logs collected from pods in format: : |
+| timeFields#
_string array_ | _(Required)_
TimeFields defines fields that may contain the _time field |
-#### VLAgentRemoteWriteSettings
+#### VLAgentRemoteWriteSettings {#v1-vlagentremotewritesettings}
VLAgentRemoteWriteSettings - defines global settings for all remoteWrite urls.
-Appears in: [VLAgentSpec](#vlagentspec), [VLDistributedZoneAgentSpec](#vldistributedzoneagentspec)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec), [VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec)
| Field | Description |
| --- | --- |
-| flushInterval#
_string_ | _(Optional)_
Interval for flushing the data to remote storage. (default 1s) |
-| maxBlockSize#
_[BytesString](#bytesstring)_ | _(Optional)_
The maximum size of unpacked request to send to remote storage |
-| maxDiskUsagePerURL#
_[BytesString](#bytesstring)_ | _(Optional)_
The maximum file-based buffer size in bytes at -remoteWrite.tmpDataPath |
-| queues#
_integer_ | _(Optional)_
The number of concurrent queues |
-| showURL#
_boolean_ | _(Optional)_
Whether to show -remoteWrite.url in the exported metrics. It is hidden by default, since it can contain sensitive auth info |
-| tmpDataPath#
_string_ | _(Optional)_
Path to directory where temporary data for remote write component is stored.
Defaults to /vlagent-data/vlagent-remotewrite-data or /var/lib/vlagent-data/vlagent-remotewrite-data in collector mode |
+| flushInterval#
_string_ | _(Optional)_
Interval for flushing the data to remote storage. (default 1s) |
+| maxBlockSize#
_[BytesString (v1beta1)](#v1beta1-bytesstring)_ | _(Optional)_
The maximum size of unpacked request to send to remote storage |
+| maxDiskUsagePerURL#
_[BytesString (v1beta1)](#v1beta1-bytesstring)_ | _(Optional)_
The maximum file-based buffer size in bytes at -remoteWrite.tmpDataPath |
+| queues#
_integer_ | _(Optional)_
The number of concurrent queues |
+| showURL#
_boolean_ | _(Optional)_
Whether to show -remoteWrite.url in the exported metrics. It is hidden by default, since it can contain sensitive auth info |
+| tmpDataPath#
_string_ | _(Optional)_
Path to directory where temporary data for remote write component is stored.
Defaults to /vlagent-data/vlagent-remotewrite-data or /var/lib/vlagent-data/vlagent-remotewrite-data in collector mode |
-#### VLAgentRemoteWriteSpec
+#### VLAgentRemoteWriteSpec {#v1-vlagentremotewritespec}
VLAgentRemoteWriteSpec defines the remote storage configuration for VmAgent
-Appears in: [VLAgentSpec](#vlagentspec)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec)
| Field | Description |
| --- | --- |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication.
Available starting vlagent v1.52.0.
Available from: v0.74.0 |
-| bearerTokenPath#
_string_ | _(Optional)_
Optional bearer auth token to use for -remoteWrite.url |
-| bearerTokenSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Optional bearer auth token to use for -remoteWrite.url |
-| headers
_string array_ | _(Optional)_
Headers allow configuring custom http headers
Must be in form of semicolon separated header with value
e.g.
headerName: headerValue |
-| maxDiskUsage#
_[BytesString](#bytesstring)_ | _(Optional)_
MaxDiskUsage defines the maximum file-based buffer size in bytes for the given remoteWrite
It overrides global configuration defined at remoteWriteSettings.maxDiskUsagePerURL |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL for -remoteWrite.url. Supported proxies: http, https, socks5. Example: socks5://proxy:1234 |
-| sendTimeout#
_string_ | _(Optional)_
Timeout for sending a single block of data to -remoteWrite.url (default 1m0s) |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig describes tls configuration for remote write target |
-| url#
_string_ | _(Required)_
URL of the endpoint to send samples to. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication.
Available starting vlagent v1.52.0.
Available from: v0.74.0 |
+| bearerTokenPath#
_string_ | _(Optional)_
Optional bearer auth token to use for -remoteWrite.url |
+| bearerTokenSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Optional bearer auth token to use for -remoteWrite.url |
+| headers
_string array_ | _(Optional)_
Headers allow configuring custom http headers
Must be in form of semicolon separated header with value
e.g.
headerName: headerValue |
+| maxDiskUsage#
_[BytesString (v1beta1)](#v1beta1-bytesstring)_ | _(Optional)_
MaxDiskUsage defines the maximum file-based buffer size in bytes for the given remoteWrite
It overrides global configuration defined at remoteWriteSettings.maxDiskUsagePerURL |
+| oauth2#
_[OAuth2 (v1)](#v1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL for -remoteWrite.url. Supported proxies: http, https, socks5. Example: socks5://proxy:1234 |
+| sendTimeout#
_string_ | _(Optional)_
Timeout for sending a single block of data to -remoteWrite.url (default 1m0s) |
+| tlsConfig#
_[TLSConfig (v1)](#v1-tlsconfig)_ | _(Optional)_
TLSConfig describes tls configuration for remote write target |
+| url#
_string_ | _(Required)_
URL of the endpoint to send samples to. |
-#### VLAgentSpec
+#### VLAgentSpec {#v1-vlagentspec}
VLAgentSpec defines the desired state of VLAgent
-Appears in: [VLAgent](#vlagent)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| claimTemplates#
_[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaim-v1-core) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for VLAgent in Mode: StatefulSet |
-| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| k8sCollector#
_[VLAgentK8sCollector](#vlagentk8scollector)_ | _(Required)_
K8sCollector configures VLAgent logs collection from K8s pods |
-| license#
_[License](#license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/#victorialogs-enterprise-features) |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VLAgent to be configured with. |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VLAgent to be configured with.
INFO, WARN, ERROR, FATAL, PANIC |
-| managedMetadata#
_[ManagedObjectsMetadata](#managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| networkPolicy#
_[EmbeddedNetworkPolicy](#embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetpersistentvolumeclaimretentionpolicy-v1-apps)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
-| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec](#embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the vlagent pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| remoteWrite#
_[VLAgentRemoteWriteSpec](#vlagentremotewritespec) array_ | _(Required)_
RemoteWrite list of victoria logs endpoints
for victorialogs it must looks like: http://victoria-logs-single:9428/
or for cluster different url
https://docs.victoriametrics.com/victorialogs/vlagent/#replication-and-high-availability |
-| remoteWriteSettings#
_[VLAgentRemoteWriteSettings](#vlagentremotewritesettings)_ | _(Optional)_
RemoteWriteSettings defines global settings for all remoteWrite urls. |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| rollingUpdateStrategy#
_[StatefulSetUpdateStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetupdatestrategytype-v1-apps)_ | _(Optional)_
RollingUpdateStrategy allows configuration for strategyType
set it to RollingUpdate for disabling operator statefulSet rollingUpdate |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
-| serviceScrapeSpec#
_[VMServiceScrapeSpec](#vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vlagent VMServiceScrape spec |
-| serviceSpec#
_[AdditionalServiceSpec](#additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vlagent service spec |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| storage#
_[StorageSpec](#storagespec)_ | _(Optional)_
Storage configures storage for StatefulSet |
-| syslogSpec#
_[SyslogServerSpec](#syslogserverspec)_ | _(Optional)_
SyslogSpec defines syslog listener configuration |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tmpDataPath#
_string_ | _(Optional)_
Path to directory where temporary data for vlagent stored
Defaults to /vlagent-data or /var/lib/vlagent-data in collector mode
If defined, operator ignores spec.storage field and skips adding volume and volumeMount for tmp data |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming uses standalone Helm chart naming for managed resources:
the CR name is used directly instead of the default "-" convention.
Available from: v0.73.0 |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
-
-#### VLCluster
+Appears in: [VLAgent (v1)](#v1-vlagent)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| claimTemplates#
_[PersistentVolumeClaim (v1)](#v1-persistentvolumeclaim) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for VLAgent in Mode: StatefulSet |
+| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| k8sCollector#
_[VLAgentK8sCollector (v1)](#v1-vlagentk8scollector)_ | _(Required)_
K8sCollector configures VLAgent logs collection from K8s pods |
+| license#
_[License (v1beta1)](#v1beta1-license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/#victorialogs-enterprise-features) |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VLAgent to be configured with. |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VLAgent to be configured with.
INFO, WARN, ERROR, FATAL, PANIC |
+| managedMetadata#
_[ManagedObjectsMetadata (v1beta1)](#v1beta1-managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| networkPolicy#
_[EmbeddedNetworkPolicy (v1beta1)](#v1beta1-embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy (v1)](#v1-statefulsetpersistentvolumeclaimretentionpolicy)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
+| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec (v1beta1)](#v1beta1-embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the vlagent pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| remoteWrite#
_[VLAgentRemoteWriteSpec (v1)](#v1-vlagentremotewritespec) array_ | _(Required)_
RemoteWrite list of victoria logs endpoints
for victorialogs it must looks like: http://victoria-logs-single:9428/
or for cluster different url
https://docs.victoriametrics.com/victorialogs/vlagent/#replication-and-high-availability |
+| remoteWriteSettings#
_[VLAgentRemoteWriteSettings (v1)](#v1-vlagentremotewritesettings)_ | _(Optional)_
RemoteWriteSettings defines global settings for all remoteWrite urls. |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| rollingUpdateStrategy#
_[StatefulSetUpdateStrategyType (v1)](#v1-statefulsetupdatestrategytype)_ | _(Optional)_
RollingUpdateStrategy allows configuration for strategyType
set it to RollingUpdate for disabling operator statefulSet rollingUpdate |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
+| serviceScrapeSpec#
_[VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vlagent VMServiceScrape spec |
+| serviceSpec#
_[AdditionalServiceSpec (v1beta1)](#v1beta1-additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vlagent service spec |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| storage#
_[StorageSpec (v1beta1)](#v1beta1-storagespec)_ | _(Optional)_
Storage configures storage for StatefulSet |
+| syslogSpec#
_[SyslogServerSpec (v1)](#v1-syslogserverspec)_ | _(Optional)_
SyslogSpec defines syslog listener configuration |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tmpDataPath#
_string_ | _(Optional)_
Path to directory where temporary data for vlagent stored
Defaults to /vlagent-data or /var/lib/vlagent-data in collector mode
If defined, operator ignores spec.storage field and skips adding volume and volumeMount for tmp data |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming uses standalone Helm chart naming for managed resources:
the CR name is used directly instead of the default "-" convention.
Available from: v0.73.0 |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
+
+#### VLCluster {#v1-vlcluster}
VLCluster is fast, cost-effective and scalable logs database.
@@ -280,158 +280,158 @@ VLCluster is fast, cost-effective and scalable logs database.
| --- | --- |
| apiVersion
_string_ | (Required)
`operator.victoriametrics.com/v1` |
| kind
_string_ | (Required)
`VLCluster` |
-| metadata#
_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[VLClusterSpec](#vlclusterspec)_ | _(Required)_
|
+| metadata#
_[ObjectMeta (v1)](#v1-objectmeta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[VLClusterSpec (v1)](#v1-vlclusterspec)_ | _(Required)_
|
-#### VLClusterSpec
+#### VLClusterSpec {#v1-vlclusterspec}
VLClusterSpec defines the desired state of VLCluster
-Appears in: [VLCluster](#vlcluster), [VLDistributedZoneCluster](#vldistributedzonecluster)
+Appears in: [VLCluster (v1)](#v1-vlcluster), [VLDistributedZoneCluster (v1alpha1)](#v1alpha1-vldistributedzonecluster)
| Field | Description |
| --- | --- |
-| clusterDomainName#
_string_ | _(Optional)_
ClusterDomainName defines domain name suffix for in-cluster dns addresses
aka .cluster.local
used by vlinsert and vlselect to build vlstorage address |
-| clusterVersion#
_string_ | _(Optional)_
ClusterVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| license#
_[License](#license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/#victorialogs-enterprise-features) |
-| managedMetadata#
_[ManagedObjectsMetadata](#managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| requestsLoadBalancer#
_[VMAuthLoadBalancer](#vmauthloadbalancer)_ | _(Required)_
RequestsLoadBalancer configures load-balancing for vlinsert and vlselect requests.
It helps to evenly spread load across pods.
Usually it's not possible with Kubernetes TCP-based services. |
-| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the
VLSelect, VLInsert and VLStorage Pods. |
-| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming switches component resource naming from the default prefix convention
(-, e.g. "vlselect-myapp") to a suffix convention (-,
e.g. "myapp-vlselect"). Useful when migrating from standalone Helm charts.
Available from: v0.73.0 |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| vlinsert#
_[VLInsert](#vlinsert)_ | _(Required)_
|
-| vlselect#
_[VLSelect](#vlselect)_ | _(Required)_
|
-| vlstorage#
_[VLStorage](#vlstorage)_ | _(Required)_
|
+| clusterDomainName#
_string_ | _(Optional)_
ClusterDomainName defines domain name suffix for in-cluster dns addresses
aka .cluster.local
used by vlinsert and vlselect to build vlstorage address |
+| clusterVersion#
_string_ | _(Optional)_
ClusterVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| license#
_[License (v1beta1)](#v1beta1-license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/#victorialogs-enterprise-features) |
+| managedMetadata#
_[ManagedObjectsMetadata (v1beta1)](#v1beta1-managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| requestsLoadBalancer#
_[VMAuthLoadBalancer (v1beta1)](#v1beta1-vmauthloadbalancer)_ | _(Required)_
RequestsLoadBalancer configures load-balancing for vlinsert and vlselect requests.
It helps to evenly spread load across pods.
Usually it's not possible with Kubernetes TCP-based services. |
+| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the
VLSelect, VLInsert and VLStorage Pods. |
+| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming switches component resource naming from the default prefix convention
(-, e.g. "vlselect-myapp") to a suffix convention (-,
e.g. "myapp-vlselect"). Useful when migrating from standalone Helm charts.
Available from: v0.73.0 |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| vlinsert#
_[VLInsert (v1)](#v1-vlinsert)_ | _(Required)_
|
+| vlselect#
_[VLSelect (v1)](#v1-vlselect)_ | _(Required)_
|
+| vlstorage#
_[VLStorage (v1)](#v1-vlstorage)_ | _(Required)_
|
-#### VLInsert
+#### VLInsert {#v1-vlinsert}
VLInsert defines vlinsert component configuration at victoria-logs cluster
-Appears in: [VLClusterSpec](#vlclusterspec)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| hpa#
_[EmbeddedHPA](#embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling. |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VLSelect to be configured with.
default or json |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VLSelect to be configured with. |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| networkPolicy#
_[EmbeddedNetworkPolicy](#embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec](#embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VLSelect pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| rollingUpdate#
_[RollingUpdateDeployment](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#rollingupdatedeployment-v1-apps)_ | _(Optional)_
RollingUpdate - overrides deployment update params. |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceScrapeSpec#
_[VMServiceScrapeSpec](#vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vlselect VMServiceScrape spec |
-| serviceSpec#
_[AdditionalServiceSpec](#additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vlselect service spec |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| syslogSpec#
_[SyslogServerSpec](#syslogserverspec)_ | _(Optional)_
SyslogSpec defines syslog listener configuration |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| updateStrategy#
_[DeploymentStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#deploymentstrategytype-v1-apps)_ | _(Optional)_
UpdateStrategy - overrides default update strategy. |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
-
-#### VLSelect
+Appears in: [VLClusterSpec (v1)](#v1-vlclusterspec)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| hpa#
_[EmbeddedHPA (v1beta1)](#v1beta1-embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling. |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VLSelect to be configured with.
default or json |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VLSelect to be configured with. |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| networkPolicy#
_[EmbeddedNetworkPolicy (v1beta1)](#v1beta1-embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec (v1beta1)](#v1beta1-embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VLSelect pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| rollingUpdate#
_[RollingUpdateDeployment (v1)](#v1-rollingupdatedeployment)_ | _(Optional)_
RollingUpdate - overrides deployment update params. |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceScrapeSpec#
_[VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vlselect VMServiceScrape spec |
+| serviceSpec#
_[AdditionalServiceSpec (v1beta1)](#v1beta1-additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vlselect service spec |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| syslogSpec#
_[SyslogServerSpec (v1)](#v1-syslogserverspec)_ | _(Optional)_
SyslogSpec defines syslog listener configuration |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| updateStrategy#
_[DeploymentStrategyType (v1)](#v1-deploymentstrategytype)_ | _(Optional)_
UpdateStrategy - overrides default update strategy. |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
+
+#### VLSelect {#v1-vlselect}
VLSelect defines vlselect component configuration at victoria-logs cluster
-Appears in: [VLClusterSpec](#vlclusterspec)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| extraStorageNodes
_[VLStorageNode](#vlstoragenode) array_ | _(Required)_
ExtraStorageNodes - defines additional storage nodes to VLSelect |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| hpa#
_[EmbeddedHPA](#embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling. |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VLSelect to be configured with.
default or json |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VLSelect to be configured with. |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| networkPolicy#
_[EmbeddedNetworkPolicy](#embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec](#embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VLSelect pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| rollingUpdate#
_[RollingUpdateDeployment](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#rollingupdatedeployment-v1-apps)_ | _(Optional)_
RollingUpdate - overrides deployment update params. |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceScrapeSpec#
_[VMServiceScrapeSpec](#vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vlselect VMServiceScrape spec |
-| serviceSpec#
_[AdditionalServiceSpec](#additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vlselect service spec |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| updateStrategy#
_[DeploymentStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#deploymentstrategytype-v1-apps)_ | _(Optional)_
UpdateStrategy - overrides default update strategy. |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
-
-#### VLSingle
+Appears in: [VLClusterSpec (v1)](#v1-vlclusterspec)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| extraStorageNodes
_[VLStorageNode (v1)](#v1-vlstoragenode) array_ | _(Required)_
ExtraStorageNodes - defines additional storage nodes to VLSelect |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| hpa#
_[EmbeddedHPA (v1beta1)](#v1beta1-embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling. |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VLSelect to be configured with.
default or json |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VLSelect to be configured with. |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| networkPolicy#
_[EmbeddedNetworkPolicy (v1beta1)](#v1beta1-embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec (v1beta1)](#v1beta1-embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VLSelect pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| rollingUpdate#
_[RollingUpdateDeployment (v1)](#v1-rollingupdatedeployment)_ | _(Optional)_
RollingUpdate - overrides deployment update params. |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceScrapeSpec#
_[VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vlselect VMServiceScrape spec |
+| serviceSpec#
_[AdditionalServiceSpec (v1beta1)](#v1beta1-additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vlselect service spec |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| updateStrategy#
_[DeploymentStrategyType (v1)](#v1-deploymentstrategytype)_ | _(Optional)_
UpdateStrategy - overrides default update strategy. |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
+
+#### VLSingle {#v1-vlsingle}
VLSingle is fast, cost-effective and scalable logs database.
VLSingle is the Schema for the API
@@ -440,164 +440,164 @@ VLSingle is the Schema for the API
| --- | --- |
| apiVersion
_string_ | (Required)
`operator.victoriametrics.com/v1` |
| kind
_string_ | (Required)
`VLSingle` |
-| metadata#
_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[VLSingleSpec](#vlsinglespec)_ | _(Required)_
|
+| metadata#
_[ObjectMeta (v1)](#v1-objectmeta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[VLSingleSpec (v1)](#v1-vlsinglespec)_ | _(Required)_
|
-#### VLSingleSpec
+#### VLSingleSpec {#v1-vlsinglespec}
VLSingleSpec defines the desired state of VLSingle
-Appears in: [VLDistributedZoneSingle](#vldistributedzonesingle), [VLSingle](#vlsingle)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| futureRetention#
_string_ | _(Optional)_
FutureRetention for the stored logs
Log entries with timestamps bigger than now+futureRetention are rejected during data ingestion; see https://docs.victoriametrics.com/victorialogs/#retention |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| license#
_[License](#license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/#victorialogs-enterprise-features) |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VLSingle to be configured with. |
-| logIngestedRows#
_boolean_ | _(Required)_
Whether to log all the ingested log entries; this can be useful for debugging of data ingestion; see https://docs.victoriametrics.com/victorialogs/data-ingestion/ |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VictoriaLogs to be configured with. |
-| logNewStreams#
_boolean_ | _(Required)_
LogNewStreams Whether to log creation of new streams; this can be useful for debugging of high cardinality issues with log streams; see https://docs.victoriametrics.com/victorialogs/keyconcepts/#stream-fields |
-| managedMetadata#
_[ManagedObjectsMetadata](#managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| networkPolicy#
_[EmbeddedNetworkPolicy](#embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the VLSingle pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| retentionMaxDiskSpaceUsageBytes#
_[BytesString](#bytesstring)_ | _(Optional)_
RetentionMaxDiskSpaceUsageBytes for the stored logs
VictoriaLogs keeps at least two last days of data in order to guarantee that the logs for the last day can be returned in queries.
This means that the total disk space usage may exceed the -retention.maxDiskSpaceUsageBytes,
if the size of the last two days of data exceeds the -retention.maxDiskSpaceUsageBytes.
https://docs.victoriametrics.com/victorialogs/#retention-by-disk-space-usage |
-| retentionPeriod#
_string_ | _(Optional)_
RetentionPeriod for the stored logs
https://docs.victoriametrics.com/victorialogs/#retention |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
-| serviceScrapeSpec#
_[VMServiceScrapeSpec](#vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vlsingle VMServiceScrape spec |
-| serviceSpec#
_[AdditionalServiceSpec](#additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vlsingle service spec |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| storage#
_[PersistentVolumeClaimSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaimspec-v1-core)_ | _(Optional)_
Storage is the definition of how storage will be used by the VLSingle
by default it`s empty dir |
-| storageDataPath#
_string_ | _(Optional)_
StorageDataPath disables spec.storage option and overrides arg for victoria-logs binary --storageDataPath,
its users responsibility to mount proper device into given path. |
-| storageMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Optional)_
StorageMeta defines annotations and labels attached to PVC for given vlsingle CR |
-| syslogSpec#
_[SyslogServerSpec](#syslogserverspec)_ | _(Optional)_
SyslogSpec defines syslog listener configuration |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming uses standalone Helm chart naming for managed resources:
the CR name is used directly instead of the default "-" convention.
Available from: v0.73.0 |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
-
-#### VLStorage
+Appears in: [VLDistributedZoneSingle (v1alpha1)](#v1alpha1-vldistributedzonesingle), [VLSingle (v1)](#v1-vlsingle)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| futureRetention#
_string_ | _(Optional)_
FutureRetention for the stored logs
Log entries with timestamps bigger than now+futureRetention are rejected during data ingestion; see https://docs.victoriametrics.com/victorialogs/#retention |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| license#
_[License (v1beta1)](#v1beta1-license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/#victorialogs-enterprise-features) |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VLSingle to be configured with. |
+| logIngestedRows#
_boolean_ | _(Required)_
Whether to log all the ingested log entries; this can be useful for debugging of data ingestion; see https://docs.victoriametrics.com/victorialogs/data-ingestion/ |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VictoriaLogs to be configured with. |
+| logNewStreams#
_boolean_ | _(Required)_
LogNewStreams Whether to log creation of new streams; this can be useful for debugging of high cardinality issues with log streams; see https://docs.victoriametrics.com/victorialogs/keyconcepts/#stream-fields |
+| managedMetadata#
_[ManagedObjectsMetadata (v1beta1)](#v1beta1-managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| networkPolicy#
_[EmbeddedNetworkPolicy (v1beta1)](#v1beta1-embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the VLSingle pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| retentionMaxDiskSpaceUsageBytes#
_[BytesString (v1beta1)](#v1beta1-bytesstring)_ | _(Optional)_
RetentionMaxDiskSpaceUsageBytes for the stored logs
VictoriaLogs keeps at least two last days of data in order to guarantee that the logs for the last day can be returned in queries.
This means that the total disk space usage may exceed the -retention.maxDiskSpaceUsageBytes,
if the size of the last two days of data exceeds the -retention.maxDiskSpaceUsageBytes.
https://docs.victoriametrics.com/victorialogs/#retention-by-disk-space-usage |
+| retentionPeriod#
_string_ | _(Optional)_
RetentionPeriod for the stored logs
https://docs.victoriametrics.com/victorialogs/#retention |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
+| serviceScrapeSpec#
_[VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vlsingle VMServiceScrape spec |
+| serviceSpec#
_[AdditionalServiceSpec (v1beta1)](#v1beta1-additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vlsingle service spec |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| storage#
_[PersistentVolumeClaimSpec (v1)](#v1-persistentvolumeclaimspec)_ | _(Optional)_
Storage is the definition of how storage will be used by the VLSingle
by default it`s empty dir |
+| storageDataPath#
_string_ | _(Optional)_
StorageDataPath disables spec.storage option and overrides arg for victoria-logs binary --storageDataPath,
its users responsibility to mount proper device into given path. |
+| storageMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Optional)_
StorageMeta defines annotations and labels attached to PVC for given vlsingle CR |
+| syslogSpec#
_[SyslogServerSpec (v1)](#v1-syslogserverspec)_ | _(Optional)_
SyslogSpec defines syslog listener configuration |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming uses standalone Helm chart naming for managed resources:
the CR name is used directly instead of the default "-" convention.
Available from: v0.73.0 |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
+
+#### VLStorage {#v1-vlstorage}
VLStorage defines vlstorage component configuration at victoria-logs cluster
-Appears in: [VLClusterSpec](#vlclusterspec)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| claimTemplates#
_[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaim-v1-core) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet |
-| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| futureRetention#
_string_ | _(Optional)_
FutureRetention for the stored logs
Log entries with timestamps bigger than now+futureRetention are rejected during data ingestion; see https://docs.victoriametrics.com/victorialogs/#retention |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| hpa#
_[EmbeddedHPA](#embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling.
Note, downscaling is not supported. |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VLStorage to be configured with.
default or json |
-| logIngestedRows#
_boolean_ | _(Required)_
Whether to log all the ingested log entries; this can be useful for debugging of data ingestion; see https://docs.victoriametrics.com/victorialogs/data-ingestion/ |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VLStorage to be configured with. |
-| logNewStreams#
_boolean_ | _(Required)_
LogNewStreams Whether to log creation of new streams; this can be useful for debugging of high cardinality issues with log streams; see https://docs.victoriametrics.com/victorialogs/keyconcepts/#stream-fields |
-| maintenanceInsertNodeIDs#
_integer array_ | _(Optional)_
MaintenanceInsertNodeIDs - excludes given node ids from insert requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc.
lets say, you have pod-0, pod-1, pod-2, pod-3. to exclude pod-0 and pod-3 from insert routing, define nodeIDs: [0,3].
Useful at storage expanding, when you want to rebalance some data at cluster. |
-| maintenanceSelectNodeIDs#
_integer array_ | _(Optional)_
MaintenanceSelectNodeIDs - excludes given node ids from select requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc. |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| networkPolicy#
_[EmbeddedNetworkPolicy](#embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetpersistentvolumeclaimretentionpolicy-v1-apps)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
-| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec](#embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VLStorage pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| retentionMaxDiskSpaceUsageBytes#
_[BytesString](#bytesstring)_ | _(Optional)_
RetentionMaxDiskSpaceUsageBytes for the stored logs
VictoriaLogs keeps at least two last days of data in order to guarantee that the logs for the last day can be returned in queries.
This means that the total disk space usage may exceed the -retention.maxDiskSpaceUsageBytes,
if the size of the last two days of data exceeds the -retention.maxDiskSpaceUsageBytes.
https://docs.victoriametrics.com/victorialogs/#retention-by-disk-space-usage |
-| retentionPeriod#
_string_ | _(Optional)_
RetentionPeriod for the stored logs
https://docs.victoriametrics.com/victorialogs/#retention |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| rollingUpdateStrategy#
_[StatefulSetUpdateStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetupdatestrategytype-v1-apps)_ | _(Optional)_
RollingUpdateStrategy defines strategy for application updates
Default is OnDelete, in this case operator handles update process
Can be changed for RollingUpdate |
-| rollingUpdateStrategyBehavior#
_[StatefulSetUpdateStrategyBehavior](#statefulsetupdatestrategybehavior)_ | _(Optional)_
RollingUpdateStrategyBehavior defines customized behavior for rolling updates.
It applies if the RollingUpdateStrategy is set to OnDelete, which is the default. |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceScrapeSpec#
_[VMServiceScrapeSpec](#vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vlselect VMServiceScrape spec |
-| serviceSpec#
_[AdditionalServiceSpec](#additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vlselect service spec |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| storage#
_[StorageSpec](#storagespec)_ | _(Optional)_
Storage configures persistent volume for VLStorage |
-| storageDataPath#
_string_ | _(Optional)_
StorageDataPath - path to storage data |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
-
-#### VLStorageNode
+Appears in: [VLClusterSpec (v1)](#v1-vlclusterspec)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| claimTemplates#
_[PersistentVolumeClaim (v1)](#v1-persistentvolumeclaim) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet |
+| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| futureRetention#
_string_ | _(Optional)_
FutureRetention for the stored logs
Log entries with timestamps bigger than now+futureRetention are rejected during data ingestion; see https://docs.victoriametrics.com/victorialogs/#retention |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| hpa#
_[EmbeddedHPA (v1beta1)](#v1beta1-embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling.
Note, downscaling is not supported. |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VLStorage to be configured with.
default or json |
+| logIngestedRows#
_boolean_ | _(Required)_
Whether to log all the ingested log entries; this can be useful for debugging of data ingestion; see https://docs.victoriametrics.com/victorialogs/data-ingestion/ |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VLStorage to be configured with. |
+| logNewStreams#
_boolean_ | _(Required)_
LogNewStreams Whether to log creation of new streams; this can be useful for debugging of high cardinality issues with log streams; see https://docs.victoriametrics.com/victorialogs/keyconcepts/#stream-fields |
+| maintenanceInsertNodeIDs#
_integer array_ | _(Optional)_
MaintenanceInsertNodeIDs - excludes given node ids from insert requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc.
lets say, you have pod-0, pod-1, pod-2, pod-3. to exclude pod-0 and pod-3 from insert routing, define nodeIDs: [0,3].
Useful at storage expanding, when you want to rebalance some data at cluster. |
+| maintenanceSelectNodeIDs#
_integer array_ | _(Optional)_
MaintenanceSelectNodeIDs - excludes given node ids from select requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc. |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| networkPolicy#
_[EmbeddedNetworkPolicy (v1beta1)](#v1beta1-embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy (v1)](#v1-statefulsetpersistentvolumeclaimretentionpolicy)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
+| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec (v1beta1)](#v1beta1-embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VLStorage pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| retentionMaxDiskSpaceUsageBytes#
_[BytesString (v1beta1)](#v1beta1-bytesstring)_ | _(Optional)_
RetentionMaxDiskSpaceUsageBytes for the stored logs
VictoriaLogs keeps at least two last days of data in order to guarantee that the logs for the last day can be returned in queries.
This means that the total disk space usage may exceed the -retention.maxDiskSpaceUsageBytes,
if the size of the last two days of data exceeds the -retention.maxDiskSpaceUsageBytes.
https://docs.victoriametrics.com/victorialogs/#retention-by-disk-space-usage |
+| retentionPeriod#
_string_ | _(Optional)_
RetentionPeriod for the stored logs
https://docs.victoriametrics.com/victorialogs/#retention |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| rollingUpdateStrategy#
_[StatefulSetUpdateStrategyType (v1)](#v1-statefulsetupdatestrategytype)_ | _(Optional)_
RollingUpdateStrategy defines strategy for application updates
Default is OnDelete, in this case operator handles update process
Can be changed for RollingUpdate |
+| rollingUpdateStrategyBehavior#
_[StatefulSetUpdateStrategyBehavior (v1beta1)](#v1beta1-statefulsetupdatestrategybehavior)_ | _(Optional)_
RollingUpdateStrategyBehavior defines customized behavior for rolling updates.
It applies if the RollingUpdateStrategy is set to OnDelete, which is the default. |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceScrapeSpec#
_[VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vlselect VMServiceScrape spec |
+| serviceSpec#
_[AdditionalServiceSpec (v1beta1)](#v1beta1-additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vlselect service spec |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| storage#
_[StorageSpec (v1beta1)](#v1beta1-storagespec)_ | _(Optional)_
Storage configures persistent volume for VLStorage |
+| storageDataPath#
_string_ | _(Optional)_
StorageDataPath - path to storage data |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
+
+#### VLStorageNode {#v1-vlstoragenode}
VLStorageNode defines slice of additional vlstorage nodes
-Appears in: [VLSelect](#vlselect)
+Appears in: [VLSelect (v1)](#v1-vlselect)
| Field | Description |
| --- | --- |
-| addr#
_string_ | _(Required)_
Addr defines storage node address |
+| addr#
_string_ | _(Required)_
Addr defines storage node address |
-#### VMAnomaly
+#### VMAnomaly {#v1-vmanomaly}
VMAnomaly is the Schema for the vmanomalies API.
@@ -605,10 +605,10 @@ VMAnomaly is the Schema for the vmanomalies API.
| --- | --- |
| apiVersion
_string_ | (Required)
`operator.victoriametrics.com/v1` |
| kind
_string_ | (Required)
`VMAnomaly` |
-| metadata#
_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[VMAnomalySpec](#vmanomalyspec)_ | _(Required)_
|
+| metadata#
_[ObjectMeta (v1)](#v1-objectmeta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[VMAnomalySpec (v1)](#v1-vmanomalyspec)_ | _(Required)_
|
-#### VMAnomalyConfig
+#### VMAnomalyConfig {#v1-vmanomalyconfig}
VMAnomalyConfig is the Schema for the vmanomalyconfigs API.
@@ -616,218 +616,218 @@ VMAnomalyConfig is the Schema for the vmanomalyconfigs API.
| --- | --- |
| apiVersion
_string_ | (Required)
`operator.victoriametrics.com/v1` |
| kind
_string_ | (Required)
`VMAnomalyConfig` |
-| metadata#
_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[RawExtension](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#rawextension-runtime-pkg)_ | _(Required)_
|
+| metadata#
_[ObjectMeta (v1)](#v1-objectmeta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[RawExtension (runtime)](#runtime-rawextension)_ | _(Required)_
|
-#### VMAnomalyHTTPClientSpec
+#### VMAnomalyHTTPClientSpec {#v1-vmanomalyhttpclientspec}
VMAnomalyHTTPClientSpec defines the desired state of VMAnomalyHTTPClient
-Appears in: [VMAnomalyMonitoringPushSpec](#vmanomalymonitoringpushspec), [VMAnomalyReadersSpec](#vmanomalyreadersspec), [VMAnomalyWritersSpec](#vmanomalywritersspec)
+Appears in: [VMAnomalyMonitoringPushSpec (v1)](#v1-vmanomalymonitoringpushspec), [VMAnomalyReadersSpec (v1)](#v1-vmanomalyreadersspec), [VMAnomalyWritersSpec (v1)](#v1-vmanomalywritersspec)
| Field | Description |
| --- | --- |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Required)_
Basic auth defines basic authorization configuration |
-| bearer#
_[BearerAuth](#bearerauth)_ | _(Required)_
BearerAuth defines authorization with Authorization: Bearer header |
-| healthPath#
_string_ | _(Required)_
HealthPath defines absolute or relative URL address where to check availability of the remote webserver |
-| tenantID#
_string_ | _(Required)_
TenantID defines for VictoriaMetrics Cluster version only, tenants are identified by accountID, accountID:projectID or multitenant. |
-| timeout#
_string_ | _(Required)_
Timeout for the requests, passed as a string |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Required)_
TLSConfig defines tls connection configuration |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Required)_
Basic auth defines basic authorization configuration |
+| bearer#
_[BearerAuth (v1beta1)](#v1beta1-bearerauth)_ | _(Required)_
BearerAuth defines authorization with Authorization: Bearer header |
+| healthPath#
_string_ | _(Required)_
HealthPath defines absolute or relative URL address where to check availability of the remote webserver |
+| tenantID#
_string_ | _(Required)_
TenantID defines for VictoriaMetrics Cluster version only, tenants are identified by accountID, accountID:projectID or multitenant. |
+| timeout#
_string_ | _(Required)_
Timeout for the requests, passed as a string |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Required)_
TLSConfig defines tls connection configuration |
-#### VMAnomalyMonitoringPullSpec
+#### VMAnomalyMonitoringPullSpec {#v1-vmanomalymonitoringpullspec}
VMAnomalyMonitoringPullSpec defines pull monitoring configuration
which is enabled by default and served at POD_IP:8080/metrics
-Appears in: [VMAnomalyMonitoringSpec](#vmanomalymonitoringspec)
+Appears in: [VMAnomalyMonitoringSpec (v1)](#v1-vmanomalymonitoringspec)
| Field | Description |
| --- | --- |
-| port#
_string_ | _(Required)_
Port defines a port for metrics scrape |
+| port#
_string_ | _(Required)_
Port defines a port for metrics scrape |
-#### VMAnomalyMonitoringPushSpec
+#### VMAnomalyMonitoringPushSpec {#v1-vmanomalymonitoringpushspec}
VMAnomalyMonitoringPushSpec defines metrics push configuration
VMAnomaly uses prometheus text exposition format
-Appears in: [VMAnomalyMonitoringSpec](#vmanomalymonitoringspec)
+Appears in: [VMAnomalyMonitoringSpec (v1)](#v1-vmanomalymonitoringspec)
| Field | Description |
| --- | --- |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Required)_
Basic auth defines basic authorization configuration |
-| bearer#
_[BearerAuth](#bearerauth)_ | _(Required)_
BearerAuth defines authorization with Authorization: Bearer header |
-| extraLabels
_object (keys:string, values:string)_ | _(Required)_
ExtraLabels defines a set of labels to attach to the pushed metrics |
-| healthPath#
_string_ | _(Required)_
HealthPath defines absolute or relative URL address where to check availability of the remote webserver |
-| pushFrequency#
_string_ | _(Required)_
PushFrequency defines push interval |
-| tenantID#
_string_ | _(Required)_
TenantID defines for VictoriaMetrics Cluster version only, tenants are identified by accountID, accountID:projectID or multitenant. |
-| timeout#
_string_ | _(Required)_
Timeout for the requests, passed as a string |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Required)_
TLSConfig defines tls connection configuration |
-| url#
_string_ | _(Required)_
defines target url for push requests |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Required)_
Basic auth defines basic authorization configuration |
+| bearer#
_[BearerAuth (v1beta1)](#v1beta1-bearerauth)_ | _(Required)_
BearerAuth defines authorization with Authorization: Bearer header |
+| extraLabels
_object (keys:string, values:string)_ | _(Required)_
ExtraLabels defines a set of labels to attach to the pushed metrics |
+| healthPath#
_string_ | _(Required)_
HealthPath defines absolute or relative URL address where to check availability of the remote webserver |
+| pushFrequency#
_string_ | _(Required)_
PushFrequency defines push interval |
+| tenantID#
_string_ | _(Required)_
TenantID defines for VictoriaMetrics Cluster version only, tenants are identified by accountID, accountID:projectID or multitenant. |
+| timeout#
_string_ | _(Required)_
Timeout for the requests, passed as a string |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Required)_
TLSConfig defines tls connection configuration |
+| url#
_string_ | _(Required)_
defines target url for push requests |
-#### VMAnomalyMonitoringSpec
+#### VMAnomalyMonitoringSpec {#v1-vmanomalymonitoringspec}
VMAnomalyMonitoringSpec defines configuration for VMAnomaly monitoring
See https://docs.victoriametrics.com/anomaly-detection/components/monitoring/
-Appears in: [VMAnomalySpec](#vmanomalyspec)
+Appears in: [VMAnomalySpec (v1)](#v1-vmanomalyspec)
| Field | Description |
| --- | --- |
-| pull#
_[VMAnomalyMonitoringPullSpec](#vmanomalymonitoringpullspec)_ | _(Required)_
|
-| push#
_[VMAnomalyMonitoringPushSpec](#vmanomalymonitoringpushspec)_ | _(Required)_
|
+| pull#
_[VMAnomalyMonitoringPullSpec (v1)](#v1-vmanomalymonitoringpullspec)_ | _(Required)_
|
+| push#
_[VMAnomalyMonitoringPushSpec (v1)](#v1-vmanomalymonitoringpushspec)_ | _(Required)_
|
-#### VMAnomalyReadersSpec
+#### VMAnomalyReadersSpec {#v1-vmanomalyreadersspec}
VMAnomalyReadersSpec defines reader configuration for VMAnomaly
-Appears in: [VMAnomalySpec](#vmanomalyspec)
-
-| Field | Description |
-| --- | --- |
-| basicAuth
_[BasicAuth](#basicauth)_ | _(Required)_
Basic auth defines basic authorization configuration |
-| bearer
_[BearerAuth](#bearerauth)_ | _(Required)_
BearerAuth defines authorization with Authorization: Bearer header |
-| dataRange
_string array_ | _(Required)_
Optional argumentallows defining valid data ranges for input of all the queries in queries |
-| datasourceURL
_string_ | _(Required)_
DatasourceURL address
datasource must serve /api/v1/query and /api/v1/query_range APIs |
-| extraFilters
_string array_ | _(Required)_
List of strings with series selector. |
-| fetchTimeout
_string_ | _(Optional)_
FetchTimeout limits each datasource read request. It falls back to timeout when omitted. |
-| healthPath
_string_ | _(Required)_
HealthPath defines absolute or relative URL address where to check availability of the remote webserver |
-| latencyOffset
_string_ | _(Required)_
It allows overriding the default -search.latencyOffsetflag of VictoriaMetrics |
-| maxPointsPerQuery
_integer_ | _(Required)_
Optional argoverrides how search.maxPointsPerTimeseries flagimpacts vmanomaly on splitting long fitWindow queries into smaller sub-intervals |
-| offset
_string_ | _(Optional)_
Offset adds a time shift to the query window for all queries, e.g. to account for delayed data ingestion |
-| processingTimeout
_string_ | _(Optional)_
ProcessingTimeout limits post-fetch preparation for fit and infer stages. It falls back to timeout when omitted. |
-| queryFromLastSeenTimestamp
_boolean_ | _(Required)_
If True, then query will be performed from the last seen timestamp for a given series. |
-| queryLastSeenMaxLookback
_string_ | _(Optional)_
QueryLastSeenMaxLookback caps how far last-seen recovery may move a query start into the past. |
-| queryRangePath
_string_ | _(Required)_
Performs PromQL/MetricsQL range query |
-| samplingPeriod
_string_ | _(Required)_
Frequency of the points returned |
-| seriesProcessingBatchSize
_integer_ | _(Optional)_
SeriesProcessingBatchSize controls how many series are prepared together for fit and infer stages. |
-| tenantID
_string_ | _(Required)_
TenantID defines for VictoriaMetrics Cluster version only, tenants are identified by accountID, accountID:projectID or multitenant. |
-| timeout
_string_ | _(Required)_
Timeout for the requests, passed as a string |
-| tlsConfig
_[TLSConfig](#tlsconfig)_ | _(Required)_
TLSConfig defines tls connection configuration |
-| tz
_string_ | _(Required)_
Optional argument specifies the IANA timezone to account for local shifts, like DST, in models sensitive to seasonal patterns |
-
-#### VMAnomalyServerSpec
+Appears in: [VMAnomalySpec (v1)](#v1-vmanomalyspec)
+
+| Field | Description |
+| --- | --- |
+| basicAuth
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Required)_
Basic auth defines basic authorization configuration |
+| bearer
_[BearerAuth (v1beta1)](#v1beta1-bearerauth)_ | _(Required)_
BearerAuth defines authorization with Authorization: Bearer header |
+| dataRange
_string array_ | _(Required)_
Optional argumentallows defining valid data ranges for input of all the queries in queries |
+| datasourceURL
_string_ | _(Required)_
DatasourceURL address
datasource must serve /api/v1/query and /api/v1/query_range APIs |
+| extraFilters
_string array_ | _(Required)_
List of strings with series selector. |
+| fetchTimeout
_string_ | _(Optional)_
FetchTimeout limits each datasource read request. It falls back to timeout when omitted. |
+| healthPath
_string_ | _(Required)_
HealthPath defines absolute or relative URL address where to check availability of the remote webserver |
+| latencyOffset
_string_ | _(Required)_
It allows overriding the default -search.latencyOffsetflag of VictoriaMetrics |
+| maxPointsPerQuery
_integer_ | _(Required)_
Optional argoverrides how search.maxPointsPerTimeseries flagimpacts vmanomaly on splitting long fitWindow queries into smaller sub-intervals |
+| offset
_string_ | _(Optional)_
Offset adds a time shift to the query window for all queries, e.g. to account for delayed data ingestion |
+| processingTimeout
_string_ | _(Optional)_
ProcessingTimeout limits post-fetch preparation for fit and infer stages. It falls back to timeout when omitted. |
+| queryFromLastSeenTimestamp
_boolean_ | _(Required)_
If True, then query will be performed from the last seen timestamp for a given series. |
+| queryLastSeenMaxLookback
_string_ | _(Optional)_
QueryLastSeenMaxLookback caps how far last-seen recovery may move a query start into the past. |
+| queryRangePath
_string_ | _(Required)_
Performs PromQL/MetricsQL range query |
+| samplingPeriod
_string_ | _(Required)_
Frequency of the points returned |
+| seriesProcessingBatchSize
_integer_ | _(Optional)_
SeriesProcessingBatchSize controls how many series are prepared together for fit and infer stages. |
+| tenantID
_string_ | _(Required)_
TenantID defines for VictoriaMetrics Cluster version only, tenants are identified by accountID, accountID:projectID or multitenant. |
+| timeout
_string_ | _(Required)_
Timeout for the requests, passed as a string |
+| tlsConfig
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Required)_
TLSConfig defines tls connection configuration |
+| tz
_string_ | _(Required)_
Optional argument specifies the IANA timezone to account for local shifts, like DST, in models sensitive to seasonal patterns |
+
+#### VMAnomalyServerSpec {#v1-vmanomalyserverspec}
VMAnomalyServerSpec defines HTTP server configuration for VMAnomaly
See docs: https://docs.victoriametrics.com/anomaly-detection/components/server/
-Appears in: [VMAnomalySpec](#vmanomalyspec)
+Appears in: [VMAnomalySpec (v1)](#v1-vmanomalyspec)
| Field | Description |
| --- | --- |
-| addr#
_string_ | _(Optional)_
Addr defines IP address to listen on |
-| maxConcurrentTasks#
_integer_ | _(Optional)_
MaxConcurrentTasks defines maximum number of concurrent anomaly detection tasks |
-| pathPrefix#
_string_ | _(Optional)_
PathPrefix defines optional URL path prefix for all HTTP routes
If set to 'my-app' or '/my-app', routes will be served under '/my-app/...' |
-| port#
_string_ | _(Optional)_
Port defines port to listen on |
-| uiDefaultState#
_string_ | _(Optional)_
UIDefaultState defines default query state for anomaly UI |
-| useReaderConnectionSettings#
_boolean_ | _(Optional)_
UseReaderConnectionSettings when set to true, anomaly UI reuses connection settings
(credentials, TLS, etc.) from the reader configuration to connect to datasources |
+| addr#
_string_ | _(Optional)_
Addr defines IP address to listen on |
+| maxConcurrentTasks#
_integer_ | _(Optional)_
MaxConcurrentTasks defines maximum number of concurrent anomaly detection tasks |
+| pathPrefix#
_string_ | _(Optional)_
PathPrefix defines optional URL path prefix for all HTTP routes
If set to 'my-app' or '/my-app', routes will be served under '/my-app/...' |
+| port#
_string_ | _(Optional)_
Port defines port to listen on |
+| uiDefaultState#
_string_ | _(Optional)_
UIDefaultState defines default query state for anomaly UI |
+| useReaderConnectionSettings#
_boolean_ | _(Optional)_
UseReaderConnectionSettings when set to true, anomaly UI reuses connection settings
(credentials, TLS, etc.) from the reader configuration to connect to datasources |
-#### VMAnomalySpec
+#### VMAnomalySpec {#v1-vmanomalyspec}
VMAnomalySpec defines the desired state of VMAnomaly.
-Appears in: [VMAnomaly](#vmanomaly)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| claimTemplates#
_[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaim-v1-core) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for VMAnomaly |
-| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| configNamespaceSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
ConfigNamespaceSelector defines VMAnomalyConfig object namespace selector. |
-| configRawYaml#
_string_ | _(Optional)_
ConfigRawYaml - raw configuration for anomaly,
it helps it to start without secret.
priority -> hardcoded ConfigRaw -> ConfigRaw, provided by user -> ConfigSecret. |
-| configSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
ConfigSecret is the name of a Kubernetes Secret in the same namespace as the
VMAnomaly object, which contains configuration for this VMAnomaly,
configuration must be inside secret key: anomaly.yaml.
It must be created by user.
instance. Defaults to 'vmanomaly-'
The secret is mounted into /etc/anomaly/config. |
-| configSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
ConfigSelector defines VMAnomalyConfig object selector. |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| license#
_[License](#license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
Using license key is supported starting from VictoriaMetrics v1.94.0.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/) |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VMAnomaly to be configured with.
INFO, WARN, ERROR, FATAL, PANIC |
-| managedMetadata#
_[ManagedObjectsMetadata](#managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| monitoring#
_[VMAnomalyMonitoringSpec](#vmanomalymonitoringspec)_ | _(Required)_
Monitoring configures how expose anomaly metrics
See https://docs.victoriametrics.com/anomaly-detection/components/monitoring/ |
-| networkPolicy#
_[EmbeddedNetworkPolicy](#embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetpersistentvolumeclaimretentionpolicy-v1-apps)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
-| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec](#embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the vmanomaly pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| reader#
_[VMAnomalyReadersSpec](#vmanomalyreadersspec)_ | _(Required)_
Metrics source for VMAnomaly
See https://docs.victoriametrics.com/anomaly-detection/components/reader/ |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| rollingUpdateStrategy#
_[StatefulSetUpdateStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetupdatestrategytype-v1-apps)_ | _(Optional)_
RollingUpdateStrategy allows configuration for strategyType
set it to RollingUpdate for disabling operator statefulSet rollingUpdate |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| selectAllByDefault#
_boolean_ | _(Optional)_
SelectAllByDefault changes default behavior for empty configSelector and configNamespaceSelector.
with selectAllByDefault: true and empty object and namespace selectors
Operator selects all existing VMAnomalyConfig objects
with selectAllByDefault: false - selects nothing |
-| server#
_[VMAnomalyServerSpec](#vmanomalyserverspec)_ | _(Optional)_
Server configures HTTP server for VMAnomaly |
-| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
-| serviceScrapeSpec#
_[VMServiceScrapeSpec](#vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vmanomaly VMPodScrape spec |
-| shardCount#
_integer_ | _(Optional)_
ShardCount - numbers of shards of VMAnomaly
in this case operator will use 1 sts per shard with
replicas count according to spec.replicas. |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| storage#
_[StorageSpec](#storagespec)_ | _(Optional)_
Storage configures storage for StatefulSet |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming uses standalone Helm chart naming for managed resources:
the CR name is used directly instead of the default "-" convention.
Available from: v0.73.0 |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
VPA defines configuration for the VerticalPodAutoscaler. |
-| writer#
_[VMAnomalyWritersSpec](#vmanomalywritersspec)_ | _(Required)_
Metrics destination for VMAnomaly
See https://docs.victoriametrics.com/anomaly-detection/components/writer/ |
-
-#### VMAnomalyVMWriterMetricFormatSpec
+Appears in: [VMAnomaly (v1)](#v1-vmanomaly)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| claimTemplates#
_[PersistentVolumeClaim (v1)](#v1-persistentvolumeclaim) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for VMAnomaly |
+| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| configNamespaceSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
ConfigNamespaceSelector defines VMAnomalyConfig object namespace selector. |
+| configRawYaml#
_string_ | _(Optional)_
ConfigRawYaml - raw configuration for anomaly,
it helps it to start without secret.
priority -> hardcoded ConfigRaw -> ConfigRaw, provided by user -> ConfigSecret. |
+| configSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
ConfigSecret is the name of a Kubernetes Secret in the same namespace as the
VMAnomaly object, which contains configuration for this VMAnomaly,
configuration must be inside secret key: anomaly.yaml.
It must be created by user.
instance. Defaults to 'vmanomaly-'
The secret is mounted into /etc/anomaly/config. |
+| configSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
ConfigSelector defines VMAnomalyConfig object selector. |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| license#
_[License (v1beta1)](#v1beta1-license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
Using license key is supported starting from VictoriaMetrics v1.94.0.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/) |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VMAnomaly to be configured with.
INFO, WARN, ERROR, FATAL, PANIC |
+| managedMetadata#
_[ManagedObjectsMetadata (v1beta1)](#v1beta1-managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| monitoring#
_[VMAnomalyMonitoringSpec (v1)](#v1-vmanomalymonitoringspec)_ | _(Required)_
Monitoring configures how expose anomaly metrics
See https://docs.victoriametrics.com/anomaly-detection/components/monitoring/ |
+| networkPolicy#
_[EmbeddedNetworkPolicy (v1beta1)](#v1beta1-embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy (v1)](#v1-statefulsetpersistentvolumeclaimretentionpolicy)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
+| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec (v1beta1)](#v1beta1-embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the vmanomaly pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| reader#
_[VMAnomalyReadersSpec (v1)](#v1-vmanomalyreadersspec)_ | _(Required)_
Metrics source for VMAnomaly
See https://docs.victoriametrics.com/anomaly-detection/components/reader/ |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| rollingUpdateStrategy#
_[StatefulSetUpdateStrategyType (v1)](#v1-statefulsetupdatestrategytype)_ | _(Optional)_
RollingUpdateStrategy allows configuration for strategyType
set it to RollingUpdate for disabling operator statefulSet rollingUpdate |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| selectAllByDefault#
_boolean_ | _(Optional)_
SelectAllByDefault changes default behavior for empty configSelector and configNamespaceSelector.
with selectAllByDefault: true and empty object and namespace selectors
Operator selects all existing VMAnomalyConfig objects
with selectAllByDefault: false - selects nothing |
+| server#
_[VMAnomalyServerSpec (v1)](#v1-vmanomalyserverspec)_ | _(Optional)_
Server configures HTTP server for VMAnomaly |
+| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
+| serviceScrapeSpec#
_[VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vmanomaly VMPodScrape spec |
+| shardCount#
_integer_ | _(Optional)_
ShardCount - numbers of shards of VMAnomaly
in this case operator will use 1 sts per shard with
replicas count according to spec.replicas. |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| storage#
_[StorageSpec (v1beta1)](#v1beta1-storagespec)_ | _(Optional)_
Storage configures storage for StatefulSet |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming uses standalone Helm chart naming for managed resources:
the CR name is used directly instead of the default "-" convention.
Available from: v0.73.0 |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
VPA defines configuration for the VerticalPodAutoscaler. |
+| writer#
_[VMAnomalyWritersSpec (v1)](#v1-vmanomalywritersspec)_ | _(Required)_
Metrics destination for VMAnomaly
See https://docs.victoriametrics.com/anomaly-detection/components/writer/ |
+
+#### VMAnomalyVMWriterMetricFormatSpec {#v1-vmanomalyvmwritermetricformatspec}
VMAnomalyVMWriterMetricFormatSpec defines the desired state of VMAnomalyVMWriterMetricFormat
-Appears in: [VMAnomalyWritersSpec](#vmanomalywritersspec)
+Appears in: [VMAnomalyWritersSpec (v1)](#v1-vmanomalywritersspec)
| Field | Description |
| --- | --- |
-| __name__#
_string_ | _(Required)_
Name of result metric
Must have a value with $VAR placeholder in it to distinguish between resulting metrics |
-| extraLabels
_object (keys:string, values:string)_ | _(Required)_
ExtraLabels defines additional labels to be added to the resulting metrics |
-| for#
_string_ | _(Required)_
For is a special label with $QUERY_KEY placeholder |
+| __name__#
_string_ | _(Required)_
Name of result metric
Must have a value with $VAR placeholder in it to distinguish between resulting metrics |
+| extraLabels
_object (keys:string, values:string)_ | _(Required)_
ExtraLabels defines additional labels to be added to the resulting metrics |
+| for#
_string_ | _(Required)_
For is a special label with $QUERY_KEY placeholder |
-#### VMAnomalyWritersSpec
+#### VMAnomalyWritersSpec {#v1-vmanomalywritersspec}
VMAnomalyWritersSpec defines writer configuration for VMAnomaly
-Appears in: [VMAnomalySpec](#vmanomalyspec)
+Appears in: [VMAnomalySpec (v1)](#v1-vmanomalyspec)
| Field | Description |
| --- | --- |
-| basicAuth
_[BasicAuth](#basicauth)_ | _(Required)_
Basic auth defines basic authorization configuration |
-| bearer
_[BearerAuth](#bearerauth)_ | _(Required)_
BearerAuth defines authorization with Authorization: Bearer header |
-| connectionRetryAttempts
_integer_ | _(Optional)_
ConnectionRetryAttempts defines the number of attempts to retry the connection in case of failure |
-| datasourceURL
_string_ | _(Required)_
DatasourceURL defines remote write url for write requests
provided endpoint must serve /api/v1/import path
vmanomaly joins datasourceURL + "/api/v1/import" |
-| healthPath
_string_ | _(Required)_
HealthPath defines absolute or relative URL address where to check availability of the remote webserver |
-| metricFormat
_[VMAnomalyVMWriterMetricFormatSpec](#vmanomalyvmwritermetricformatspec)_ | _(Optional)_
Metrics to save the output (in metric names or labels) |
-| tenantID
_string_ | _(Required)_
TenantID defines for VictoriaMetrics Cluster version only, tenants are identified by accountID, accountID:projectID or multitenant. |
-| timeout
_string_ | _(Required)_
Timeout for the requests, passed as a string |
-| tlsConfig
_[TLSConfig](#tlsconfig)_ | _(Required)_
TLSConfig defines tls connection configuration |
+| basicAuth
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Required)_
Basic auth defines basic authorization configuration |
+| bearer
_[BearerAuth (v1beta1)](#v1beta1-bearerauth)_ | _(Required)_
BearerAuth defines authorization with Authorization: Bearer header |
+| connectionRetryAttempts
_integer_ | _(Optional)_
ConnectionRetryAttempts defines the number of attempts to retry the connection in case of failure |
+| datasourceURL
_string_ | _(Required)_
DatasourceURL defines remote write url for write requests
provided endpoint must serve /api/v1/import path
vmanomaly joins datasourceURL + "/api/v1/import" |
+| healthPath
_string_ | _(Required)_
HealthPath defines absolute or relative URL address where to check availability of the remote webserver |
+| metricFormat
_[VMAnomalyVMWriterMetricFormatSpec (v1)](#v1-vmanomalyvmwritermetricformatspec)_ | _(Optional)_
Metrics to save the output (in metric names or labels) |
+| tenantID
_string_ | _(Required)_
TenantID defines for VictoriaMetrics Cluster version only, tenants are identified by accountID, accountID:projectID or multitenant. |
+| timeout
_string_ | _(Required)_
Timeout for the requests, passed as a string |
+| tlsConfig
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Required)_
TLSConfig defines tls connection configuration |
-#### VTCluster
+#### VTCluster {#v1-vtcluster}
VTCluster is fast, cost-effective and scalable traces database.
@@ -835,156 +835,156 @@ VTCluster is fast, cost-effective and scalable traces database.
| --- | --- |
| apiVersion
_string_ | (Required)
`operator.victoriametrics.com/v1` |
| kind
_string_ | (Required)
`VTCluster` |
-| metadata#
_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[VTClusterSpec](#vtclusterspec)_ | _(Required)_
|
+| metadata#
_[ObjectMeta (v1)](#v1-objectmeta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[VTClusterSpec (v1)](#v1-vtclusterspec)_ | _(Required)_
|
-#### VTClusterSpec
+#### VTClusterSpec {#v1-vtclusterspec}
VTClusterSpec defines the desired state of VTCluster
-Appears in: [VTCluster](#vtcluster)
+Appears in: [VTCluster (v1)](#v1-vtcluster)
| Field | Description |
| --- | --- |
-| clusterDomainName#
_string_ | _(Optional)_
ClusterDomainName defines domain name suffix for in-cluster dns addresses
aka .cluster.local
used by vtinsert and vtselect to build vtstorage address |
-| clusterVersion#
_string_ | _(Optional)_
ClusterVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| insert#
_[VTInsert](#vtinsert)_ | _(Required)_
|
-| managedMetadata#
_[ManagedObjectsMetadata](#managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| requestsLoadBalancer#
_[VMAuthLoadBalancer](#vmauthloadbalancer)_ | _(Required)_
RequestsLoadBalancer configures load-balancing for vtinsert and vtselect requests.
It helps to evenly spread load across pods.
Usually it's not possible with Kubernetes TCP-based services. |
-| select#
_[VTSelect](#vtselect)_ | _(Required)_
|
-| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the
VTSelect, VTInsert and VTStorage Pods. |
-| storage#
_[VTStorage](#vtstorage)_ | _(Required)_
|
-| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming switches component resource naming from the default prefix convention
(-, e.g. "vtselect-myapp") to a suffix convention (-,
e.g. "myapp-vtselect"). Useful when migrating from standalone Helm charts.
Available from: v0.73.0 |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| clusterDomainName#
_string_ | _(Optional)_
ClusterDomainName defines domain name suffix for in-cluster dns addresses
aka .cluster.local
used by vtinsert and vtselect to build vtstorage address |
+| clusterVersion#
_string_ | _(Optional)_
ClusterVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| insert#
_[VTInsert (v1)](#v1-vtinsert)_ | _(Required)_
|
+| managedMetadata#
_[ManagedObjectsMetadata (v1beta1)](#v1beta1-managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| requestsLoadBalancer#
_[VMAuthLoadBalancer (v1beta1)](#v1beta1-vmauthloadbalancer)_ | _(Required)_
RequestsLoadBalancer configures load-balancing for vtinsert and vtselect requests.
It helps to evenly spread load across pods.
Usually it's not possible with Kubernetes TCP-based services. |
+| select#
_[VTSelect (v1)](#v1-vtselect)_ | _(Required)_
|
+| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the
VTSelect, VTInsert and VTStorage Pods. |
+| storage#
_[VTStorage (v1)](#v1-vtstorage)_ | _(Required)_
|
+| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming switches component resource naming from the default prefix convention
(-, e.g. "vtselect-myapp") to a suffix convention (-,
e.g. "myapp-vtselect"). Useful when migrating from standalone Helm charts.
Available from: v0.73.0 |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-#### VTInsert
+#### VTInsert {#v1-vtinsert}
VTInsert defines vtinsert component configuration at victoria-traces cluster
-Appears in: [VTClusterSpec](#vtclusterspec)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| hpa#
_[EmbeddedHPA](#embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling. |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VTInsert to be configured with.
default or json |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VTInsert to be configured with. |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| networkPolicy#
_[EmbeddedNetworkPolicy](#embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec](#embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VTInsert pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| rollingUpdate#
_[RollingUpdateDeployment](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#rollingupdatedeployment-v1-apps)_ | _(Optional)_
RollingUpdate - overrides deployment update params. |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceScrapeSpec#
_[VMServiceScrapeSpec](#vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vtinsert VMServiceScrape spec |
-| serviceSpec#
_[AdditionalServiceSpec](#additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vtinsert service spec |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| updateStrategy#
_[DeploymentStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#deploymentstrategytype-v1-apps)_ | _(Optional)_
UpdateStrategy - overrides default update strategy. |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
-
-#### VTSelect
+Appears in: [VTClusterSpec (v1)](#v1-vtclusterspec)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| hpa#
_[EmbeddedHPA (v1beta1)](#v1beta1-embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling. |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VTInsert to be configured with.
default or json |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VTInsert to be configured with. |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| networkPolicy#
_[EmbeddedNetworkPolicy (v1beta1)](#v1beta1-embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec (v1beta1)](#v1beta1-embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VTInsert pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| rollingUpdate#
_[RollingUpdateDeployment (v1)](#v1-rollingupdatedeployment)_ | _(Optional)_
RollingUpdate - overrides deployment update params. |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceScrapeSpec#
_[VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vtinsert VMServiceScrape spec |
+| serviceSpec#
_[AdditionalServiceSpec (v1beta1)](#v1beta1-additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vtinsert service spec |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| updateStrategy#
_[DeploymentStrategyType (v1)](#v1-deploymentstrategytype)_ | _(Optional)_
UpdateStrategy - overrides default update strategy. |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
+
+#### VTSelect {#v1-vtselect}
VTSelect defines vtselect component configuration at victoria-traces cluster
-Appears in: [VTClusterSpec](#vtclusterspec)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| extraStorageNodes
_[VTStorageNode](#vtstoragenode) array_ | _(Required)_
ExtraStorageNodes - defines additional storage nodes to VTSelect |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| hpa#
_[EmbeddedHPA](#embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling. |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VTSelect to be configured with.
default or json |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VTSelect to be configured with. |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| networkPolicy#
_[EmbeddedNetworkPolicy](#embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec](#embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VTSelect pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| rollingUpdate#
_[RollingUpdateDeployment](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#rollingupdatedeployment-v1-apps)_ | _(Optional)_
RollingUpdate - overrides deployment update params. |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceScrapeSpec#
_[VMServiceScrapeSpec](#vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vtselect VMServiceScrape spec |
-| serviceSpec#
_[AdditionalServiceSpec](#additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vtselect service spec |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| updateStrategy#
_[DeploymentStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#deploymentstrategytype-v1-apps)_ | _(Optional)_
UpdateStrategy - overrides default update strategy. |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
-
-#### VTSingle
+Appears in: [VTClusterSpec (v1)](#v1-vtclusterspec)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| extraStorageNodes
_[VTStorageNode (v1)](#v1-vtstoragenode) array_ | _(Required)_
ExtraStorageNodes - defines additional storage nodes to VTSelect |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| hpa#
_[EmbeddedHPA (v1beta1)](#v1beta1-embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling. |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VTSelect to be configured with.
default or json |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VTSelect to be configured with. |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| networkPolicy#
_[EmbeddedNetworkPolicy (v1beta1)](#v1beta1-embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec (v1beta1)](#v1beta1-embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VTSelect pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| rollingUpdate#
_[RollingUpdateDeployment (v1)](#v1-rollingupdatedeployment)_ | _(Optional)_
RollingUpdate - overrides deployment update params. |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceScrapeSpec#
_[VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vtselect VMServiceScrape spec |
+| serviceSpec#
_[AdditionalServiceSpec (v1beta1)](#v1beta1-additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vtselect service spec |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| updateStrategy#
_[DeploymentStrategyType (v1)](#v1-deploymentstrategytype)_ | _(Optional)_
UpdateStrategy - overrides default update strategy. |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
+
+#### VTSingle {#v1-vtsingle}
VTSingle is fast, cost-effective and scalable traces database.
VTSingle is the Schema for the API
@@ -993,170 +993,170 @@ VTSingle is the Schema for the API
| --- | --- |
| apiVersion
_string_ | (Required)
`operator.victoriametrics.com/v1` |
| kind
_string_ | (Required)
`VTSingle` |
-| metadata#
_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[VTSingleSpec](#vtsinglespec)_ | _(Required)_
|
+| metadata#
_[ObjectMeta (v1)](#v1-objectmeta)_ | _(Required)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[VTSingleSpec (v1)](#v1-vtsinglespec)_ | _(Required)_
|
-#### VTSingleSpec
+#### VTSingleSpec {#v1-vtsinglespec}
VTSingleSpec defines the desired state of VTSingle
-Appears in: [VTSingle](#vtsingle)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| futureRetention#
_string_ | _(Optional)_
FutureRetention for the stored traces
Log entries with timestamps bigger than now+futureRetention are rejected during data ingestion;
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VTSingle to be configured with. |
-| logIngestedRows#
_boolean_ | _(Required)_
Whether to log all the ingested log entries; this can be useful for debugging of data ingestion;
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VictoriaTraces to be configured with. |
-| logNewStreams#
_boolean_ | _(Required)_
LogNewStreams Whether to log creation of new streams; this can be useful for debugging of high cardinality issues with log streams;
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
-| managedMetadata#
_[ManagedObjectsMetadata](#managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| networkPolicy#
_[EmbeddedNetworkPolicy](#embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the VTSingle pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| retentionMaxDiskSpaceUsageBytes#
_[BytesString](#bytesstring)_ | _(Optional)_
RetentionMaxDiskSpaceUsageBytes for the stored traces
VictoriaTraces keeps at least two last days of data in order to guarantee that the traces for the last day can be returned in queries.
This means that the total disk space usage may exceed the -retention.maxDiskSpaceUsageBytes,
if the size of the last two days of data exceeds the -retention.maxDiskSpaceUsageBytes.
https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
-| retentionPeriod#
_string_ | _(Optional)_
RetentionPeriod for the stored traces
https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
-| serviceScrapeSpec#
_[VMServiceScrapeSpec](#vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vtsingle VMServiceScrape spec |
-| serviceSpec#
_[AdditionalServiceSpec](#additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vtsingle service spec |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| storage#
_[PersistentVolumeClaimSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaimspec-v1-core)_ | _(Optional)_
Storage is the definition of how storage will be used by the VTSingle
by default it`s empty dir |
-| storageDataPath#
_string_ | _(Optional)_
StorageDataPath disables spec.storage option and overrides arg for victoria-traces binary --storageDataPath,
its users responsibility to mount proper device into given path. |
-| storageMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Optional)_
StorageMeta defines annotations and labels attached to PVC for given vtsingle CR |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming uses standalone Helm chart naming for managed resources:
the CR name is used directly instead of the default "-" convention.
Available from: v0.73.0 |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
-
-#### VTStorage
+Appears in: [VTSingle (v1)](#v1-vtsingle)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| futureRetention#
_string_ | _(Optional)_
FutureRetention for the stored traces
Log entries with timestamps bigger than now+futureRetention are rejected during data ingestion;
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VTSingle to be configured with. |
+| logIngestedRows#
_boolean_ | _(Required)_
Whether to log all the ingested log entries; this can be useful for debugging of data ingestion;
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VictoriaTraces to be configured with. |
+| logNewStreams#
_boolean_ | _(Required)_
LogNewStreams Whether to log creation of new streams; this can be useful for debugging of high cardinality issues with log streams;
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
+| managedMetadata#
_[ManagedObjectsMetadata (v1beta1)](#v1beta1-managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| networkPolicy#
_[EmbeddedNetworkPolicy (v1beta1)](#v1beta1-embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the VTSingle pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| retentionMaxDiskSpaceUsageBytes#
_[BytesString (v1beta1)](#v1beta1-bytesstring)_ | _(Optional)_
RetentionMaxDiskSpaceUsageBytes for the stored traces
VictoriaTraces keeps at least two last days of data in order to guarantee that the traces for the last day can be returned in queries.
This means that the total disk space usage may exceed the -retention.maxDiskSpaceUsageBytes,
if the size of the last two days of data exceeds the -retention.maxDiskSpaceUsageBytes.
https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
+| retentionPeriod#
_string_ | _(Optional)_
RetentionPeriod for the stored traces
https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
+| serviceScrapeSpec#
_[VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vtsingle VMServiceScrape spec |
+| serviceSpec#
_[AdditionalServiceSpec (v1beta1)](#v1beta1-additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vtsingle service spec |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| storage#
_[PersistentVolumeClaimSpec (v1)](#v1-persistentvolumeclaimspec)_ | _(Optional)_
Storage is the definition of how storage will be used by the VTSingle
by default it`s empty dir |
+| storageDataPath#
_string_ | _(Optional)_
StorageDataPath disables spec.storage option and overrides arg for victoria-traces binary --storageDataPath,
its users responsibility to mount proper device into given path. |
+| storageMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Optional)_
StorageMeta defines annotations and labels attached to PVC for given vtsingle CR |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useLegacyNaming#
_boolean_ | _(Optional)_
UseLegacyNaming uses standalone Helm chart naming for managed resources:
the CR name is used directly instead of the default "-" convention.
Available from: v0.73.0 |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
+
+#### VTStorage {#v1-vtstorage}
VTStorage defines vtstorage component configuration at victoria-traces cluster
-Appears in: [VTClusterSpec](#vtclusterspec)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| claimTemplates#
_[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaim-v1-core) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet |
-| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| futureRetention#
_string_ | _(Optional)_
FutureRetention for the stored traces
Log entries with timestamps bigger than now+futureRetention are rejected during data ingestion
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| hpa#
_[EmbeddedHPA](#embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling.
Note, downscaling is not supported. |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VTStorage to be configured with.
default or json |
-| logIngestedRows#
_boolean_ | _(Required)_
Whether to log all the ingested log entries; this can be useful for debugging of data ingestion
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VTStorage to be configured with. |
-| logNewStreams#
_boolean_ | _(Required)_
LogNewStreams Whether to log creation of new streams; this can be useful for debugging of high cardinality issues with log streams
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
-| maintenanceInsertNodeIDs#
_integer array_ | _(Optional)_
MaintenanceInsertNodeIDs - excludes given node ids from insert requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc.
lets say, you have pod-0, pod-1, pod-2, pod-3. to exclude pod-0 and pod-3 from insert routing, define nodeIDs: [0,3].
Useful at storage expanding, when you want to rebalance some data at cluster. |
-| maintenanceSelectNodeIDs#
_integer array_ | _(Optional)_
MaintenanceSelectNodeIDs - excludes given node ids from select requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc. |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| networkPolicy#
_[EmbeddedNetworkPolicy](#embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetpersistentvolumeclaimretentionpolicy-v1-apps)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
-| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec](#embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VTStorage pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| retentionMaxDiskSpaceUsageBytes#
_[BytesString](#bytesstring)_ | _(Optional)_
RetentionMaxDiskSpaceUsageBytes for the stored traces
VictoriaTraces keeps at least two last days of data in order to guarantee that the traces for the last day can be returned in queries.
This means that the total disk space usage may exceed the -retention.maxDiskSpaceUsageBytes,
if the size of the last two days of data exceeds the -retention.maxDiskSpaceUsageBytes.
https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
-| retentionPeriod#
_string_ | _(Optional)_
RetentionPeriod for the stored traces
https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| rollingUpdateStrategy#
_[StatefulSetUpdateStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetupdatestrategytype-v1-apps)_ | _(Optional)_
RollingUpdateStrategy defines strategy for application updates
Default is OnDelete, in this case operator handles update process
Can be changed for RollingUpdate |
-| rollingUpdateStrategyBehavior#
_[StatefulSetUpdateStrategyBehavior](#statefulsetupdatestrategybehavior)_ | _(Optional)_
RollingUpdateStrategyBehavior defines customized behavior for rolling updates.
It applies if the RollingUpdateStrategy is set to OnDelete, which is the default. |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceScrapeSpec#
_[VMServiceScrapeSpec](#vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vtstorage VMServiceScrape spec |
-| serviceSpec#
_[AdditionalServiceSpec](#additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vtstorage service spec |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| storage#
_[StorageSpec](#storagespec)_ | _(Optional)_
Storage configures persistent volume for VTStorage |
-| storageDataPath#
_string_ | _(Optional)_
StorageDataPath - path to storage data |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
-
-#### VTStorageNode
+Appears in: [VTClusterSpec (v1)](#v1-vtclusterspec)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| claimTemplates#
_[PersistentVolumeClaim (v1)](#v1-persistentvolumeclaim) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet |
+| componentVersion#
_string_ | _(Optional)_
ComponentVersion defines default images tag for this component.
it can be overwritten with component specific image.tag value. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| futureRetention#
_string_ | _(Optional)_
FutureRetention for the stored traces
Log entries with timestamps bigger than now+futureRetention are rejected during data ingestion
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| hpa#
_[EmbeddedHPA (v1beta1)](#v1beta1-embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling.
Note, downscaling is not supported. |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VTStorage to be configured with.
default or json |
+| logIngestedRows#
_boolean_ | _(Required)_
Whether to log all the ingested log entries; this can be useful for debugging of data ingestion
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VTStorage to be configured with. |
+| logNewStreams#
_boolean_ | _(Required)_
LogNewStreams Whether to log creation of new streams; this can be useful for debugging of high cardinality issues with log streams
see https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
+| maintenanceInsertNodeIDs#
_integer array_ | _(Optional)_
MaintenanceInsertNodeIDs - excludes given node ids from insert requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc.
lets say, you have pod-0, pod-1, pod-2, pod-3. to exclude pod-0 and pod-3 from insert routing, define nodeIDs: [0,3].
Useful at storage expanding, when you want to rebalance some data at cluster. |
+| maintenanceSelectNodeIDs#
_integer array_ | _(Optional)_
MaintenanceSelectNodeIDs - excludes given node ids from select requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc. |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| networkPolicy#
_[EmbeddedNetworkPolicy (v1beta1)](#v1beta1-embeddednetworkpolicy)_ | _(Optional)_
NetworkPolicy defines network access rules for pods created by this CR. |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy (v1)](#v1-statefulsetpersistentvolumeclaimretentionpolicy)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
+| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec (v1beta1)](#v1beta1-embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Required)_
PodMetadata configures Labels and Annotations which are propagated to the VTStorage pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| retentionMaxDiskSpaceUsageBytes#
_[BytesString (v1beta1)](#v1beta1-bytesstring)_ | _(Optional)_
RetentionMaxDiskSpaceUsageBytes for the stored traces
VictoriaTraces keeps at least two last days of data in order to guarantee that the traces for the last day can be returned in queries.
This means that the total disk space usage may exceed the -retention.maxDiskSpaceUsageBytes,
if the size of the last two days of data exceeds the -retention.maxDiskSpaceUsageBytes.
https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
+| retentionPeriod#
_string_ | _(Optional)_
RetentionPeriod for the stored traces
https://docs.victoriametrics.com/victoriatraces/#configure-victoriatraces |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| rollingUpdateStrategy#
_[StatefulSetUpdateStrategyType (v1)](#v1-statefulsetupdatestrategytype)_ | _(Optional)_
RollingUpdateStrategy defines strategy for application updates
Default is OnDelete, in this case operator handles update process
Can be changed for RollingUpdate |
+| rollingUpdateStrategyBehavior#
_[StatefulSetUpdateStrategyBehavior (v1beta1)](#v1beta1-statefulsetupdatestrategybehavior)_ | _(Optional)_
RollingUpdateStrategyBehavior defines customized behavior for rolling updates.
It applies if the RollingUpdateStrategy is set to OnDelete, which is the default. |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceScrapeSpec#
_[VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)_ | _(Optional)_
ServiceScrapeSpec that will be added to vtstorage VMServiceScrape spec |
+| serviceSpec#
_[AdditionalServiceSpec (v1beta1)](#v1beta1-additionalservicespec)_ | _(Optional)_
ServiceSpec that will be added to vtstorage service spec |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| storage#
_[StorageSpec (v1beta1)](#v1beta1-storagespec)_ | _(Optional)_
Storage configures persistent volume for VTStorage |
+| storageDataPath#
_string_ | _(Optional)_
StorageDataPath - path to storage data |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
+
+#### VTStorageNode {#v1-vtstoragenode}
VTStorageNode defines slice of additional vtstorage nodes
-Appears in: [VTSelect](#vtselect)
+Appears in: [VTSelect (v1)](#v1-vtselect)
| Field | Description |
| --- | --- |
-| addr#
_string_ | _(Required)_
Addr defines storage node address |
+| addr#
_string_ | _(Required)_
Addr defines storage node address |
## operator.victoriametrics.com/v1alpha1
Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group.
### Resource Types
-- [VLDistributed](#vldistributed)
-- [VMDistributed](#vmdistributed)
+- [VLDistributed](#v1alpha1-vldistributed)
+- [VMDistributed](#v1alpha1-vmdistributed)
-#### VLDistributed
+#### VLDistributed {#v1alpha1-vldistributed}
VLDistributed is progressively rolling out updates to multiple zone components for VictoriaLogs.
@@ -1164,198 +1164,198 @@ VLDistributed is progressively rolling out updates to multiple zone components f
| --- | --- |
| apiVersion
_string_ | (Required)
`operator.victoriametrics.com/v1alpha1` |
| kind
_string_ | (Required)
`VLDistributed` |
-| metadata#
_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | _(Optional)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[VLDistributedSpec](#vldistributedspec)_ | _(Required)_
spec defines the desired state of VLDistributed |
+| metadata#
_[ObjectMeta (v1)](#v1-objectmeta)_ | _(Optional)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[VLDistributedSpec (v1alpha1)](#v1alpha1-vldistributedspec)_ | _(Required)_
spec defines the desired state of VLDistributed |
-#### VLDistributedAuth
+#### VLDistributedAuth {#v1alpha1-vldistributedauth}
VLDistributedAuth defines a VMAuth by name or inline spec
-Appears in: [VLDistributedSpec](#vldistributedspec)
+Appears in: [VLDistributedSpec (v1alpha1)](#v1alpha1-vldistributedspec)
| Field | Description |
| --- | --- |
-| enabled#
_boolean_ | _(Optional)_
Enabled defines if vmauth should be created. |
-| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the VLDistributedAuth when Spec is provided. |
-| spec#
_[VMAuthSpec](#vmauthspec)_ | _(Optional)_
Spec defines the desired state of a new VMAuth. |
+| enabled#
_boolean_ | _(Optional)_
Enabled defines if vmauth should be created. |
+| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the VLDistributedAuth when Spec is provided. |
+| spec#
_[VMAuthSpec (v1beta1)](#v1beta1-vmauthspec)_ | _(Optional)_
Spec defines the desired state of a new VMAuth. |
-#### VLDistributedBackendType
+#### VLDistributedBackendType {#v1alpha1-vldistributedbackendtype}
_Underlying type:_ _string_
VLDistributedBackendType defines the storage backend type for all zones.
-Appears in: [VLDistributedSpec](#vldistributedspec)
+Appears in: [VLDistributedSpec (v1alpha1)](#v1alpha1-vldistributedspec)
-#### VLDistributedSpec
+#### VLDistributedSpec {#v1alpha1-vldistributedspec}
VLDistributedSpec defines configurable parameters for VLDistributed CR
-Appears in: [VLDistributed](#vldistributed)
+Appears in: [VLDistributed (v1alpha1)](#v1alpha1-vldistributed)
| Field | Description |
| --- | --- |
-| backendType#
_[VLDistributedBackendType](#vldistributedbackendtype)_ | _(Optional)_
BackendType defines the storage backend type used across all zones.
VLCluster uses a distributed VLCluster per zone; VLSingle uses a single-node VLSingle per zone.
All zones must use the same backend type; mixed configurations are not supported. |
-| license#
_[License](#license)_ | _(Optional)_
License configures license key for enterprise features. If not nil, it will be passed to VLAgent and VLClusters. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| retain#
_boolean_ | _(Optional)_
Retain keeps resources in case of VLDistributed removal |
-| vmauth#
_[VLDistributedAuth](#vldistributedauth)_ | _(Optional)_
VMAuth is a VMAuth definition (name + optional spec) that acts as a proxy for the VMUsers created by the operator.
Use an inline spec to define a VMAuth object in-place or provide a name to reference an existing VMAuth. |
-| zoneCommon#
_[VLDistributedZoneCommon](#vldistributedzonecommon)_ | _(Optional)_
ZoneCommon defines common properties for all zones |
-| zones#
_[VLDistributedZone](#vldistributedzone) array_ | _(Required)_
Zones is a list of zones to update. Each item in the list represents a "zone" within the distributed setup. |
+| backendType#
_[VLDistributedBackendType (v1alpha1)](#v1alpha1-vldistributedbackendtype)_ | _(Optional)_
BackendType defines the storage backend type used across all zones.
VLCluster uses a distributed VLCluster per zone; VLSingle uses a single-node VLSingle per zone.
All zones must use the same backend type; mixed configurations are not supported. |
+| license#
_[License (v1beta1)](#v1beta1-license)_ | _(Optional)_
License configures license key for enterprise features. If not nil, it will be passed to VLAgent and VLClusters. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| retain#
_boolean_ | _(Optional)_
Retain keeps resources in case of VLDistributed removal |
+| vmauth#
_[VLDistributedAuth (v1alpha1)](#v1alpha1-vldistributedauth)_ | _(Optional)_
VMAuth is a VMAuth definition (name + optional spec) that acts as a proxy for the VMUsers created by the operator.
Use an inline spec to define a VMAuth object in-place or provide a name to reference an existing VMAuth. |
+| zoneCommon#
_[VLDistributedZoneCommon (v1alpha1)](#v1alpha1-vldistributedzonecommon)_ | _(Optional)_
ZoneCommon defines common properties for all zones |
+| zones#
_[VLDistributedZone (v1alpha1)](#v1alpha1-vldistributedzone) array_ | _(Required)_
Zones is a list of zones to update. Each item in the list represents a "zone" within the distributed setup. |
-#### VLDistributedTrafficMode
+#### VLDistributedTrafficMode {#v1alpha1-vldistributedtrafficmode}
_Underlying type:_ _string_
-Appears in: [VLDistributedZone](#vldistributedzone)
+Appears in: [VLDistributedZone (v1alpha1)](#v1alpha1-vldistributedzone)
-#### VLDistributedZone
+#### VLDistributedZone {#v1alpha1-vldistributedzone}
VLDistributedZone defines items within a single zone to update.
-Appears in: [VLDistributedSpec](#vldistributedspec)
+Appears in: [VLDistributedSpec (v1alpha1)](#v1alpha1-vldistributedspec)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Required)_
Name defines a name of zone, which can be used in zoneCommon spec as %ZONE% |
-| remoteWrite#
_[VLDistributedZoneRemoteWriteSpec](#vldistributedzoneremotewritespec)_ | _(Optional)_
RemoteWrite defines VLAgent remote write settings for given zone |
-| trafficMode#
_[VLDistributedTrafficMode](#vldistributedtrafficmode)_ | _(Required)_
TrafficMode defines allowed traffic mode for a zone: read-only, write-only, read-write, maintenance |
-| vlagent#
_[VLDistributedZoneAgent](#vldistributedzoneagent)_ | _(Optional)_
VLAgent defines VLAgent to balance incoming traffic between VLClusters. |
-| vlcluster#
_[VLDistributedZoneCluster](#vldistributedzonecluster)_ | _(Optional)_
VLCluster defines a new inline or referencing existing one VLCluster.
Mutually exclusive with VLSingle in the same zone. |
-| vlsingle#
_[VLDistributedZoneSingle](#vldistributedzonesingle)_ | _(Optional)_
VLSingle defines a new inline or referencing existing one VLSingle.
Mutually exclusive with VLCluster in the same zone. |
+| name#
_string_ | _(Required)_
Name defines a name of zone, which can be used in zoneCommon spec as %ZONE% |
+| remoteWrite#
_[VLDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vldistributedzoneremotewritespec)_ | _(Optional)_
RemoteWrite defines VLAgent remote write settings for given zone |
+| trafficMode#
_[VLDistributedTrafficMode (v1alpha1)](#v1alpha1-vldistributedtrafficmode)_ | _(Required)_
TrafficMode defines allowed traffic mode for a zone: read-only, write-only, read-write, maintenance |
+| vlagent#
_[VLDistributedZoneAgent (v1alpha1)](#v1alpha1-vldistributedzoneagent)_ | _(Optional)_
VLAgent defines VLAgent to balance incoming traffic between VLClusters. |
+| vlcluster#
_[VLDistributedZoneCluster (v1alpha1)](#v1alpha1-vldistributedzonecluster)_ | _(Optional)_
VLCluster defines a new inline or referencing existing one VLCluster.
Mutually exclusive with VLSingle in the same zone. |
+| vlsingle#
_[VLDistributedZoneSingle (v1alpha1)](#v1alpha1-vldistributedzonesingle)_ | _(Optional)_
VLSingle defines a new inline or referencing existing one VLSingle.
Mutually exclusive with VLCluster in the same zone. |
-#### VLDistributedZoneAgent
+#### VLDistributedZoneAgent {#v1alpha1-vldistributedzoneagent}
VLDistributedZoneAgent is a name and a specification of a new VLAgent.
-Appears in: [VLDistributedZone](#vldistributedzone), [VLDistributedZoneCommon](#vldistributedzonecommon)
+Appears in: [VLDistributedZone (v1alpha1)](#v1alpha1-vldistributedzone), [VLDistributedZoneCommon (v1alpha1)](#v1alpha1-vldistributedzonecommon)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the VLAgent when Spec is provided. |
-| spec#
_[VLDistributedZoneAgentSpec](#vldistributedzoneagentspec)_ | _(Optional)_
Spec defines the desired state of a new VLAgent. |
+| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the VLAgent when Spec is provided. |
+| spec#
_[VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec)_ | _(Optional)_
Spec defines the desired state of a new VLAgent. |
-#### VLDistributedZoneAgentSpec
+#### VLDistributedZoneAgentSpec {#v1alpha1-vldistributedzoneagentspec}
VLDistributedZoneAgentSpec is a customized specification of a new VLAgent.
It includes selected options from the original VLAgentSpec.
-Appears in: [VLDistributedZoneAgent](#vldistributedzoneagent)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| claimTemplates#
_[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaim-v1-core) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for VLAgent in StatefulSet mode |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| license#
_[License](#license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/#victorialogs-enterprise-features) |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VLAgent to be configured with. |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VLAgent to be configured with.
INFO, WARN, ERROR, FATAL, PANIC |
-| managedMetadata#
_[ManagedObjectsMetadata](#managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetpersistentvolumeclaimretentionpolicy-v1-apps)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
-| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec](#embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the vlagent pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| remoteWriteSettings#
_[VLAgentRemoteWriteSettings](#vlagentremotewritesettings)_ | _(Optional)_
RemoteWriteSettings defines global settings for all remoteWrite urls. |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| rollingUpdateStrategy#
_[StatefulSetUpdateStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetupdatestrategytype-v1-apps)_ | _(Optional)_
RollingUpdateStrategy allows configuration for strategyType
set it to RollingUpdate for disabling operator statefulSet rollingUpdate |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| storage#
_[StorageSpec](#storagespec)_ | _(Optional)_
Storage configures storage for StatefulSet |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-| vpa#
_[EmbeddedVPA](#embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
-
-#### VLDistributedZoneCluster
+Appears in: [VLDistributedZoneAgent (v1alpha1)](#v1alpha1-vldistributedzoneagent)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| claimTemplates#
_[PersistentVolumeClaim (v1)](#v1-persistentvolumeclaim) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for VLAgent in StatefulSet mode |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| license#
_[License (v1beta1)](#v1beta1-license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/#victorialogs-enterprise-features) |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VLAgent to be configured with. |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VLAgent to be configured with.
INFO, WARN, ERROR, FATAL, PANIC |
+| managedMetadata#
_[ManagedObjectsMetadata (v1beta1)](#v1beta1-managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy (v1)](#v1-statefulsetpersistentvolumeclaimretentionpolicy)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
+| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec (v1beta1)](#v1beta1-embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the vlagent pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| remoteWriteSettings#
_[VLAgentRemoteWriteSettings (v1)](#v1-vlagentremotewritesettings)_ | _(Optional)_
RemoteWriteSettings defines global settings for all remoteWrite urls. |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| rollingUpdateStrategy#
_[StatefulSetUpdateStrategyType (v1)](#v1-statefulsetupdatestrategytype)_ | _(Optional)_
RollingUpdateStrategy allows configuration for strategyType
set it to RollingUpdate for disabling operator statefulSet rollingUpdate |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| storage#
_[StorageSpec (v1beta1)](#v1beta1-storagespec)_ | _(Optional)_
Storage configures storage for StatefulSet |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+| vpa#
_[EmbeddedVPA (v1beta1)](#v1beta1-embeddedvpa)_ | _(Optional)_
Configures vertical pod autoscaling. |
+
+#### VLDistributedZoneCluster {#v1alpha1-vldistributedzonecluster}
VLDistributedZoneCluster defines the name and specification of a VLCluster to be created or updated.
-Appears in: [VLDistributedZone](#vldistributedzone), [VLDistributedZoneCommon](#vldistributedzonecommon)
+Appears in: [VLDistributedZone (v1alpha1)](#v1alpha1-vldistributedzone), [VLDistributedZoneCommon (v1alpha1)](#v1alpha1-vldistributedzonecommon)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the new VLCluster. |
-| spec#
_[VLClusterSpec](#vlclusterspec)_ | _(Optional)_
Spec defines the desired state of a new or update spec for existing VLCluster. |
+| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the new VLCluster. |
+| spec#
_[VLClusterSpec (v1)](#v1-vlclusterspec)_ | _(Optional)_
Spec defines the desired state of a new or update spec for existing VLCluster. |
-#### VLDistributedZoneCommon
+#### VLDistributedZoneCommon {#v1alpha1-vldistributedzonecommon}
VLDistributedZoneCommon defines items, that are common for all zones
-Appears in: [VLDistributedSpec](#vldistributedspec)
+Appears in: [VLDistributedSpec (v1alpha1)](#v1alpha1-vldistributedspec)
| Field | Description |
| --- | --- |
-| readyTimeout#
_[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#duration-v1-meta)_ | _(Optional)_
ReadyTimeout is the readiness timeout for each zone update. |
-| remoteWrite#
_[VLDistributedZoneRemoteWriteSpec](#vldistributedzoneremotewritespec)_ | _(Optional)_
RemoteWrite defines VLAgent remote write settings for given zone |
-| updatePause#
_[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#duration-v1-meta)_ | _(Optional)_
UpdatePause is the time the operator should wait between zone updates to ensure a smooth transition. |
-| vlagent#
_[VLDistributedZoneAgent](#vldistributedzoneagent)_ | _(Optional)_
VLAgent defines VLAgent to balance incoming traffic between VLClusters. |
-| vlcluster#
_[VLDistributedZoneCluster](#vldistributedzonecluster)_ | _(Optional)_
VLCluster defines VictoriaLogs cluster database |
-| vlsingle#
_[VLDistributedZoneSingle](#vldistributedzonesingle)_ | _(Optional)_
VLSingle defines VictoriaLogs single-node database. |
+| readyTimeout#
_[Duration (v1)](#v1-duration)_ | _(Optional)_
ReadyTimeout is the readiness timeout for each zone update. |
+| remoteWrite#
_[VLDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vldistributedzoneremotewritespec)_ | _(Optional)_
RemoteWrite defines VLAgent remote write settings for given zone |
+| updatePause#
_[Duration (v1)](#v1-duration)_ | _(Optional)_
UpdatePause is the time the operator should wait between zone updates to ensure a smooth transition. |
+| vlagent#
_[VLDistributedZoneAgent (v1alpha1)](#v1alpha1-vldistributedzoneagent)_ | _(Optional)_
VLAgent defines VLAgent to balance incoming traffic between VLClusters. |
+| vlcluster#
_[VLDistributedZoneCluster (v1alpha1)](#v1alpha1-vldistributedzonecluster)_ | _(Optional)_
VLCluster defines VictoriaLogs cluster database |
+| vlsingle#
_[VLDistributedZoneSingle (v1alpha1)](#v1alpha1-vldistributedzonesingle)_ | _(Optional)_
VLSingle defines VictoriaLogs single-node database. |
-#### VLDistributedZoneRemoteWriteSpec
+#### VLDistributedZoneRemoteWriteSpec {#v1alpha1-vldistributedzoneremotewritespec}
VLDistributedZoneRemoteWriteSpec is a copy of VLAgentRemoteWriteSpec without the URL field.
The URL will be overwritten by the controller.
-Appears in: [VLDistributedZone](#vldistributedzone), [VLDistributedZoneCommon](#vldistributedzonecommon)
+Appears in: [VLDistributedZone (v1alpha1)](#v1alpha1-vldistributedzone), [VLDistributedZoneCommon (v1alpha1)](#v1alpha1-vldistributedzonecommon)
| Field | Description |
| --- | --- |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
-| bearerTokenPath#
_string_ | _(Optional)_
Optional bearer auth token path |
-| bearerTokenSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Optional bearer auth token to use for -remoteWrite.url |
-| headers
_string array_ | _(Optional)_
Headers allow configuring custom http headers
Must be in form of semicolon separated header with value
e.g.
headerName: headerValue |
-| maxDiskUsage#
_[BytesString](#bytesstring)_ | _(Optional)_
MaxDiskUsage defines the maximum file-based buffer size in bytes for the given remoteWrite
It overrides global configuration defined at remoteWriteSettings.maxDiskUsagePerURL |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL for -remoteWrite.url. Supported proxies: http, https, socks5. Example: socks5://proxy:1234 |
-| sendTimeout#
_string_ | _(Optional)_
Timeout for sending a single block of data to -remoteWrite.url (default 1m0s) |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig describes tls configuration for remote write target |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
+| bearerTokenPath#
_string_ | _(Optional)_
Optional bearer auth token path |
+| bearerTokenSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Optional bearer auth token to use for -remoteWrite.url |
+| headers
_string array_ | _(Optional)_
Headers allow configuring custom http headers
Must be in form of semicolon separated header with value
e.g.
headerName: headerValue |
+| maxDiskUsage#
_[BytesString (v1beta1)](#v1beta1-bytesstring)_ | _(Optional)_
MaxDiskUsage defines the maximum file-based buffer size in bytes for the given remoteWrite
It overrides global configuration defined at remoteWriteSettings.maxDiskUsagePerURL |
+| oauth2#
_[OAuth2 (v1)](#v1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL for -remoteWrite.url. Supported proxies: http, https, socks5. Example: socks5://proxy:1234 |
+| sendTimeout#
_string_ | _(Optional)_
Timeout for sending a single block of data to -remoteWrite.url (default 1m0s) |
+| tlsConfig#
_[TLSConfig (v1)](#v1-tlsconfig)_ | _(Optional)_
TLSConfig describes tls configuration for remote write target |
-#### VLDistributedZoneSingle
+#### VLDistributedZoneSingle {#v1alpha1-vldistributedzonesingle}
VLDistributedZoneSingle defines the name and specification of a VLSingle to be created or updated.
-Appears in: [VLDistributedZone](#vldistributedzone), [VLDistributedZoneCommon](#vldistributedzonecommon)
+Appears in: [VLDistributedZone (v1alpha1)](#v1alpha1-vldistributedzone), [VLDistributedZoneCommon (v1alpha1)](#v1alpha1-vldistributedzonecommon)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the new VLSingle. |
-| spec#
_[VLSingleSpec](#vlsinglespec)_ | _(Optional)_
Spec defines the desired state of a new or update spec for existing VLSingle. |
+| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the new VLSingle. |
+| spec#
_[VLSingleSpec (v1)](#v1-vlsinglespec)_ | _(Optional)_
Spec defines the desired state of a new or update spec for existing VLSingle. |
-#### VMDistributed
+#### VMDistributed {#v1alpha1-vmdistributed}
VMDistributed is progressively rolling out updates to multiple zone components.
@@ -1363,255 +1363,255 @@ VMDistributed is progressively rolling out updates to multiple zone components.
| --- | --- |
| apiVersion
_string_ | (Required)
`operator.victoriametrics.com/v1alpha1` |
| kind
_string_ | (Required)
`VMDistributed` |
-| metadata#
_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | _(Optional)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[VMDistributedSpec](#vmdistributedspec)_ | _(Required)_
spec defines the desired state of VMDistributed |
+| metadata#
_[ObjectMeta (v1)](#v1-objectmeta)_ | _(Optional)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[VMDistributedSpec (v1alpha1)](#v1alpha1-vmdistributedspec)_ | _(Required)_
spec defines the desired state of VMDistributed |
-#### VMDistributedAuth
+#### VMDistributedAuth {#v1alpha1-vmdistributedauth}
VMDistributedAuth defines a VMAuth by name or inline spec
-Appears in: [VMDistributedSpec](#vmdistributedspec)
+Appears in: [VMDistributedSpec (v1alpha1)](#v1alpha1-vmdistributedspec)
| Field | Description |
| --- | --- |
-| enabled#
_boolean_ | _(Optional)_
Enabled defines if vmauth should be created. |
-| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the VMDistributedAuth when Spec is provided. |
-| spec#
_[VMAuthSpec](#vmauthspec)_ | _(Optional)_
Spec defines the desired state of a new VMAuth. |
+| enabled#
_boolean_ | _(Optional)_
Enabled defines if vmauth should be created. |
+| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the VMDistributedAuth when Spec is provided. |
+| spec#
_[VMAuthSpec (v1beta1)](#v1beta1-vmauthspec)_ | _(Optional)_
Spec defines the desired state of a new VMAuth. |
-#### VMDistributedBackendType
+#### VMDistributedBackendType {#v1alpha1-vmdistributedbackendtype}
_Underlying type:_ _string_
VMDistributedBackendType defines the storage backend type for all zones.
-Appears in: [VMDistributedSpec](#vmdistributedspec)
+Appears in: [VMDistributedSpec (v1alpha1)](#v1alpha1-vmdistributedspec)
-#### VMDistributedSpec
+#### VMDistributedSpec {#v1alpha1-vmdistributedspec}
VMDistributedSpec defines configurable parameters for VMDistributed CR
-Appears in: [VMDistributed](#vmdistributed)
+Appears in: [VMDistributed (v1alpha1)](#v1alpha1-vmdistributed)
| Field | Description |
| --- | --- |
-| backendType#
_[VMDistributedBackendType](#vmdistributedbackendtype)_ | _(Optional)_
BackendType defines the storage backend type used across all zones.
VMCluster uses a distributed VMCluster per zone; VMSingle uses a single-node VMSingle per zone.
All zones must use the same backend type; mixed configurations are not supported. |
-| license#
_[License](#license)_ | _(Optional)_
License configures license key for enterprise features. If not nil, it will be passed to VMAgent, VMAuth and VMClusters. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| retain#
_boolean_ | _(Optional)_
Retain keeps resources in case of VMDistributed removal |
-| vmauth#
_[VMDistributedAuth](#vmdistributedauth)_ | _(Optional)_
VMAuth is a VMAuth definition (name + optional spec) that acts as a proxy for the VMUsers created by the operator.
Use an inline spec to define a VMAuth object in-place or provide a name to reference an existing VMAuth. |
-| zoneCommon#
_[VMDistributedZoneCommon](#vmdistributedzonecommon)_ | _(Optional)_
ZoneCommon defines common properties for all zones |
-| zones#
_[VMDistributedZone](#vmdistributedzone) array_ | _(Required)_
Zones is a list of zones to update. Each item in the list represents a "zone" within the distributed setup. |
+| backendType#
_[VMDistributedBackendType (v1alpha1)](#v1alpha1-vmdistributedbackendtype)_ | _(Optional)_
BackendType defines the storage backend type used across all zones.
VMCluster uses a distributed VMCluster per zone; VMSingle uses a single-node VMSingle per zone.
All zones must use the same backend type; mixed configurations are not supported. |
+| license#
_[License (v1beta1)](#v1beta1-license)_ | _(Optional)_
License configures license key for enterprise features. If not nil, it will be passed to VMAgent, VMAuth and VMClusters. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| retain#
_boolean_ | _(Optional)_
Retain keeps resources in case of VMDistributed removal |
+| vmauth#
_[VMDistributedAuth (v1alpha1)](#v1alpha1-vmdistributedauth)_ | _(Optional)_
VMAuth is a VMAuth definition (name + optional spec) that acts as a proxy for the VMUsers created by the operator.
Use an inline spec to define a VMAuth object in-place or provide a name to reference an existing VMAuth. |
+| zoneCommon#
_[VMDistributedZoneCommon (v1alpha1)](#v1alpha1-vmdistributedzonecommon)_ | _(Optional)_
ZoneCommon defines common properties for all zones |
+| zones#
_[VMDistributedZone (v1alpha1)](#v1alpha1-vmdistributedzone) array_ | _(Required)_
Zones is a list of zones to update. Each item in the list represents a "zone" within the distributed setup. |
-#### VMDistributedTrafficMode
+#### VMDistributedTrafficMode {#v1alpha1-vmdistributedtrafficmode}
_Underlying type:_ _string_
-Appears in: [VMDistributedZone](#vmdistributedzone)
+Appears in: [VMDistributedZone (v1alpha1)](#v1alpha1-vmdistributedzone)
-#### VMDistributedZone
+#### VMDistributedZone {#v1alpha1-vmdistributedzone}
VMDistributedZone defines items within a single zone to update.
-Appears in: [VMDistributedSpec](#vmdistributedspec)
+Appears in: [VMDistributedSpec (v1alpha1)](#v1alpha1-vmdistributedspec)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Required)_
Name defines a name of zone, which can be used in zoneCommon spec as %ZONE% |
-| remoteWrite#
_[VMDistributedZoneRemoteWriteSpec](#vmdistributedzoneremotewritespec)_ | _(Optional)_
RemoteWrite defines VMAgent remote write settings for given zone |
-| trafficMode#
_[VMDistributedTrafficMode](#vmdistributedtrafficmode)_ | _(Required)_
TrafficMode defines allowed traffic mode for a zone: read-only, write-only, read-write, maintenance |
-| vmagent#
_[VMDistributedZoneAgent](#vmdistributedzoneagent)_ | _(Optional)_
VMAgent defines VMAgent to balance incoming traffic between VMClusters. |
-| vmcluster#
_[VMDistributedZoneCluster](#vmdistributedzonecluster)_ | _(Optional)_
VMCluster defines a new inline or referencing existing one VMCluster.
Mutually exclusive with VMSingle in the same zone. |
-| vmsingle#
_[VMDistributedZoneSingle](#vmdistributedzonesingle)_ | _(Optional)_
VMSingle defines a new inline or referencing existing one VMSingle.
Mutually exclusive with VMCluster in the same zone. |
+| name#
_string_ | _(Required)_
Name defines a name of zone, which can be used in zoneCommon spec as %ZONE% |
+| remoteWrite#
_[VMDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vmdistributedzoneremotewritespec)_ | _(Optional)_
RemoteWrite defines VMAgent remote write settings for given zone |
+| trafficMode#
_[VMDistributedTrafficMode (v1alpha1)](#v1alpha1-vmdistributedtrafficmode)_ | _(Required)_
TrafficMode defines allowed traffic mode for a zone: read-only, write-only, read-write, maintenance |
+| vmagent#
_[VMDistributedZoneAgent (v1alpha1)](#v1alpha1-vmdistributedzoneagent)_ | _(Optional)_
VMAgent defines VMAgent to balance incoming traffic between VMClusters. |
+| vmcluster#
_[VMDistributedZoneCluster (v1alpha1)](#v1alpha1-vmdistributedzonecluster)_ | _(Optional)_
VMCluster defines a new inline or referencing existing one VMCluster.
Mutually exclusive with VMSingle in the same zone. |
+| vmsingle#
_[VMDistributedZoneSingle (v1alpha1)](#v1alpha1-vmdistributedzonesingle)_ | _(Optional)_
VMSingle defines a new inline or referencing existing one VMSingle.
Mutually exclusive with VMCluster in the same zone. |
-#### VMDistributedZoneAgent
+#### VMDistributedZoneAgent {#v1alpha1-vmdistributedzoneagent}
VMDistributedZoneAgent is a name and a specification of a new VMAgent.
-Appears in: [VMDistributedZone](#vmdistributedzone), [VMDistributedZoneCommon](#vmdistributedzonecommon)
+Appears in: [VMDistributedZone (v1alpha1)](#v1alpha1-vmdistributedzone), [VMDistributedZoneCommon (v1alpha1)](#v1alpha1-vmdistributedzonecommon)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the VMAgent when Spec is provided. |
-| spec#
_[VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec)_ | _(Optional)_
Spec defines the desired state of a new VMAgent. |
+| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the VMAgent when Spec is provided. |
+| spec#
_[VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec)_ | _(Optional)_
Spec defines the desired state of a new VMAgent. |
-#### VMDistributedZoneAgentSpec
+#### VMDistributedZoneAgentSpec {#v1alpha1-vmdistributedzoneagentspec}
VMDistributedZoneAgentSpec is a customized specification of a new VMAgent.
It includes selected options from the original VMAgentSpec.
-Appears in: [VMDistributedZoneAgent](#vmdistributedzoneagent)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| claimTemplates#
_[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaim-v1-core) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for VMAgent in StatefulMode |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| hpa#
_[EmbeddedHPA](#embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling. |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| license#
_[License](#license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
Using license key is supported starting from VictoriaMetrics v1.94.0.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/) |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| logFormat#
_string_ | _(Optional)_
LogFormat for VMAgent to be configured with. |
-| logLevel#
_string_ | _(Optional)_
LogLevel for VMAgent to be configured with.
INFO, WARN, ERROR, FATAL, PANIC |
-| managedMetadata#
_[ManagedObjectsMetadata](#managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetpersistentvolumeclaimretentionpolicy-v1-apps)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
-| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec](#embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
-| podMetadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the vmagent pods. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| remoteWriteSettings#
_[VMAgentRemoteWriteSettings](#vmagentremotewritesettings)_ | _(Optional)_
RemoteWriteSettings defines global settings for all remoteWrite urls. |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| rollingUpdate#
_[RollingUpdateDeployment](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#rollingupdatedeployment-v1-apps)_ | _(Optional)_
RollingUpdate - overrides deployment update params. |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| statefulMode#
_boolean_ | _(Optional)_
StatefulMode enables StatefulSet for `VMAgent` instead of Deployment
it allows using persistent storage for vmagent's persistentQueue |
-| statefulRollingUpdateStrategy#
_[StatefulSetUpdateStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#statefulsetupdatestrategytype-v1-apps)_ | _(Optional)_
StatefulRollingUpdateStrategy allows configuration for strategyType
set it to RollingUpdate for disabling operator statefulSet rollingUpdate |
-| statefulRollingUpdateStrategyBehavior#
_[StatefulSetUpdateStrategyBehavior](#statefulsetupdatestrategybehavior)_ | _(Optional)_
StatefulRollingUpdateStrategyBehavior defines customized behavior for rolling updates.
It applies if the RollingUpdateStrategy is set to OnDelete, which is the default. |
-| statefulStorage#
_[StorageSpec](#storagespec)_ | _(Optional)_
StatefulStorage configures storage for StatefulSet |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| updateStrategy#
_[DeploymentStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#deploymentstrategytype-v1-apps)_ | _(Optional)_
UpdateStrategy - overrides default update strategy.
works only for deployments, statefulset always use OnDelete. |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-
-#### VMDistributedZoneCluster
+Appears in: [VMDistributedZoneAgent (v1alpha1)](#v1alpha1-vmdistributedzoneagent)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| claimTemplates#
_[PersistentVolumeClaim (v1)](#v1-persistentvolumeclaim) array_ | _(Required)_
ClaimTemplates allows adding additional VolumeClaimTemplates for VMAgent in StatefulMode |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| hpa#
_[EmbeddedHPA (v1beta1)](#v1beta1-embeddedhpa)_ | _(Optional)_
Configures horizontal pod autoscaling. |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| license#
_[License (v1beta1)](#v1beta1-license)_ | _(Optional)_
License allows to configure license key to be used for enterprise features.
Using license key is supported starting from VictoriaMetrics v1.94.0.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/) |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| logFormat#
_string_ | _(Optional)_
LogFormat for VMAgent to be configured with. |
+| logLevel#
_string_ | _(Optional)_
LogLevel for VMAgent to be configured with.
INFO, WARN, ERROR, FATAL, PANIC |
+| managedMetadata#
_[ManagedObjectsMetadata (v1beta1)](#v1beta1-managedobjectsmetadata)_ | _(Required)_
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| persistentVolumeClaimRetentionPolicy#
_[StatefulSetPersistentVolumeClaimRetentionPolicy (v1)](#v1-statefulsetpersistentvolumeclaimretentionpolicy)_ | _(Optional)_
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy |
+| podDisruptionBudget#
_[EmbeddedPodDisruptionBudgetSpec (v1beta1)](#v1beta1-embeddedpoddisruptionbudgetspec)_ | _(Optional)_
PodDisruptionBudget created by operator |
+| podMetadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Optional)_
PodMetadata configures Labels and Annotations which are propagated to the vmagent pods. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| remoteWriteSettings#
_[VMAgentRemoteWriteSettings (v1beta1)](#v1beta1-vmagentremotewritesettings)_ | _(Optional)_
RemoteWriteSettings defines global settings for all remoteWrite urls. |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| rollingUpdate#
_[RollingUpdateDeployment (v1)](#v1-rollingupdatedeployment)_ | _(Optional)_
RollingUpdate - overrides deployment update params. |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| serviceAccountName#
_string_ | _(Optional)_
ServiceAccountName is the name of the ServiceAccount to use to run the pods |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| statefulMode#
_boolean_ | _(Optional)_
StatefulMode enables StatefulSet for `VMAgent` instead of Deployment
it allows using persistent storage for vmagent's persistentQueue |
+| statefulRollingUpdateStrategy#
_[StatefulSetUpdateStrategyType (v1)](#v1-statefulsetupdatestrategytype)_ | _(Optional)_
StatefulRollingUpdateStrategy allows configuration for strategyType
set it to RollingUpdate for disabling operator statefulSet rollingUpdate |
+| statefulRollingUpdateStrategyBehavior#
_[StatefulSetUpdateStrategyBehavior (v1beta1)](#v1beta1-statefulsetupdatestrategybehavior)_ | _(Optional)_
StatefulRollingUpdateStrategyBehavior defines customized behavior for rolling updates.
It applies if the RollingUpdateStrategy is set to OnDelete, which is the default. |
+| statefulStorage#
_[StorageSpec (v1beta1)](#v1beta1-storagespec)_ | _(Optional)_
StatefulStorage configures storage for StatefulSet |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| updateStrategy#
_[DeploymentStrategyType (v1)](#v1-deploymentstrategytype)_ | _(Optional)_
UpdateStrategy - overrides default update strategy.
works only for deployments, statefulset always use OnDelete. |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+
+#### VMDistributedZoneCluster {#v1alpha1-vmdistributedzonecluster}
VMDistributedZoneCluster defines the name and specification of a VMCluster to be created or updated.
-Appears in: [VMDistributedZone](#vmdistributedzone), [VMDistributedZoneCommon](#vmdistributedzonecommon)
+Appears in: [VMDistributedZone (v1alpha1)](#v1alpha1-vmdistributedzone), [VMDistributedZoneCommon (v1alpha1)](#v1alpha1-vmdistributedzonecommon)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the new VMCluster. |
-| spec#
_[VMClusterSpec](#vmclusterspec)_ | _(Optional)_
Spec defines the desired state of a new or update spec for existing VMCluster. |
+| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the new VMCluster. |
+| spec#
_[VMClusterSpec (v1beta1)](#v1beta1-vmclusterspec)_ | _(Optional)_
Spec defines the desired state of a new or update spec for existing VMCluster. |
-#### VMDistributedZoneCommon
+#### VMDistributedZoneCommon {#v1alpha1-vmdistributedzonecommon}
VMDistributedZoneCommon defines items, that are common for all zones
-Appears in: [VMDistributedSpec](#vmdistributedspec)
+Appears in: [VMDistributedSpec (v1alpha1)](#v1alpha1-vmdistributedspec)
| Field | Description |
| --- | --- |
-| readyTimeout#
_[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#duration-v1-meta)_ | _(Optional)_
ReadyTimeout is the readiness timeout for each zone update. |
-| remoteWrite#
_[VMDistributedZoneRemoteWriteSpec](#vmdistributedzoneremotewritespec)_ | _(Optional)_
RemoteWrite defines VMAgent remote write settings for given zone |
-| updatePause#
_[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#duration-v1-meta)_ | _(Optional)_
UpdatePause is the time the operator should wait between zone updates to ensure a smooth transition. |
-| vmagent#
_[VMDistributedZoneAgent](#vmdistributedzoneagent)_ | _(Optional)_
VMAgent defines VMAgent to balance incoming traffic between VMClusters. |
-| vmcluster#
_[VMDistributedZoneCluster](#vmdistributedzonecluster)_ | _(Optional)_
VMCluster defines VictoriaMetrics cluster database |
-| vmsingle#
_[VMDistributedZoneSingle](#vmdistributedzonesingle)_ | _(Optional)_
VMSingle defines VictoriaMetrics single-node database. |
+| readyTimeout#
_[Duration (v1)](#v1-duration)_ | _(Optional)_
ReadyTimeout is the readiness timeout for each zone update. |
+| remoteWrite#
_[VMDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vmdistributedzoneremotewritespec)_ | _(Optional)_
RemoteWrite defines VMAgent remote write settings for given zone |
+| updatePause#
_[Duration (v1)](#v1-duration)_ | _(Optional)_
UpdatePause is the time the operator should wait between zone updates to ensure a smooth transition. |
+| vmagent#
_[VMDistributedZoneAgent (v1alpha1)](#v1alpha1-vmdistributedzoneagent)_ | _(Optional)_
VMAgent defines VMAgent to balance incoming traffic between VMClusters. |
+| vmcluster#
_[VMDistributedZoneCluster (v1alpha1)](#v1alpha1-vmdistributedzonecluster)_ | _(Optional)_
VMCluster defines VictoriaMetrics cluster database |
+| vmsingle#
_[VMDistributedZoneSingle (v1alpha1)](#v1alpha1-vmdistributedzonesingle)_ | _(Optional)_
VMSingle defines VictoriaMetrics single-node database. |
-#### VMDistributedZoneRemoteWriteSpec
+#### VMDistributedZoneRemoteWriteSpec {#v1alpha1-vmdistributedzoneremotewritespec}
VMDistributedZoneRemoteWriteSpec is a copy of VMAgentRemoteWriteSpec, which allows empty URLs and has no relabeling or stream aggregation
These urls will be overwritten by the controller
-Appears in: [VMDistributedZone](#vmdistributedzone), [VMDistributedZoneCommon](#vmdistributedzonecommon)
+Appears in: [VMDistributedZone (v1alpha1)](#v1alpha1-vmdistributedzone), [VMDistributedZoneCommon (v1alpha1)](#v1alpha1-vmdistributedzonecommon)
| Field | Description |
| --- | --- |
-| aws#
_[AWS](#aws)_ | _(Required)_
AWS describes params specific to AWS cloud |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
-| bearerTokenSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Optional bearer auth token to use for -remoteWrite.url |
-| forceVMProto#
_boolean_ | _(Optional)_
ForceVMProto forces using VictoriaMetrics protocol for sending data to -remoteWrite.url |
-| headers
_string array_ | _(Optional)_
Headers allow configuring custom http headers
Must be in form of semicolon separated header with value
e.g.
headerName: headerValue
vmagent supports since 1.79.0 version |
-| maxDiskUsage#
_[BytesString](#bytesstring)_ | _(Optional)_
MaxDiskUsage defines the maximum file-based buffer size in bytes for the given remoteWrite
It overrides global configuration defined at remoteWriteSettings.maxDiskUsagePerURL |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL for -remoteWrite.url. Supported proxies: http, https, socks5. Example: socks5://proxy:1234 |
-| sendTimeout#
_string_ | _(Optional)_
Timeout for sending a single block of data to -remoteWrite.url (default 1m0s) |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig describes tls configuration for remote write target |
+| aws#
_[AWS (v1beta1)](#v1beta1-aws)_ | _(Required)_
AWS describes params specific to AWS cloud |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
+| bearerTokenSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Optional bearer auth token to use for -remoteWrite.url |
+| forceVMProto#
_boolean_ | _(Optional)_
ForceVMProto forces using VictoriaMetrics protocol for sending data to -remoteWrite.url |
+| headers
_string array_ | _(Optional)_
Headers allow configuring custom http headers
Must be in form of semicolon separated header with value
e.g.
headerName: headerValue
vmagent supports since 1.79.0 version |
+| maxDiskUsage#
_[BytesString (v1beta1)](#v1beta1-bytesstring)_ | _(Optional)_
MaxDiskUsage defines the maximum file-based buffer size in bytes for the given remoteWrite
It overrides global configuration defined at remoteWriteSettings.maxDiskUsagePerURL |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL for -remoteWrite.url. Supported proxies: http, https, socks5. Example: socks5://proxy:1234 |
+| sendTimeout#
_string_ | _(Optional)_
Timeout for sending a single block of data to -remoteWrite.url (default 1m0s) |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLSConfig describes tls configuration for remote write target |
-#### VMDistributedZoneSingle
+#### VMDistributedZoneSingle {#v1alpha1-vmdistributedzonesingle}
VMDistributedZoneSingle defines the name and specification of a VMSingle to be created or updated.
-Appears in: [VMDistributedZone](#vmdistributedzone), [VMDistributedZoneCommon](#vmdistributedzonecommon)
+Appears in: [VMDistributedZone (v1alpha1)](#v1alpha1-vmdistributedzone), [VMDistributedZoneCommon (v1alpha1)](#v1alpha1-vmdistributedzonecommon)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the new VMSingle. |
-| spec#
_[VMSingleSpec](#vmsinglespec)_ | _(Optional)_
Spec defines the desired state of a new or update spec for existing VMSingle. |
+| name#
_string_ | _(Optional)_
Name specifies the static name to be used for the new VMSingle. |
+| spec#
_[VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)_ | _(Optional)_
Spec defines the desired state of a new or update spec for existing VMSingle. |
## operator.victoriametrics.com/v1beta1
Package v1beta1 contains API Schema definitions for the victoriametrics v1beta1 API group
### Resource Types
-- [VLogs](#vlogs)
-- [VMAgent](#vmagent)
-- [VMAlert](#vmalert)
-- [VMAlertmanager](#vmalertmanager)
-- [VMAlertmanagerConfig](#vmalertmanagerconfig)
-- [VMAuth](#vmauth)
-- [VMCluster](#vmcluster)
-- [VMNodeScrape](#vmnodescrape)
-- [VMPodScrape](#vmpodscrape)
-- [VMProbe](#vmprobe)
-- [VMRule](#vmrule)
-- [VMScrapeConfig](#vmscrapeconfig)
-- [VMServiceScrape](#vmservicescrape)
-- [VMSingle](#vmsingle)
-- [VMStaticScrape](#vmstaticscrape)
-- [VMUser](#vmuser)
-
-#### APIServerConfig
+- [VLogs](#v1beta1-vlogs)
+- [VMAgent](#v1beta1-vmagent)
+- [VMAlert](#v1beta1-vmalert)
+- [VMAlertmanager](#v1beta1-vmalertmanager)
+- [VMAlertmanagerConfig](#v1beta1-vmalertmanagerconfig)
+- [VMAuth](#v1beta1-vmauth)
+- [VMCluster](#v1beta1-vmcluster)
+- [VMNodeScrape](#v1beta1-vmnodescrape)
+- [VMPodScrape](#v1beta1-vmpodscrape)
+- [VMProbe](#v1beta1-vmprobe)
+- [VMRule](#v1beta1-vmrule)
+- [VMScrapeConfig](#v1beta1-vmscrapeconfig)
+- [VMServiceScrape](#v1beta1-vmservicescrape)
+- [VMSingle](#v1beta1-vmsingle)
+- [VMStaticScrape](#v1beta1-vmstaticscrape)
+- [VMUser](#v1beta1-vmuser)
+
+#### APIServerConfig {#v1beta1-apiserverconfig}
APIServerConfig defines a host and auth methods to access apiserver.
-Appears in: [VMAgentSpec](#vmagentspec), [VMSingleSpec](#vmsinglespec)
+Appears in: [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
|
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
-| bearerToken#
_string_ | _(Optional)_
Bearer token for accessing apiserver. |
-| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for accessing apiserver. |
-| host#
_string_ | _(Required)_
Host of apiserver.
A valid string consisting of a hostname or IP followed by an optional port number |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig Config to use for accessing apiserver. |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
|
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
+| bearerToken#
_string_ | _(Optional)_
Bearer token for accessing apiserver. |
+| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for accessing apiserver. |
+| host#
_string_ | _(Required)_
Host of apiserver.
A valid string consisting of a hostname or IP followed by an optional port number |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLSConfig Config to use for accessing apiserver. |
-#### AWS
+#### AWS {#v1beta1-aws}
AWS defines AWS cloud auth specific params
-Appears in: [VMAgentRemoteWriteSpec](#vmagentremotewritespec), [VMDistributedZoneRemoteWriteSpec](#vmdistributedzoneremotewritespec)
+Appears in: [VMAgentRemoteWriteSpec (v1beta1)](#v1beta1-vmagentremotewritespec), [VMDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vmdistributedzoneremotewritespec)
| Field | Description |
| --- | --- |
-| ec2Endpoint#
_string_ | _(Required)_
EC2Endpoint is an optional AWS EC2 API endpoint to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set |
-| region#
_string_ | _(Required)_
Region is an optional AWS region to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set |
-| roleARN#
_string_ | _(Required)_
RoleARN is an optional AWS region to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set |
-| service#
_string_ | _(Required)_
Service is an optional AWS Service to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set |
-| stsEndpoint#
_string_ | _(Required)_
STSEndpoint is an optional AWS STS API endpoint to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set |
-| useSigv4#
_boolean_ | _(Required)_
UseSigv4 enables SigV4 request signing for the corresponding -remoteWrite.url |
+| ec2Endpoint#
_string_ | _(Required)_
EC2Endpoint is an optional AWS EC2 API endpoint to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set |
+| region#
_string_ | _(Required)_
Region is an optional AWS region to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set |
+| roleARN#
_string_ | _(Required)_
RoleARN is an optional AWS region to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set |
+| service#
_string_ | _(Required)_
Service is an optional AWS Service to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set |
+| stsEndpoint#
_string_ | _(Required)_
STSEndpoint is an optional AWS STS API endpoint to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set |
+| useSigv4#
_boolean_ | _(Required)_
UseSigv4 enables SigV4 request signing for the corresponding -remoteWrite.url |
-#### AdditionalServiceSpec
+#### AdditionalServiceSpec {#v1beta1-additionalservicespec}
ServiceSpec defines additional service for CRD with user-defined params.
by default, some of fields can be inherited from default service definition for the CRD:
@@ -1619,15 +1619,15 @@ labels,selector, ports.
if metadata.name is not defined, service will have format {{CRD_TYPE}}-{{CRD_NAME}}-additional-service.
if UseAsDefault is set to true, changes applied to the main service without additional service creation
-Appears in: [VLAgentSpec](#vlagentspec), [VLInsert](#vlinsert), [VLSelect](#vlselect), [VLSingleSpec](#vlsinglespec), [VLStorage](#vlstorage), [VLogsSpec](#vlogsspec), [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAuthLoadBalancerSpec](#vmauthloadbalancerspec), [VMAuthSpec](#vmauthspec), [VMInsert](#vminsert), [VMSelect](#vmselect), [VMSingleSpec](#vmsinglespec), [VMStorage](#vmstorage), [VTInsert](#vtinsert), [VTSelect](#vtselect), [VTSingleSpec](#vtsinglespec), [VTStorage](#vtstorage)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec), [VLInsert (v1)](#v1-vlinsert), [VLSelect (v1)](#v1-vlselect), [VLSingleSpec (v1)](#v1-vlsinglespec), [VLStorage (v1)](#v1-vlstorage), [VLogsSpec (v1beta1)](#v1beta1-vlogsspec), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAuthLoadBalancerSpec (v1beta1)](#v1beta1-vmauthloadbalancerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMInsert (v1beta1)](#v1beta1-vminsert), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTInsert (v1)](#v1-vtinsert), [VTSelect (v1)](#v1-vtselect), [VTSingleSpec (v1)](#v1-vtsinglespec), [VTStorage (v1)](#v1-vtstorage)
| Field | Description |
| --- | --- |
-| metadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Optional)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[ServiceSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#servicespec-v1-core)_ | _(Required)_
ServiceSpec describes the attributes that a user creates on a service.
More info: https://kubernetes.io/docs/concepts/services-networking/service/ |
-| useAsDefault#
_boolean_ | _(Optional)_
UseAsDefault applies changes from given service definition to the main object Service
Changing from headless service to clusterIP or loadbalancer may break cross-component communication |
+| metadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Optional)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[ServiceSpec (v1)](#v1-servicespec)_ | _(Required)_
ServiceSpec describes the attributes that a user creates on a service.
More info: https://kubernetes.io/docs/concepts/services-networking/service/ |
+| useAsDefault#
_boolean_ | _(Optional)_
UseAsDefault applies changes from given service definition to the main object Service
Changing from headless service to clusterIP or loadbalancer may break cross-component communication |
-#### ArbitraryFSAccessThroughSMsConfig
+#### ArbitraryFSAccessThroughSMsConfig {#v1beta1-arbitraryfsaccessthroughsmsconfig}
ArbitraryFSAccessThroughSMsConfig enables users to configure, whether
a service scrape selected by the vmagent instance is allowed to use
@@ -1638,777 +1638,777 @@ in the vmagent container. Those secrets would then be sent with a scrape
request by vmagent to a malicious target. Denying the above would prevent the
attack, users can instead use the BearerTokenSecret field.
-Appears in: [CommonScrapeParams](#commonscrapeparams), [CommonScrapeSecurityEnforcements](#commonscrapesecurityenforcements), [VMAgentSpec](#vmagentspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAuthSpec](#vmauthspec), [VMSingleSpec](#vmsinglespec)
+Appears in: [CommonScrapeParams (v1beta1)](#v1beta1-commonscrapeparams), [CommonScrapeSecurityEnforcements (v1beta1)](#v1beta1-commonscrapesecurityenforcements), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
| Field | Description |
| --- | --- |
-| deny#
_boolean_ | _(Required)_
|
+| deny#
_boolean_ | _(Required)_
|
-#### AttachMetadata
+#### AttachMetadata {#v1beta1-attachmetadata}
AttachMetadata configures metadata attachment
-Appears in: [Endpoint](#endpoint), [KubernetesSDConfig](#kubernetessdconfig), [PodMetricsEndpoint](#podmetricsendpoint), [ScrapeClass](#scrapeclass), [VMPodScrapeSpec](#vmpodscrapespec), [VMServiceScrapeSpec](#vmservicescrapespec)
+Appears in: [Endpoint (v1beta1)](#v1beta1-endpoint), [KubernetesSDConfig (v1beta1)](#v1beta1-kubernetessdconfig), [PodMetricsEndpoint (v1beta1)](#v1beta1-podmetricsendpoint), [ScrapeClass (v1beta1)](#v1beta1-scrapeclass), [VMPodScrapeSpec (v1beta1)](#v1beta1-vmpodscrapespec), [VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)
| Field | Description |
| --- | --- |
-| namespace#
_boolean_ | _(Required)_
Namespace instructs vmagent or vmsingle to add namespace specific metadata from service discovery
Valid for roles: pod, service, endpoints, endpointslice, ingress. |
-| node#
_boolean_ | _(Optional)_
Node instructs vmagent or vmsingle to add node specific metadata from service discovery
Valid for roles: pod, endpoints, endpointslice. |
+| namespace#
_boolean_ | _(Required)_
Namespace instructs vmagent or vmsingle to add namespace specific metadata from service discovery
Valid for roles: pod, service, endpoints, endpointslice, ingress. |
+| node#
_boolean_ | _(Optional)_
Node instructs vmagent or vmsingle to add node specific metadata from service discovery
Valid for roles: pod, endpoints, endpointslice. |
-#### Authorization
+#### Authorization {#v1beta1-authorization}
Authorization configures generic authorization params
-Appears in: [APIServerConfig](#apiserverconfig), [AzureSDConfig](#azuresdconfig), [ConsulAgentSDConfig](#consulagentsdconfig), [ConsulSDConfig](#consulsdconfig), [DigitalOceanSDConfig](#digitaloceansdconfig), [DockerSDConfig](#dockersdconfig), [DockerSwarmSDConfig](#dockerswarmsdconfig), [Endpoint](#endpoint), [EndpointAuth](#endpointauth), [EndpointScrapeParams](#endpointscrapeparams), [EurekaSDConfig](#eurekasdconfig), [HTTPConfig](#httpconfig), [HTTPSDConfig](#httpsdconfig), [HTTPSDOptions](#httpsdoptions), [HetznerSDConfig](#hetznersdconfig), [KubernetesSDConfig](#kubernetessdconfig), [KumaSDConfig](#kumasdconfig), [MarathonSDConfig](#marathonsdconfig), [NomadSDConfig](#nomadsdconfig), [OVHCloudSDConfig](#ovhcloudsdconfig), [PodMetricsEndpoint](#podmetricsendpoint), [ProxyClientConfig](#proxyclientconfig), [PuppetDBSDConfig](#puppetdbsdconfig), [ScrapeClass](#scrapeclass), [TargetEndpoint](#targetendpoint), [VMNodeScrapeSpec](#vmnodescrapespec), [VMProbeSpec](#vmprobespec), [VMScrapeConfigSpec](#vmscrapeconfigspec), [VultrSDConfig](#vultrsdconfig)
+Appears in: [APIServerConfig (v1beta1)](#v1beta1-apiserverconfig), [AzureSDConfig (v1beta1)](#v1beta1-azuresdconfig), [ConsulAgentSDConfig (v1beta1)](#v1beta1-consulagentsdconfig), [ConsulSDConfig (v1beta1)](#v1beta1-consulsdconfig), [DigitalOceanSDConfig (v1beta1)](#v1beta1-digitaloceansdconfig), [DockerSDConfig (v1beta1)](#v1beta1-dockersdconfig), [DockerSwarmSDConfig (v1beta1)](#v1beta1-dockerswarmsdconfig), [Endpoint (v1beta1)](#v1beta1-endpoint), [EndpointAuth (v1beta1)](#v1beta1-endpointauth), [EndpointScrapeParams (v1beta1)](#v1beta1-endpointscrapeparams), [EurekaSDConfig (v1beta1)](#v1beta1-eurekasdconfig), [HTTPConfig (v1beta1)](#v1beta1-httpconfig), [HTTPSDConfig (v1beta1)](#v1beta1-httpsdconfig), [HTTPSDOptions (v1beta1)](#v1beta1-httpsdoptions), [HetznerSDConfig (v1beta1)](#v1beta1-hetznersdconfig), [KubernetesSDConfig (v1beta1)](#v1beta1-kubernetessdconfig), [KumaSDConfig (v1beta1)](#v1beta1-kumasdconfig), [MarathonSDConfig (v1beta1)](#v1beta1-marathonsdconfig), [NomadSDConfig (v1beta1)](#v1beta1-nomadsdconfig), [OVHCloudSDConfig (v1beta1)](#v1beta1-ovhcloudsdconfig), [PodMetricsEndpoint (v1beta1)](#v1beta1-podmetricsendpoint), [ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig), [PuppetDBSDConfig (v1beta1)](#v1beta1-puppetdbsdconfig), [ScrapeClass (v1beta1)](#v1beta1-scrapeclass), [TargetEndpoint (v1beta1)](#v1beta1-targetendpoint), [VMNodeScrapeSpec (v1beta1)](#v1beta1-vmnodescrapespec), [VMProbeSpec (v1beta1)](#v1beta1-vmprobespec), [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec), [VultrSDConfig (v1beta1)](#v1beta1-vultrsdconfig)
| Field | Description |
| --- | --- |
-| credentials#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Required)_
Reference to the secret with value for authorization |
-| credentialsFile#
_string_ | _(Optional)_
File with value for authorization |
-| type#
_string_ | _(Optional)_
Type of authorization, default to bearer |
+| credentials#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Required)_
Reference to the secret with value for authorization |
+| credentialsFile#
_string_ | _(Optional)_
File with value for authorization |
+| type#
_string_ | _(Optional)_
Type of authorization, default to bearer |
-#### AzureSDConfig
+#### AzureSDConfig {#v1beta1-azuresdconfig}
AzureSDConfig allow retrieving scrape targets from Azure VMs.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#azure_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authenticationMethod#
_string_ | _(Optional)_
# The authentication method, either OAuth or ManagedIdentity.
See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| clientID#
_string_ | _(Optional)_
Optional client ID. Only required with the OAuth authentication method. |
-| clientSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Optional client secret. Only required with the OAuth authentication method. |
-| environment#
_string_ | _(Optional)_
The Azure environment. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| port#
_integer_ | _(Optional)_
The port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule. |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| resourceGroup#
_string_ | _(Optional)_
Optional resource group name. Limits discovery to this resource group. |
-| subscriptionID#
_string_ | _(Required)_
The subscription ID. Always required. |
-| tenantID#
_string_ | _(Optional)_
Optional tenant ID. Only required with the OAuth authentication method. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| authenticationMethod#
_string_ | _(Optional)_
# The authentication method, either OAuth or ManagedIdentity.
See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| clientID#
_string_ | _(Optional)_
Optional client ID. Only required with the OAuth authentication method. |
+| clientSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Optional client secret. Only required with the OAuth authentication method. |
+| environment#
_string_ | _(Optional)_
The Azure environment. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| port#
_integer_ | _(Optional)_
The port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule. |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| resourceGroup#
_string_ | _(Optional)_
Optional resource group name. Limits discovery to this resource group. |
+| subscriptionID#
_string_ | _(Required)_
The subscription ID. Always required. |
+| tenantID#
_string_ | _(Optional)_
Optional tenant ID. Only required with the OAuth authentication method. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### BasicAuth
+#### BasicAuth {#v1beta1-basicauth}
BasicAuth allow an endpoint to authenticate over basic authentication
-Appears in: [APIServerConfig](#apiserverconfig), [AzureSDConfig](#azuresdconfig), [ConsulAgentSDConfig](#consulagentsdconfig), [ConsulSDConfig](#consulsdconfig), [DigitalOceanSDConfig](#digitaloceansdconfig), [DockerSDConfig](#dockersdconfig), [DockerSwarmSDConfig](#dockerswarmsdconfig), [Endpoint](#endpoint), [EndpointAuth](#endpointauth), [EndpointScrapeParams](#endpointscrapeparams), [EurekaSDConfig](#eurekasdconfig), [HTTPAuth](#httpauth), [HTTPConfig](#httpconfig), [HTTPSDConfig](#httpsdconfig), [HTTPSDOptions](#httpsdoptions), [HetznerSDConfig](#hetznersdconfig), [KubernetesSDConfig](#kubernetessdconfig), [KumaSDConfig](#kumasdconfig), [MarathonSDConfig](#marathonsdconfig), [NomadSDConfig](#nomadsdconfig), [OVHCloudSDConfig](#ovhcloudsdconfig), [PodMetricsEndpoint](#podmetricsendpoint), [ProxyClientConfig](#proxyclientconfig), [PuppetDBSDConfig](#puppetdbsdconfig), [ScrapeClass](#scrapeclass), [TargetEndpoint](#targetendpoint), [VLAgentRemoteWriteSpec](#vlagentremotewritespec), [VLDistributedZoneRemoteWriteSpec](#vldistributedzoneremotewritespec), [VMAgentRemoteWriteSpec](#vmagentremotewritespec), [VMAlertDatasourceSpec](#vmalertdatasourcespec), [VMAlertNotifierSpec](#vmalertnotifierspec), [VMAlertRemoteReadSpec](#vmalertremotereadspec), [VMAlertRemoteWriteSpec](#vmalertremotewritespec), [VMAnomalyHTTPClientSpec](#vmanomalyhttpclientspec), [VMAnomalyMonitoringPushSpec](#vmanomalymonitoringpushspec), [VMAnomalyReadersSpec](#vmanomalyreadersspec), [VMAnomalyWritersSpec](#vmanomalywritersspec), [VMDistributedZoneRemoteWriteSpec](#vmdistributedzoneremotewritespec), [VMNodeScrapeSpec](#vmnodescrapespec), [VMProbeSpec](#vmprobespec), [VMScrapeConfigSpec](#vmscrapeconfigspec), [VultrSDConfig](#vultrsdconfig)
+Appears in: [APIServerConfig (v1beta1)](#v1beta1-apiserverconfig), [AzureSDConfig (v1beta1)](#v1beta1-azuresdconfig), [ConsulAgentSDConfig (v1beta1)](#v1beta1-consulagentsdconfig), [ConsulSDConfig (v1beta1)](#v1beta1-consulsdconfig), [DigitalOceanSDConfig (v1beta1)](#v1beta1-digitaloceansdconfig), [DockerSDConfig (v1beta1)](#v1beta1-dockersdconfig), [DockerSwarmSDConfig (v1beta1)](#v1beta1-dockerswarmsdconfig), [Endpoint (v1beta1)](#v1beta1-endpoint), [EndpointAuth (v1beta1)](#v1beta1-endpointauth), [EndpointScrapeParams (v1beta1)](#v1beta1-endpointscrapeparams), [EurekaSDConfig (v1beta1)](#v1beta1-eurekasdconfig), [HTTPAuth (v1beta1)](#v1beta1-httpauth), [HTTPConfig (v1beta1)](#v1beta1-httpconfig), [HTTPSDConfig (v1beta1)](#v1beta1-httpsdconfig), [HTTPSDOptions (v1beta1)](#v1beta1-httpsdoptions), [HetznerSDConfig (v1beta1)](#v1beta1-hetznersdconfig), [KubernetesSDConfig (v1beta1)](#v1beta1-kubernetessdconfig), [KumaSDConfig (v1beta1)](#v1beta1-kumasdconfig), [MarathonSDConfig (v1beta1)](#v1beta1-marathonsdconfig), [NomadSDConfig (v1beta1)](#v1beta1-nomadsdconfig), [OVHCloudSDConfig (v1beta1)](#v1beta1-ovhcloudsdconfig), [PodMetricsEndpoint (v1beta1)](#v1beta1-podmetricsendpoint), [ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig), [PuppetDBSDConfig (v1beta1)](#v1beta1-puppetdbsdconfig), [ScrapeClass (v1beta1)](#v1beta1-scrapeclass), [TargetEndpoint (v1beta1)](#v1beta1-targetendpoint), [VLAgentRemoteWriteSpec (v1)](#v1-vlagentremotewritespec), [VLDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vldistributedzoneremotewritespec), [VMAgentRemoteWriteSpec (v1beta1)](#v1beta1-vmagentremotewritespec), [VMAlertDatasourceSpec (v1beta1)](#v1beta1-vmalertdatasourcespec), [VMAlertNotifierSpec (v1beta1)](#v1beta1-vmalertnotifierspec), [VMAlertRemoteReadSpec (v1beta1)](#v1beta1-vmalertremotereadspec), [VMAlertRemoteWriteSpec (v1beta1)](#v1beta1-vmalertremotewritespec), [VMAnomalyHTTPClientSpec (v1)](#v1-vmanomalyhttpclientspec), [VMAnomalyMonitoringPushSpec (v1)](#v1-vmanomalymonitoringpushspec), [VMAnomalyReadersSpec (v1)](#v1-vmanomalyreadersspec), [VMAnomalyWritersSpec (v1)](#v1-vmanomalywritersspec), [VMDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vmdistributedzoneremotewritespec), [VMNodeScrapeSpec (v1beta1)](#v1beta1-vmnodescrapespec), [VMProbeSpec (v1beta1)](#v1beta1-vmprobespec), [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec), [VultrSDConfig (v1beta1)](#v1beta1-vultrsdconfig)
| Field | Description |
| --- | --- |
-| password#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Password defines reference for secret with password value
The secret needs to be in the same namespace as scrape object |
-| password_file#
_string_ | _(Optional)_
PasswordFile defines path to password file at disk
must be pre-mounted |
-| username#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Username defines reference for secret with username value
The secret needs to be in the same namespace as scrape object |
+| password#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Password defines reference for secret with password value
The secret needs to be in the same namespace as scrape object |
+| password_file#
_string_ | _(Optional)_
PasswordFile defines path to password file at disk
must be pre-mounted |
+| username#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Username defines reference for secret with username value
The secret needs to be in the same namespace as scrape object |
-#### BearerAuth
+#### BearerAuth {#v1beta1-bearerauth}
BearerAuth defines auth with bearer token
-Appears in: [HTTPAuth](#httpauth), [VMAlertDatasourceSpec](#vmalertdatasourcespec), [VMAlertNotifierSpec](#vmalertnotifierspec), [VMAlertRemoteReadSpec](#vmalertremotereadspec), [VMAlertRemoteWriteSpec](#vmalertremotewritespec), [VMAnomalyHTTPClientSpec](#vmanomalyhttpclientspec), [VMAnomalyMonitoringPushSpec](#vmanomalymonitoringpushspec), [VMAnomalyReadersSpec](#vmanomalyreadersspec), [VMAnomalyWritersSpec](#vmanomalywritersspec)
+Appears in: [HTTPAuth (v1beta1)](#v1beta1-httpauth), [VMAlertDatasourceSpec (v1beta1)](#v1beta1-vmalertdatasourcespec), [VMAlertNotifierSpec (v1beta1)](#v1beta1-vmalertnotifierspec), [VMAlertRemoteReadSpec (v1beta1)](#v1beta1-vmalertremotereadspec), [VMAlertRemoteWriteSpec (v1beta1)](#v1beta1-vmalertremotewritespec), [VMAnomalyHTTPClientSpec (v1)](#v1-vmanomalyhttpclientspec), [VMAnomalyMonitoringPushSpec (v1)](#v1-vmanomalymonitoringpushspec), [VMAnomalyReadersSpec (v1)](#v1-vmanomalyreadersspec), [VMAnomalyWritersSpec (v1)](#v1-vmanomalywritersspec)
| Field | Description |
| --- | --- |
-| bearerTokenFile#
_string_ | _(Optional)_
Path to bearer token file |
-| bearerTokenSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Optional bearer auth token to use for -remoteWrite.url |
+| bearerTokenFile#
_string_ | _(Optional)_
Path to bearer token file |
+| bearerTokenSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Optional bearer auth token to use for -remoteWrite.url |
-#### BytesString
+#### BytesString {#v1beta1-bytesstring}
_Underlying type:_ _string_
BytesString represents bytes value defined directly as integer
or as a string with suffix - kb,mb,gb,tb,KiB,MiB,GiB,TiB
-Appears in: [VLAgentRemoteWriteSettings](#vlagentremotewritesettings), [VLAgentRemoteWriteSpec](#vlagentremotewritespec), [VLDistributedZoneRemoteWriteSpec](#vldistributedzoneremotewritespec), [VLSingleSpec](#vlsinglespec), [VLStorage](#vlstorage), [VMAgentRemoteWriteSettings](#vmagentremotewritesettings), [VMAgentRemoteWriteSpec](#vmagentremotewritespec), [VMDistributedZoneRemoteWriteSpec](#vmdistributedzoneremotewritespec), [VTSingleSpec](#vtsinglespec), [VTStorage](#vtstorage)
+Appears in: [VLAgentRemoteWriteSettings (v1)](#v1-vlagentremotewritesettings), [VLAgentRemoteWriteSpec (v1)](#v1-vlagentremotewritespec), [VLDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vldistributedzoneremotewritespec), [VLSingleSpec (v1)](#v1-vlsinglespec), [VLStorage (v1)](#v1-vlstorage), [VMAgentRemoteWriteSettings (v1beta1)](#v1beta1-vmagentremotewritesettings), [VMAgentRemoteWriteSpec (v1beta1)](#v1beta1-vmagentremotewritespec), [VMDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vmdistributedzoneremotewritespec), [VTSingleSpec (v1)](#v1-vtsinglespec), [VTStorage (v1)](#v1-vtstorage)
-#### CRDRef
+#### CRDRef {#v1beta1-crdref}
CRDRef describe CRD target reference.
-Appears in: [TargetRef](#targetref)
+Appears in: [TargetRef (v1beta1)](#v1beta1-targetref)
| Field | Description |
| --- | --- |
-| kind#
_string_ | _(Required)_
Kind one of:
VMAgent,VMAlert, VMSingle, VMCluster/vmselect, VMCluster/vmstorage,VMCluster/vminsert,VMAlertManager, VLSingle, VLCluster/vlinsert, VLCluster/vlselect, VLCluster/vlstorage, VTSingle, VTCluster/vtinsert, VTCluster/vtselect, VTCluster/vtstorage VMAnomaly and VLAgent |
-| name#
_string_ | _(Required)_
Name of the target Kubernetes object |
-| namespace#
_string_ | _(Required)_
Namespace of the target Kubernetes object |
-| objects#
_[NamespacedName](#namespacedname) array_ | _(Optional)_
Objects defines list of name/namespace pairs that define existing k8s object |
-| useExtraService
_boolean_ | _(Optional)_
UseExtraService instructs the operator to prefer the CR's additional service
(created via spec.serviceSpec) over the default service when building the target URL. |
+| kind#
_string_ | _(Required)_
Kind one of:
VMAgent,VMAlert, VMSingle, VMCluster/vmselect, VMCluster/vmstorage,VMCluster/vminsert,VMAlertManager, VLSingle, VLCluster/vlinsert, VLCluster/vlselect, VLCluster/vlstorage, VTSingle, VTCluster/vtinsert, VTCluster/vtselect, VTCluster/vtstorage VMAnomaly and VLAgent |
+| name#
_string_ | _(Required)_
Name of the target Kubernetes object |
+| namespace#
_string_ | _(Required)_
Namespace of the target Kubernetes object |
+| objects#
_[NamespacedName (v1beta1)](#v1beta1-namespacedname) array_ | _(Optional)_
Objects defines list of name/namespace pairs that define existing k8s object |
+| useExtraService
_boolean_ | _(Optional)_
UseExtraService instructs the operator to prefer the CR's additional service
(created via spec.serviceSpec) over the default service when building the target URL. |
-#### Certs
+#### Certs {#v1beta1-certs}
Certs defines TLS certs configuration
-Appears in: [TLSClientConfig](#tlsclientconfig), [TLSServerConfig](#tlsserverconfig)
+Appears in: [TLSClientConfig (v1beta1)](#v1beta1-tlsclientconfig), [TLSServerConfig (v1beta1)](#v1beta1-tlsserverconfig)
| Field | Description |
| --- | --- |
-| cert_file#
_string_ | _(Optional)_
CertFile defines path to the pre-mounted file with certificate
mutually exclusive with CertSecretRef |
-| cert_secret_ref#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
CertSecretRef defines reference for secret with certificate content under given key
mutually exclusive with CertFile |
-| key_file#
_string_ | _(Optional)_
KeyFile defines path to the pre-mounted file with certificate key
mutually exclusive with KeySecretRef |
-| key_secret_ref#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Key defines reference for secret with certificate key content under given key
mutually exclusive with KeyFile |
+| cert_file#
_string_ | _(Optional)_
CertFile defines path to the pre-mounted file with certificate
mutually exclusive with CertSecretRef |
+| cert_secret_ref#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
CertSecretRef defines reference for secret with certificate content under given key
mutually exclusive with CertFile |
+| key_file#
_string_ | _(Optional)_
KeyFile defines path to the pre-mounted file with certificate key
mutually exclusive with KeySecretRef |
+| key_secret_ref#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Key defines reference for secret with certificate key content under given key
mutually exclusive with KeyFile |
-#### CommonAppsParams
+#### CommonAppsParams {#v1beta1-commonappsparams}
CommonAppsParams defines common params
for deployment and statefulset specifications
-Appears in: [VLAgentSpec](#vlagentspec), [VLDistributedZoneAgentSpec](#vldistributedzoneagentspec), [VLInsert](#vlinsert), [VLSelect](#vlselect), [VLSingleSpec](#vlsinglespec), [VLStorage](#vlstorage), [VLogsSpec](#vlogsspec), [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAnomalySpec](#vmanomalyspec), [VMAuthLoadBalancerSpec](#vmauthloadbalancerspec), [VMAuthSpec](#vmauthspec), [VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec), [VMInsert](#vminsert), [VMSelect](#vmselect), [VMSingleSpec](#vmsinglespec), [VMStorage](#vmstorage), [VTInsert](#vtinsert), [VTSelect](#vtselect), [VTSingleSpec](#vtsinglespec), [VTStorage](#vtstorage)
-
-| Field | Description |
-| --- | --- |
-| affinity#
_[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#affinity-v1-core)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
-| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
-| containers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
-| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
-| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
-| dnsConfig#
_[PodDNSConfig](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#poddnsconfig-v1-core)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
-| dnsPolicy#
_[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#dnspolicy-v1-core)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
-| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
-| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
-| extraEnvs
_[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
-| extraEnvsFrom
_[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envfromsource-v1-core) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
-| hostAliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
-| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
-| host_aliases#
_[HostAlias](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostalias-v1-core) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
-| image#
_[Image](#image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
-| imagePullSecrets#
_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
-| initContainers#
_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#container-v1-core) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
-| livenessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
-| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
-| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
-| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
-| port#
_string_ | _(Optional)_
Port listen address |
-| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
-| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
-| readinessGates#
_[PodReadinessGate](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#podreadinessgate-v1-core) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
-| readinessProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
-| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
-| resources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
-| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
-| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
-| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
-| securityContext#
_[SecurityContext](#securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
-| startupProbe#
_[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#probe-v1-core)_ | _(Optional)_
StartupProbe that will be added to CR pod |
-| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
-| tolerations#
_[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#toleration-v1-core) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
-| topologySpreadConstraints#
_[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#topologyspreadconstraint-v1-core) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
-| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
-| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
-| volumeMounts#
_[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volumemount-v1-core) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
-| volumes#
_[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#volume-v1-core) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
-
-#### CommonConfigReloaderParams
-
-Appears in: [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAuthSpec](#vmauthspec), [VMSingleSpec](#vmsinglespec)
-
-| Field | Description |
-| --- | --- |
-| configReloadAuthKeySecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
ConfigReloadAuthKeySecret defines optional secret reference authKey for /-/reload API requests.
Given secret reference will be added to the application and vm-config-reloader as volume
Available from: v0.57.0 |
-| configReloaderExtraArgs
_object (keys:string, values:string)_ | _(Optional)_
ConfigReloaderExtraArgs that will be passed to VMAuths config-reloader container
for example resync-interval: "30s" |
-| configReloaderImage#
_string_ | _(Optional)_
ConfigReloaderImage defines image:tag for config-reloader container |
-| configReloaderImageTag#
_string_ | _(Optional)_
ConfigReloaderImageTag defines image:tag for config-reloader container
Deprecated: since version v0.67.0 will be removed in v0.69.0 use configReloaderImage instead
|
-| configReloaderResources#
_[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core)_ | _(Optional)_
ConfigReloaderResources config-reloader container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
-| useVMConfigReloader#
_boolean_ | _(Optional)_
UseVMConfigReloader replaces prometheus-like config-reloader
with vm one. It uses secrets watch instead of file watch
which greatly increases speed of config updates
Deprecated: will be removed in v0.67.0
|
-
-#### CommonRelabelParams
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec), [VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec), [VLInsert (v1)](#v1-vlinsert), [VLSelect (v1)](#v1-vlselect), [VLSingleSpec (v1)](#v1-vlsinglespec), [VLStorage (v1)](#v1-vlstorage), [VLogsSpec (v1beta1)](#v1beta1-vlogsspec), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAnomalySpec (v1)](#v1-vmanomalyspec), [VMAuthLoadBalancerSpec (v1beta1)](#v1beta1-vmauthloadbalancerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec), [VMInsert (v1beta1)](#v1beta1-vminsert), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTInsert (v1)](#v1-vtinsert), [VTSelect (v1)](#v1-vtselect), [VTSingleSpec (v1)](#v1-vtsinglespec), [VTStorage (v1)](#v1-vtstorage)
+
+| Field | Description |
+| --- | --- |
+| affinity#
_[Affinity (v1)](#v1-affinity)_ | _(Optional)_
Affinity If specified, the pod's scheduling constraints. |
+| configMaps#
_string array_ | _(Optional)_
ConfigMaps is a list of ConfigMaps in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/configs/CONFIGMAP_NAME folder |
+| containers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc. |
+| disableAutomountServiceAccountToken#
_boolean_ | _(Optional)_
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes
Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access.
For example, vmagent and vm-config-reloader requires k8s API access.
Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed.
And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.
Available from: v0.54.0 |
+| disableSelfServiceScrape#
_boolean_ | _(Optional)_
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable |
+| dnsConfig#
_[PodDNSConfig (v1)](#v1-poddnsconfig)_ | _(Optional)_
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. |
+| dnsPolicy#
_[DNSPolicy (v1)](#v1-dnspolicy)_ | _(Optional)_
DNSPolicy sets DNS policy for the pod |
+| enableServiceLinks#
_boolean_ | _(Optional)_
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. |
+| extraArgs
_object (keys:string, values:string)_ | _(Optional)_
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp |
+| extraEnvs
_[EnvVar (v1)](#v1-envvar) array_ | _(Optional)_
ExtraEnvs that will be passed to the application container |
+| extraEnvsFrom
_[EnvFromSource (v1)](#v1-envfromsource) array_ | _(Optional)_
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap |
+| hostAliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork. |
+| hostNetwork#
_boolean_ | _(Optional)_
HostNetwork controls whether the pod may use the node network namespace |
+| host_aliases#
_[HostAlias (v1)](#v1-hostalias) array_ | _(Optional)_
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field |
+| image#
_[Image (v1beta1)](#v1beta1-image)_ | _(Optional)_
Image - docker image settings
if no specified operator uses default version from operator config |
+| imagePullSecrets#
_[LocalObjectReference (v1)](#v1-localobjectreference) array_ | _(Optional)_
ImagePullSecrets An optional list of references to secrets in the same namespace
to use for pulling images from registries
see https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
+| initContainers#
_[Container (v1)](#v1-container) array_ | _(Optional)_
InitContainers allows adding initContainers to the pod definition.
Any errors during the execution of an initContainer will lead to a restart of the Pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| livenessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
LivenessProbe that will be added to CR pod |
+| minReadySeconds#
_integer_ | _(Optional)_
MinReadySeconds defines a minimum number of seconds to wait before starting update next pod
if previous in healthy state
Has no effect for VLogs and VMSingle |
+| nodeSelector#
_object (keys:string, values:string)_ | _(Optional)_
NodeSelector Define which Nodes the Pods are scheduled on. |
+| paused#
_boolean_ | _(Optional)_
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions. |
+| port#
_string_ | _(Optional)_
Port listen address |
+| preStopSleepSeconds#
_integer_ | _(Optional)_
PreStopSleepSeconds defines the number of seconds to sleep in the preStop lifecycle hook.
It gives time for load balancers to remove the pod from rotation before the pod is terminated.
Defaults to 15 for applicable components. Set to 0 to disable. |
+| priorityClassName#
_string_ | _(Optional)_
PriorityClassName class assigned to the Pods |
+| readinessGates#
_[PodReadinessGate (v1)](#v1-podreadinessgate) array_ | _(Required)_
ReadinessGates defines pod readiness gates |
+| readinessProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
ReadinessProbe that will be added to CR pod |
+| replicaCount#
_integer_ | _(Optional)_
ReplicaCount is the expected size of the Application. |
+| resources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| revisionHistoryLimitCount#
_integer_ | _(Optional)_
The number of old ReplicaSets to retain to allow rollback in deployment or
maximum number of revisions that will be maintained in the Deployment revision history.
Has no effect at StatefulSets
Defaults to 10. |
+| runtimeClassName#
_string_ | _(Optional)_
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/ |
+| schedulerName#
_string_ | _(Optional)_
SchedulerName - defines kubernetes scheduler name |
+| secrets#
_string array_ | _(Optional)_
Secrets is a list of Secrets in the same namespace as the Application
object, which shall be mounted into the Application container
at /etc/vm/secrets/SECRET_NAME folder |
+| securityContext#
_[SecurityContext (v1beta1)](#v1beta1-securitycontext)_ | _(Optional)_
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext. |
+| startupProbe#
_[Probe (v1)](#v1-probe)_ | _(Optional)_
StartupProbe that will be added to CR pod |
+| terminationGracePeriodSeconds#
_integer_ | _(Optional)_
TerminationGracePeriodSeconds period for container graceful termination |
+| tolerations#
_[Toleration (v1)](#v1-toleration) array_ | _(Optional)_
Tolerations If specified, the pod's tolerations. |
+| topologySpreadConstraints#
_[TopologySpreadConstraint (v1)](#v1-topologyspreadconstraint) array_ | _(Optional)_
TopologySpreadConstraints embedded kubernetes pod configuration option,
controls how pods are spread across your cluster among failure-domains
such as regions, zones, nodes, and other user-defined topology domains
https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
+| useDefaultResources#
_boolean_ | _(Optional)_
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements |
+| useStrictSecurity#
_boolean_ | _(Optional)_
UseStrictSecurity enables strict security mode for component
it restricts disk writes access
uses non-root user out of the box
drops not needed security permissions |
+| volumeMounts#
_[VolumeMount (v1)](#v1-volumemount) array_ | _(Optional)_
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container |
+| volumes#
_[Volume (v1)](#v1-volume) array_ | _(Optional)_
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated. |
+
+#### CommonConfigReloaderParams {#v1beta1-commonconfigreloaderparams}
+
+Appears in: [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
+
+| Field | Description |
+| --- | --- |
+| configReloadAuthKeySecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
ConfigReloadAuthKeySecret defines optional secret reference authKey for /-/reload API requests.
Given secret reference will be added to the application and vm-config-reloader as volume
Available from: v0.57.0 |
+| configReloaderExtraArgs
_object (keys:string, values:string)_ | _(Optional)_
ConfigReloaderExtraArgs that will be passed to VMAuths config-reloader container
for example resync-interval: "30s" |
+| configReloaderImage#
_string_ | _(Optional)_
ConfigReloaderImage defines image:tag for config-reloader container |
+| configReloaderImageTag#
_string_ | _(Optional)_
ConfigReloaderImageTag defines image:tag for config-reloader container
Deprecated: since version v0.67.0 will be removed in v0.69.0 use configReloaderImage instead
|
+| configReloaderResources#
_[ResourceRequirements (v1)](#v1-resourcerequirements)_ | _(Optional)_
ConfigReloaderResources config-reloader container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
if not defined default resources from operator config will be used |
+| useVMConfigReloader#
_boolean_ | _(Optional)_
UseVMConfigReloader replaces prometheus-like config-reloader
with vm one. It uses secrets watch instead of file watch
which greatly increases speed of config updates
Deprecated: will be removed in v0.67.0
|
+
+#### CommonRelabelParams {#v1beta1-commonrelabelparams}
CommonRelabelParams defines params for relabelling
-Appears in: [VMAgentSpec](#vmagentspec), [VMSingleSpec](#vmsinglespec)
-
-| Field | Description |
-| --- | --- |
-| inlineRelabelConfig#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
InlineRelabelConfig - defines GlobalRelabelConfig for vmagent, can be defined directly at CRD. |
-| relabelConfig#
_[ConfigMapKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#configmapkeyselector-v1-core)_ | _(Optional)_
RelabelConfig ConfigMap with global relabel config -remoteWrite.relabelConfig
This relabeling is applied to all the collected metrics before sending them to remote storage. |
-
-#### CommonScrapeParams
-
-Appears in: [VMAgentSpec](#vmagentspec), [VMSingleSpec](#vmsinglespec)
-
-| Field | Description |
-| --- | --- |
-| additionalScrapeConfigs#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
AdditionalScrapeConfigs As scrape configs are appended, the user is responsible to make sure it
is valid. Note that using this feature may expose the possibility to
break upgrades of VMAgent or VMSingle. It is advised to review VMAgent or VMSingle release
notes to ensure that no incompatible scrape configs are going to break
VMAgent or VMSingle after the upgrade. |
-| arbitraryFSAccessThroughSMs#
_[ArbitraryFSAccessThroughSMsConfig](#arbitraryfsaccessthroughsmsconfig)_ | _(Optional)_
ArbitraryFSAccessThroughSMs configures whether configuration
based on EndpointAuth can access arbitrary files on the file system
of the VMAgent or VMSingle container e.g. bearer token files, basic auth, tls certs |
-| enableKubernetesAPISelectors#
_boolean_ | _(Optional)_
EnableKubernetesAPISelectors instructs vmagent or vmsingle to use CRD scrape objects spec.selectors for
Kubernetes API list and watch requests.
https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#list-and-watch-filtering
It could be useful to reduce Kubernetes API server resource usage for serving less than 100 CRD scrape objects in total. |
-| enforcedNamespaceLabel#
_string_ | _(Optional)_
EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert
and metric that is user created. The label value will always be the namespace of the object that is
being created. |
-| externalLabelName#
_string_ | _(Optional)_
ExternalLabelName Name of external label used to denote scraping agent instance
name. Defaults to the value of `prometheus`. External label will
_not_ be added when value is set to empty string (`""`). |
-| externalLabels#
_object (keys:string, values:string)_ | _(Optional)_
ExternalLabels The labels to add to any time series scraped by vmagent or vmsingle.
it doesn't affect metrics ingested directly by push API's |
-| globalScrapeMetricRelabelConfigs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
GlobalScrapeMetricRelabelConfigs is a global metric relabel configuration, which is applied to each scrape job. |
-| globalScrapeRelabelConfigs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
GlobalScrapeRelabelConfigs is a global relabel configuration, which is applied to each samples of each scrape job during service discovery. |
-| ignoreNamespaceSelectors#
_boolean_ | _(Optional)_
IgnoreNamespaceSelectors if set to true will ignore NamespaceSelector settings from
scrape objects, and they will only discover endpoints
within their current namespace. Defaults to false. |
-| ingestOnlyMode#
_boolean_ | _(Optional)_
IngestOnlyMode switches vmagent or vmsingle into unmanaged mode
it disables any config generation for scraping
Currently it prevents vmagent or vmsingle from managing tls and auth options for remote write |
-| inlineScrapeConfig#
_string_ | _(Optional)_
InlineScrapeConfig As scrape configs are appended, the user is responsible to make sure it
is valid. Note that using this feature may expose the possibility to
break upgrades of VMAgent or VMSingle. It is advised to review VMAgent or VMSingle release
notes to ensure that no incompatible scrape configs are going to break
VMAgent or VMSingle after the upgrade.
it should be defined as single yaml file.
inlineScrapeConfig: \|
- job_name: "prometheus"
static_configs:
- targets: ["localhost:9090"] |
-| maxScrapeInterval#
_string_ | _(Required)_
MaxScrapeInterval allows limiting maximum scrape interval for VMServiceScrape, VMPodScrape and other scrapes
If interval is higher than defined limit, `maxScrapeInterval` will be used. |
-| minScrapeInterval#
_string_ | _(Required)_
MinScrapeInterval allows limiting minimal scrape interval for VMServiceScrape, VMPodScrape and other scrapes
If interval is lower than defined limit, `minScrapeInterval` will be used. |
-| nodeScrapeNamespaceSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
NodeScrapeNamespaceSelector defines Namespaces to be selected for VMNodeScrape discovery.
Works in combination with Selector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
-| nodeScrapeRelabelTemplate#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
NodeScrapeRelabelTemplate defines relabel config, that will be added to each VMNodeScrape.
it's useful for adding specific labels to all targets |
-| nodeScrapeSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
NodeScrapeSelector defines VMNodeScrape to be selected for scraping.
Works in combination with NamespaceSelector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
-| overrideHonorLabels#
_boolean_ | _(Optional)_
OverrideHonorLabels if set to true overrides all user configured honor_labels.
If HonorLabels is set in scrape objects to true, this overrides honor_labels to false. |
-| overrideHonorTimestamps#
_boolean_ | _(Optional)_
OverrideHonorTimestamps allows to globally enforce honoring timestamps in all scrape configs. |
-| podScrapeNamespaceSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
PodScrapeNamespaceSelector defines Namespaces to be selected for VMPodScrape discovery.
Works in combination with Selector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
-| podScrapeRelabelTemplate#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
PodScrapeRelabelTemplate defines relabel config, that will be added to each VMPodScrape.
it's useful for adding specific labels to all targets |
-| podScrapeSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
PodScrapeSelector defines PodScrapes to be selected for target discovery.
Works in combination with NamespaceSelector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
-| probeNamespaceSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
ProbeNamespaceSelector defines Namespaces to be selected for VMProbe discovery.
Works in combination with Selector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
-| probeScrapeRelabelTemplate#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
ProbeScrapeRelabelTemplate defines relabel config, that will be added to each VMProbeScrape.
it's useful for adding specific labels to all targets |
-| probeSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
ProbeSelector defines VMProbe to be selected for target probing.
Works in combination with NamespaceSelector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
-| sampleLimit#
_integer_ | _(Optional)_
SampleLimit defines global per target limit of scraped samples |
-| scrapeClasses#
_[ScrapeClass](#scrapeclass) array_ | _(Optional)_
ScrapeClasses defines the list of scrape classes to expose to scraping objects such as
PodScrapes, ServiceScrapes, Probes and ScrapeConfigs. |
-| scrapeConfigNamespaceSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
ScrapeConfigNamespaceSelector defines Namespaces to be selected for VMScrapeConfig discovery.
Works in combination with Selector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
-| scrapeConfigRelabelTemplate#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
ScrapeConfigRelabelTemplate defines relabel config, that will be added to each VMScrapeConfig.
it's useful for adding specific labels to all targets |
-| scrapeConfigSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
ScrapeConfigSelector defines VMScrapeConfig to be selected for target discovery.
Works in combination with NamespaceSelector. |
-| scrapeInterval#
_string_ | _(Optional)_
ScrapeInterval defines how often scrape targets by default |
-| scrapeTimeout#
_string_ | _(Optional)_
ScrapeTimeout defines global timeout for targets scrape |
-| selectAllByDefault#
_boolean_ | _(Optional)_
SelectAllByDefault changes default behavior for empty CRD selectors, such ServiceScrapeSelector.
with selectAllByDefault: true and empty serviceScrapeSelector and ServiceScrapeNamespaceSelector
Operator selects all exist serviceScrapes
with selectAllByDefault: false - selects nothing |
-| serviceScrapeNamespaceSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
ServiceScrapeNamespaceSelector Namespaces to be selected for VMServiceScrape discovery.
Works in combination with Selector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
-| serviceScrapeRelabelTemplate#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
ServiceScrapeRelabelTemplate defines relabel config, that will be added to each VMServiceScrape.
it's useful for adding specific labels to all targets |
-| serviceScrapeSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
ServiceScrapeSelector defines ServiceScrapes to be selected for target discovery.
Works in combination with NamespaceSelector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
-| staticScrapeNamespaceSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
StaticScrapeNamespaceSelector defines Namespaces to be selected for VMStaticScrape discovery.
Works in combination with NamespaceSelector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
-| staticScrapeRelabelTemplate#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
StaticScrapeRelabelTemplate defines relabel config, that will be added to each VMStaticScrape.
it's useful for adding specific labels to all targets |
-| staticScrapeSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Optional)_
StaticScrapeSelector defines VMStaticScrape to be selected for target discovery.
Works in combination with NamespaceSelector.
If both nil - match everything.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces. |
-| vmAgentExternalLabelName#
_string_ | _(Optional)_
VMAgentExternalLabelName Name of vmAgent external label used to denote vmAgent instance
name. Defaults to the value of `prometheus`. External label will
_not_ be added when value is set to empty string (`""`).
Deprecated: since version v0.67.0 will be removed in v0.69.0 use externalLabelName instead
|
-
-#### CommonScrapeSecurityEnforcements
+Appears in: [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
+
+| Field | Description |
+| --- | --- |
+| inlineRelabelConfig#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
InlineRelabelConfig - defines GlobalRelabelConfig for vmagent, can be defined directly at CRD. |
+| relabelConfig#
_[ConfigMapKeySelector (v1)](#v1-configmapkeyselector)_ | _(Optional)_
RelabelConfig ConfigMap with global relabel config -remoteWrite.relabelConfig
This relabeling is applied to all the collected metrics before sending them to remote storage. |
+
+#### CommonScrapeParams {#v1beta1-commonscrapeparams}
+
+Appears in: [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
+
+| Field | Description |
+| --- | --- |
+| additionalScrapeConfigs#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
AdditionalScrapeConfigs As scrape configs are appended, the user is responsible to make sure it
is valid. Note that using this feature may expose the possibility to
break upgrades of VMAgent or VMSingle. It is advised to review VMAgent or VMSingle release
notes to ensure that no incompatible scrape configs are going to break
VMAgent or VMSingle after the upgrade. |
+| arbitraryFSAccessThroughSMs#
_[ArbitraryFSAccessThroughSMsConfig (v1beta1)](#v1beta1-arbitraryfsaccessthroughsmsconfig)_ | _(Optional)_
ArbitraryFSAccessThroughSMs configures whether configuration
based on EndpointAuth can access arbitrary files on the file system
of the VMAgent or VMSingle container e.g. bearer token files, basic auth, tls certs |
+| enableKubernetesAPISelectors#
_boolean_ | _(Optional)_
EnableKubernetesAPISelectors instructs vmagent or vmsingle to use CRD scrape objects spec.selectors for
Kubernetes API list and watch requests.
https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#list-and-watch-filtering
It could be useful to reduce Kubernetes API server resource usage for serving less than 100 CRD scrape objects in total. |
+| enforcedNamespaceLabel#
_string_ | _(Optional)_
EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert
and metric that is user created. The label value will always be the namespace of the object that is
being created. |
+| externalLabelName#
_string_ | _(Optional)_
ExternalLabelName Name of external label used to denote scraping agent instance
name. Defaults to the value of `prometheus`. External label will
_not_ be added when value is set to empty string (`""`). |
+| externalLabels#
_object (keys:string, values:string)_ | _(Optional)_
ExternalLabels The labels to add to any time series scraped by vmagent or vmsingle.
it doesn't affect metrics ingested directly by push API's |
+| globalScrapeMetricRelabelConfigs#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
GlobalScrapeMetricRelabelConfigs is a global metric relabel configuration, which is applied to each scrape job. |
+| globalScrapeRelabelConfigs#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
GlobalScrapeRelabelConfigs is a global relabel configuration, which is applied to each samples of each scrape job during service discovery. |
+| ignoreNamespaceSelectors#
_boolean_ | _(Optional)_
IgnoreNamespaceSelectors if set to true will ignore NamespaceSelector settings from
scrape objects, and they will only discover endpoints
within their current namespace. Defaults to false. |
+| ingestOnlyMode#
_boolean_ | _(Optional)_
IngestOnlyMode switches vmagent or vmsingle into unmanaged mode
it disables any config generation for scraping
Currently it prevents vmagent or vmsingle from managing tls and auth options for remote write |
+| inlineScrapeConfig#
_string_ | _(Optional)_
InlineScrapeConfig As scrape configs are appended, the user is responsible to make sure it
is valid. Note that using this feature may expose the possibility to
break upgrades of VMAgent or VMSingle. It is advised to review VMAgent or VMSingle release
notes to ensure that no incompatible scrape configs are going to break
VMAgent or VMSingle after the upgrade.
it should be defined as single yaml file.
inlineScrapeConfig: \|
- job_name: "prometheus"
static_configs:
- targets: ["localhost:9090"] |
+| maxScrapeInterval#
_string_ | _(Required)_
MaxScrapeInterval allows limiting maximum scrape interval for VMServiceScrape, VMPodScrape and other scrapes
If interval is higher than defined limit, `maxScrapeInterval` will be used. |
+| minScrapeInterval#
_string_ | _(Required)_
MinScrapeInterval allows limiting minimal scrape interval for VMServiceScrape, VMPodScrape and other scrapes
If interval is lower than defined limit, `minScrapeInterval` will be used. |
+| nodeScrapeNamespaceSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
NodeScrapeNamespaceSelector defines Namespaces to be selected for VMNodeScrape discovery.
Works in combination with Selector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
+| nodeScrapeRelabelTemplate#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
NodeScrapeRelabelTemplate defines relabel config, that will be added to each VMNodeScrape.
it's useful for adding specific labels to all targets |
+| nodeScrapeSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
NodeScrapeSelector defines VMNodeScrape to be selected for scraping.
Works in combination with NamespaceSelector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
+| overrideHonorLabels#
_boolean_ | _(Optional)_
OverrideHonorLabels if set to true overrides all user configured honor_labels.
If HonorLabels is set in scrape objects to true, this overrides honor_labels to false. |
+| overrideHonorTimestamps#
_boolean_ | _(Optional)_
OverrideHonorTimestamps allows to globally enforce honoring timestamps in all scrape configs. |
+| podScrapeNamespaceSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
PodScrapeNamespaceSelector defines Namespaces to be selected for VMPodScrape discovery.
Works in combination with Selector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
+| podScrapeRelabelTemplate#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
PodScrapeRelabelTemplate defines relabel config, that will be added to each VMPodScrape.
it's useful for adding specific labels to all targets |
+| podScrapeSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
PodScrapeSelector defines PodScrapes to be selected for target discovery.
Works in combination with NamespaceSelector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
+| probeNamespaceSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
ProbeNamespaceSelector defines Namespaces to be selected for VMProbe discovery.
Works in combination with Selector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
+| probeScrapeRelabelTemplate#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
ProbeScrapeRelabelTemplate defines relabel config, that will be added to each VMProbeScrape.
it's useful for adding specific labels to all targets |
+| probeSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
ProbeSelector defines VMProbe to be selected for target probing.
Works in combination with NamespaceSelector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
+| sampleLimit#
_integer_ | _(Optional)_
SampleLimit defines global per target limit of scraped samples |
+| scrapeClasses#
_[ScrapeClass (v1beta1)](#v1beta1-scrapeclass) array_ | _(Optional)_
ScrapeClasses defines the list of scrape classes to expose to scraping objects such as
PodScrapes, ServiceScrapes, Probes and ScrapeConfigs. |
+| scrapeConfigNamespaceSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
ScrapeConfigNamespaceSelector defines Namespaces to be selected for VMScrapeConfig discovery.
Works in combination with Selector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
+| scrapeConfigRelabelTemplate#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
ScrapeConfigRelabelTemplate defines relabel config, that will be added to each VMScrapeConfig.
it's useful for adding specific labels to all targets |
+| scrapeConfigSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
ScrapeConfigSelector defines VMScrapeConfig to be selected for target discovery.
Works in combination with NamespaceSelector. |
+| scrapeInterval#
_string_ | _(Optional)_
ScrapeInterval defines how often scrape targets by default |
+| scrapeTimeout#
_string_ | _(Optional)_
ScrapeTimeout defines global timeout for targets scrape |
+| selectAllByDefault#
_boolean_ | _(Optional)_
SelectAllByDefault changes default behavior for empty CRD selectors, such ServiceScrapeSelector.
with selectAllByDefault: true and empty serviceScrapeSelector and ServiceScrapeNamespaceSelector
Operator selects all exist serviceScrapes
with selectAllByDefault: false - selects nothing |
+| serviceScrapeNamespaceSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
ServiceScrapeNamespaceSelector Namespaces to be selected for VMServiceScrape discovery.
Works in combination with Selector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
+| serviceScrapeRelabelTemplate#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
ServiceScrapeRelabelTemplate defines relabel config, that will be added to each VMServiceScrape.
it's useful for adding specific labels to all targets |
+| serviceScrapeSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
ServiceScrapeSelector defines ServiceScrapes to be selected for target discovery.
Works in combination with NamespaceSelector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
+| staticScrapeNamespaceSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
StaticScrapeNamespaceSelector defines Namespaces to be selected for VMStaticScrape discovery.
Works in combination with NamespaceSelector.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces.
If both nil - behaviour controlled by selectAllByDefault |
+| staticScrapeRelabelTemplate#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
StaticScrapeRelabelTemplate defines relabel config, that will be added to each VMStaticScrape.
it's useful for adding specific labels to all targets |
+| staticScrapeSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Optional)_
StaticScrapeSelector defines VMStaticScrape to be selected for target discovery.
Works in combination with NamespaceSelector.
If both nil - match everything.
NamespaceSelector nil - only objects at VMAgent or VMSingle namespace.
Selector nil - only objects at NamespaceSelector namespaces. |
+| vmAgentExternalLabelName#
_string_ | _(Optional)_
VMAgentExternalLabelName Name of vmAgent external label used to denote vmAgent instance
name. Defaults to the value of `prometheus`. External label will
_not_ be added when value is set to empty string (`""`).
Deprecated: since version v0.67.0 will be removed in v0.69.0 use externalLabelName instead
|
+
+#### CommonScrapeSecurityEnforcements {#v1beta1-commonscrapesecurityenforcements}
CommonScrapeSecurityEnforcements defines security configuration for endpoint scrapping
-Appears in: [CommonScrapeParams](#commonscrapeparams), [VMAgentSpec](#vmagentspec), [VMSingleSpec](#vmsinglespec)
+Appears in: [CommonScrapeParams (v1beta1)](#v1beta1-commonscrapeparams), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
| Field | Description |
| --- | --- |
-| arbitraryFSAccessThroughSMs#
_[ArbitraryFSAccessThroughSMsConfig](#arbitraryfsaccessthroughsmsconfig)_ | _(Optional)_
ArbitraryFSAccessThroughSMs configures whether configuration
based on EndpointAuth can access arbitrary files on the file system
of the VMAgent or VMSingle container e.g. bearer token files, basic auth, tls certs |
-| enforcedNamespaceLabel#
_string_ | _(Optional)_
EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert
and metric that is user created. The label value will always be the namespace of the object that is
being created. |
-| ignoreNamespaceSelectors#
_boolean_ | _(Optional)_
IgnoreNamespaceSelectors if set to true will ignore NamespaceSelector settings from
scrape objects, and they will only discover endpoints
within their current namespace. Defaults to false. |
-| overrideHonorLabels#
_boolean_ | _(Optional)_
OverrideHonorLabels if set to true overrides all user configured honor_labels.
If HonorLabels is set in scrape objects to true, this overrides honor_labels to false. |
-| overrideHonorTimestamps#
_boolean_ | _(Optional)_
OverrideHonorTimestamps allows to globally enforce honoring timestamps in all scrape configs. |
+| arbitraryFSAccessThroughSMs#
_[ArbitraryFSAccessThroughSMsConfig (v1beta1)](#v1beta1-arbitraryfsaccessthroughsmsconfig)_ | _(Optional)_
ArbitraryFSAccessThroughSMs configures whether configuration
based on EndpointAuth can access arbitrary files on the file system
of the VMAgent or VMSingle container e.g. bearer token files, basic auth, tls certs |
+| enforcedNamespaceLabel#
_string_ | _(Optional)_
EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert
and metric that is user created. The label value will always be the namespace of the object that is
being created. |
+| ignoreNamespaceSelectors#
_boolean_ | _(Optional)_
IgnoreNamespaceSelectors if set to true will ignore NamespaceSelector settings from
scrape objects, and they will only discover endpoints
within their current namespace. Defaults to false. |
+| overrideHonorLabels#
_boolean_ | _(Optional)_
OverrideHonorLabels if set to true overrides all user configured honor_labels.
If HonorLabels is set in scrape objects to true, this overrides honor_labels to false. |
+| overrideHonorTimestamps#
_boolean_ | _(Optional)_
OverrideHonorTimestamps allows to globally enforce honoring timestamps in all scrape configs. |
-#### ConfigMapKeyReference
+#### ConfigMapKeyReference {#v1beta1-configmapkeyreference}
ConfigMapKeyReference refers to a key in a ConfigMap.
-Appears in: [VMAlertmanagerSpec](#vmalertmanagerspec)
+Appears in: [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec)
| Field | Description |
| --- | --- |
-| key#
_string_ | _(Required)_
The ConfigMap key to refer to. |
-| name#
_string_ | _(Optional)_
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 |
+| key#
_string_ | _(Required)_
The ConfigMap key to refer to. |
+| name#
_string_ | _(Optional)_
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 |
-#### ConsulAgentSDConfig
+#### ConsulAgentSDConfig {#v1beta1-consulagentsdconfig}
ConsulAgentSDConfig configurations allows retrieving scrape targets from a local Consul Agent.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#consulagent_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| datacenter#
_string_ | _(Optional)_
Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter. |
-| filter#
_string_ | _(Optional)_
Filter defines filter for service discovery requests.
See https://developer.hashicorp.com/consul/api-docs/features/filtering |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| namespace#
_string_ | _(Optional)_
Namespaces are only supported in Consul Enterprise. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| scheme#
_string_ | _(Optional)_
HTTP Scheme default "http" |
-| server#
_string_ | _(Optional)_
Server address of the Consul Agent. Defaults to localhost:8500. |
-| services#
_string array_ | _(Optional)_
A list of services for which targets are retrieved. If omitted, all services are scraped. |
-| tagSeparator#
_string_ | _(Optional)_
The string by which Consul tags are joined into the tag label. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-| tokenRef#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent. |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| datacenter#
_string_ | _(Optional)_
Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter. |
+| filter#
_string_ | _(Optional)_
Filter defines filter for service discovery requests.
See https://developer.hashicorp.com/consul/api-docs/features/filtering |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| namespace#
_string_ | _(Optional)_
Namespaces are only supported in Consul Enterprise. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| scheme#
_string_ | _(Optional)_
HTTP Scheme default "http" |
+| server#
_string_ | _(Optional)_
Server address of the Consul Agent. Defaults to localhost:8500. |
+| services#
_string array_ | _(Optional)_
A list of services for which targets are retrieved. If omitted, all services are scraped. |
+| tagSeparator#
_string_ | _(Optional)_
The string by which Consul tags are joined into the tag label. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| tokenRef#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent. |
-#### ConsulSDConfig
+#### ConsulSDConfig {#v1beta1-consulsdconfig}
ConsulSDConfig defines a Consul service discovery configuration.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#consul_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| allowStale#
_boolean_ | _(Optional)_
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#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| datacenter#
_string_ | _(Optional)_
Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter. |
-| filter#
_string_ | _(Optional)_
Filter defines filter for /v1/catalog/services requests
See https://developer.hashicorp.com/consul/api-docs/features/filtering |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| namespace#
_string_ | _(Optional)_
Namespaces are only supported in Consul Enterprise. |
-| nodeMeta#
_object (keys:string, values:string)_ | _(Optional)_
Node metadata key/value pairs to filter nodes for a given service. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| partition#
_string_ | _(Optional)_
Admin Partitions are only supported in Consul Enterprise. |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| scheme#
_string_ | _(Optional)_
HTTP Scheme default "http" |
-| server#
_string_ | _(Required)_
A valid string consisting of a hostname or IP followed by an optional port number. |
-| services#
_string array_ | _(Optional)_
A list of services for which targets are retrieved. If omitted, all services are scraped. |
-| tagSeparator#
_string_ | _(Optional)_
The string by which Consul tags are joined into the tag label.
If unset, use its default value. |
-| tags#
_string array_ | _(Optional)_
An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-| tokenRef#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent. |
+| allowStale#
_boolean_ | _(Optional)_
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#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| datacenter#
_string_ | _(Optional)_
Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter. |
+| filter#
_string_ | _(Optional)_
Filter defines filter for /v1/catalog/services requests
See https://developer.hashicorp.com/consul/api-docs/features/filtering |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| namespace#
_string_ | _(Optional)_
Namespaces are only supported in Consul Enterprise. |
+| nodeMeta#
_object (keys:string, values:string)_ | _(Optional)_
Node metadata key/value pairs to filter nodes for a given service. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| partition#
_string_ | _(Optional)_
Admin Partitions are only supported in Consul Enterprise. |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| scheme#
_string_ | _(Optional)_
HTTP Scheme default "http" |
+| server#
_string_ | _(Required)_
A valid string consisting of a hostname or IP followed by an optional port number. |
+| services#
_string array_ | _(Optional)_
A list of services for which targets are retrieved. If omitted, all services are scraped. |
+| tagSeparator#
_string_ | _(Optional)_
The string by which Consul tags are joined into the tag label.
If unset, use its default value. |
+| tags#
_string array_ | _(Optional)_
An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| tokenRef#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent. |
-#### ContainerSecurityContext
+#### ContainerSecurityContext {#v1beta1-containersecuritycontext}
ContainerSecurityContext defines security context for each application container
-Appears in: [SecurityContext](#securitycontext)
+Appears in: [SecurityContext (v1beta1)](#v1beta1-securitycontext)
| Field | Description |
| --- | --- |
-| allowPrivilegeEscalation#
_boolean_ | _(Optional)_
AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
1) run as Privileged
2) has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows. |
-| capabilities#
_[Capabilities](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#capabilities-v1-core)_ | _(Optional)_
The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows. |
-| privileged#
_boolean_ | _(Optional)_
Run containers in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Note that this field cannot be set when spec.os.name is windows. |
-| procMount#
_[ProcMountType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#procmounttype-v1-core)_ | _(Optional)_
procMount denotes the type of proc mount to use for the containers.
The default is DefaultProcMount which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows. |
-| readOnlyRootFilesystem#
_boolean_ | _(Optional)_
Whether this containers has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows. |
+| allowPrivilegeEscalation#
_boolean_ | _(Optional)_
AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
1) run as Privileged
2) has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows. |
+| capabilities#
_[Capabilities (v1)](#v1-capabilities)_ | _(Optional)_
The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows. |
+| privileged#
_boolean_ | _(Optional)_
Run containers in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Note that this field cannot be set when spec.os.name is windows. |
+| procMount#
_[ProcMountType (v1)](#v1-procmounttype)_ | _(Optional)_
procMount denotes the type of proc mount to use for the containers.
The default is DefaultProcMount which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows. |
+| readOnlyRootFilesystem#
_boolean_ | _(Optional)_
Whether this containers has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows. |
-#### DNSSDConfig
+#### DNSSDConfig {#v1beta1-dnssdconfig}
DNSSDConfig allows specifying a set of DNS domain names which are periodically queried to discover a list of targets.
The DNS servers to be contacted are read from /etc/resolv.conf.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#dns_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| names#
_string array_ | _(Required)_
A list of DNS domain names to be queried. |
-| port#
_integer_ | _(Optional)_
The port number used if the query type is not SRV
Ignored for SRV records |
-| type#
_string_ | _(Optional)_
|
+| names#
_string array_ | _(Required)_
A list of DNS domain names to be queried. |
+| port#
_integer_ | _(Optional)_
The port number used if the query type is not SRV
Ignored for SRV records |
+| type#
_string_ | _(Optional)_
|
-#### DigitalOceanSDConfig
+#### DigitalOceanSDConfig {#v1beta1-digitaloceansdconfig}
DigitalOceanSDConfig allow retrieving scrape targets from DigitalOcean's Droplets API.
This service discovery uses the public IPv4 address by default, by that can be changed with relabeling.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#digitalocean_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| port#
_integer_ | _(Optional)_
The port to scrape metrics from. |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| server#
_string_ | _(Optional)_
Server is an optional DigitalOcean API server to query.
By default, https://api.digitalocean.com is used. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| port#
_integer_ | _(Optional)_
The port to scrape metrics from. |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| server#
_string_ | _(Optional)_
Server is an optional DigitalOcean API server to query.
By default, https://api.digitalocean.com is used. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### DiscordConfig
+#### DiscordConfig {#v1beta1-discordconfig}
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| avatar_url#
_string_ | _(Optional)_
AvatarURL defines message avatar URL
Available from alertmanager v0.28.0
Available from: v0.55.0 |
-| content#
_string_ | _(Optional)_
Content defines message content template
Available from alertmanager v0.28.0
Available from: v0.55.0 |
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
HTTP client configuration. |
-| message#
_string_ | _(Optional)_
The message body template |
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| title#
_string_ | _(Optional)_
The message title template |
-| username#
_string_ | _(Optional)_
Username defines message username
Available from alertmanager v0.28.0
Available from: v0.55.0 |
-| webhook_url#
_string_ | _(Optional)_
The discord webhook URL
one of `urlSecret` and `url` must be defined. |
-| webhook_url_secret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
URLSecret defines secret name and key at the CRD namespace.
It must contain the webhook URL.
one of `urlSecret` and `url` must be defined. |
+| avatar_url#
_string_ | _(Optional)_
AvatarURL defines message avatar URL
Available from alertmanager v0.28.0
Available from: v0.55.0 |
+| content#
_string_ | _(Optional)_
Content defines message content template
Available from alertmanager v0.28.0
Available from: v0.55.0 |
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
HTTP client configuration. |
+| message#
_string_ | _(Optional)_
The message body template |
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| title#
_string_ | _(Optional)_
The message title template |
+| username#
_string_ | _(Optional)_
Username defines message username
Available from alertmanager v0.28.0
Available from: v0.55.0 |
+| webhook_url#
_string_ | _(Optional)_
The discord webhook URL
one of `urlSecret` and `url` must be defined. |
+| webhook_url_secret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
URLSecret defines secret name and key at the CRD namespace.
It must contain the webhook URL.
one of `urlSecret` and `url` must be defined. |
-#### DiscoverySelector
+#### DiscoverySelector {#v1beta1-discoveryselector}
DiscoverySelector can be used at CRD components discovery
-Appears in: [VMAlertNotifierSpec](#vmalertnotifierspec)
+Appears in: [VMAlertNotifierSpec (v1beta1)](#v1beta1-vmalertnotifierspec)
| Field | Description |
| --- | --- |
-| labelSelector#
_[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#labelselector-v1-meta)_ | _(Required)_
|
-| namespaceSelector#
_[NamespaceSelector](#namespaceselector)_ | _(Required)_
|
+| labelSelector#
_[LabelSelector (v1)](#v1-labelselector)_ | _(Required)_
|
+| namespaceSelector#
_[NamespaceSelector (v1beta1)](#v1beta1-namespaceselector)_ | _(Required)_
|
-#### DockerFilter
+#### DockerFilter {#v1beta1-dockerfilter}
DockerFilter defines a filter for Docker service discovery.
-Appears in: [DockerSDConfig](#dockersdconfig), [DockerSwarmSDConfig](#dockerswarmsdconfig)
+Appears in: [DockerSDConfig (v1beta1)](#v1beta1-dockersdconfig), [DockerSwarmSDConfig (v1beta1)](#v1beta1-dockerswarmsdconfig)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Required)_
Name of the filter. |
-| values#
_string array_ | _(Required)_
Values for the filter. |
+| name#
_string_ | _(Required)_
Name of the filter. |
+| values#
_string array_ | _(Required)_
Values for the filter. |
-#### DockerSDConfig
+#### DockerSDConfig {#v1beta1-dockersdconfig}
DockerSDConfig configurations allows retrieving scrape targets from Docker Engine.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#docker_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| filters#
_[DockerFilter](#dockerfilter) array_ | _(Optional)_
Filters are optional filters to limit the discovery process to a subset of available resources. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| host#
_string_ | _(Optional)_
Host to connect to the Docker daemon.
Defaults to unix:///var/run/docker.sock. |
-| hostNetworkingHost#
_string_ | _(Optional)_
HostNetworkingHost is used when containers are in host networking mode. |
-| matchFirstNetwork#
_boolean_ | _(Optional)_
MatchFirstNetwork controls whether to match the first network if there are multiple networks. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| port#
_integer_ | _(Optional)_
Port to scrape metrics from, when containers expose multiple ports. |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| filters#
_[DockerFilter (v1beta1)](#v1beta1-dockerfilter) array_ | _(Optional)_
Filters are optional filters to limit the discovery process to a subset of available resources. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| host#
_string_ | _(Optional)_
Host to connect to the Docker daemon.
Defaults to unix:///var/run/docker.sock. |
+| hostNetworkingHost#
_string_ | _(Optional)_
HostNetworkingHost is used when containers are in host networking mode. |
+| matchFirstNetwork#
_boolean_ | _(Optional)_
MatchFirstNetwork controls whether to match the first network if there are multiple networks. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| port#
_integer_ | _(Optional)_
Port to scrape metrics from, when containers expose multiple ports. |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### DockerSwarmSDConfig
+#### DockerSwarmSDConfig {#v1beta1-dockerswarmsdconfig}
DockerSwarmSDConfig configurations allows retrieving scrape targets from Docker Swarm.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#dockerswarm_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| filters#
_[DockerFilter](#dockerfilter) array_ | _(Optional)_
Filters are optional filters to limit the discovery process to a subset of available resources. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| host#
_string_ | _(Required)_
Host to connect to the Docker daemon. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| port#
_integer_ | _(Optional)_
Port to scrape metrics from, when containers expose multiple ports. |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| role#
_string_ | _(Required)_
Role of the target in Docker Swarm. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| filters#
_[DockerFilter (v1beta1)](#v1beta1-dockerfilter) array_ | _(Optional)_
Filters are optional filters to limit the discovery process to a subset of available resources. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| host#
_string_ | _(Required)_
Host to connect to the Docker daemon. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| port#
_integer_ | _(Optional)_
Port to scrape metrics from, when containers expose multiple ports. |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| role#
_string_ | _(Required)_
Role of the target in Docker Swarm. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### DownsamplingConfig
+#### DownsamplingConfig {#v1beta1-downsamplingconfig}
DownsamplingConfig defines downsampling configuration for VMSingle and VMCluster
Requires enterprise license.
See https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#downsampling
-Appears in: [VMClusterSpec](#vmclusterspec), [VMSingleSpec](#vmsinglespec)
+Appears in: [VMClusterSpec (v1beta1)](#v1beta1-vmclusterspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
| Field | Description |
| --- | --- |
-| dedupInterval#
_string_ | _(Optional)_
DedupInterval sets the deduplication interval used with downsampling.
It corresponds to -dedup.minScrapeInterval flag.
Must be a multiple of all configured downsampling intervals. |
-| rules#
_[DownsamplingRule](#downsamplingrule) array_ | _(Optional)_
Rules defines downsampling rules.
Each rule matches time series by an optional filter and applies downsampling after a given offset. |
+| dedupInterval#
_string_ | _(Optional)_
DedupInterval sets the deduplication interval used with downsampling.
It corresponds to -dedup.minScrapeInterval flag.
Must be a multiple of all configured downsampling intervals. |
+| rules#
_[DownsamplingRule (v1beta1)](#v1beta1-downsamplingrule) array_ | _(Optional)_
Rules defines downsampling rules.
Each rule matches time series by an optional filter and applies downsampling after a given offset. |
-#### DownsamplingPeriod
+#### DownsamplingPeriod {#v1beta1-downsamplingperiod}
DownsamplingPeriod defines a single downsampling time horizon.
-Appears in: [DownsamplingRule](#downsamplingrule)
+Appears in: [DownsamplingRule (v1beta1)](#v1beta1-downsamplingrule)
| Field | Description |
| --- | --- |
-| interval#
_string_ | _(Required)_
Interval is the target downsampling resolution; only the last sample per interval is kept.
Example: "10m" |
-| offset#
_string_ | _(Required)_
Offset is the minimum age of data before downsampling is applied.
Example: "30d" |
+| interval#
_string_ | _(Required)_
Interval is the target downsampling resolution; only the last sample per interval is kept.
Example: "10m" |
+| offset#
_string_ | _(Required)_
Offset is the minimum age of data before downsampling is applied.
Example: "30d" |
-#### DownsamplingRule
+#### DownsamplingRule {#v1beta1-downsamplingrule}
DownsamplingRule defines downsampling periods for an optional label filter.
All period intervals must be pairwise multiples of each other.
-Appears in: [DownsamplingConfig](#downsamplingconfig)
+Appears in: [DownsamplingConfig (v1beta1)](#v1beta1-downsamplingconfig)
| Field | Description |
| --- | --- |
-| filter#
_string_ | _(Optional)_
Filter is an optional MetricsQL label filter for matching time series.
If not set, the rule is applied to all time series.
Example: '\{env="prod"\}' |
-| periods#
_[DownsamplingPeriod](#downsamplingperiod) array_ | _(Required)_
Periods defines the downsampling time horizons applied to matching series. |
+| filter#
_string_ | _(Optional)_
Filter is an optional MetricsQL label filter for matching time series.
If not set, the rule is applied to all time series.
Example: '\{env="prod"\}' |
+| periods#
_[DownsamplingPeriod (v1beta1)](#v1beta1-downsamplingperiod) array_ | _(Required)_
Periods defines the downsampling time horizons applied to matching series. |
-#### EC2Filter
+#### EC2Filter {#v1beta1-ec2filter}
EC2Filter is the configuration for filtering EC2 instances.
-Appears in: [EC2SDConfig](#ec2sdconfig)
+Appears in: [EC2SDConfig (v1beta1)](#v1beta1-ec2sdconfig)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Required)_
|
-| values#
_string array_ | _(Required)_
|
+| name#
_string_ | _(Required)_
|
+| values#
_string array_ | _(Required)_
|
-#### EC2SDConfig
+#### EC2SDConfig {#v1beta1-ec2sdconfig}
EC2SDConfig allow retrieving scrape targets from AWS EC2 instances.
The private IP address is used by default, but may be changed to the public IP address with relabeling.
The IAM credentials used must have the ec2:DescribeInstances permission to discover scrape targets.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#ec2_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| accessKey#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
AccessKey is the AWS API key. |
-| filters#
_[EC2Filter](#ec2filter) array_ | _(Optional)_
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 |
-| port#
_integer_ | _(Optional)_
The port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule. |
-| region#
_string_ | _(Optional)_
The AWS region |
-| roleARN#
_string_ | _(Optional)_
AWS Role ARN, an alternative to using AWS API keys. |
-| secretKey#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
SecretKey is the AWS API secret. |
+| accessKey#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
AccessKey is the AWS API key. |
+| filters#
_[EC2Filter (v1beta1)](#v1beta1-ec2filter) array_ | _(Optional)_
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 |
+| port#
_integer_ | _(Optional)_
The port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule. |
+| region#
_string_ | _(Optional)_
The AWS region |
+| roleARN#
_string_ | _(Optional)_
AWS Role ARN, an alternative to using AWS API keys. |
+| secretKey#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
SecretKey is the AWS API secret. |
-#### EmailConfig
+#### EmailConfig {#v1beta1-emailconfig}
EmailConfig configures notifications via Email.
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| auth_identity#
_string_ | _(Optional)_
The identity to use for authentication. |
-| auth_password#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
AuthPassword defines secret name and key at CRD namespace. |
-| auth_secret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
AuthSecret defines secret name and key at CRD namespace.
It must contain the CRAM-MD5 secret. |
-| auth_username#
_string_ | _(Optional)_
The username to use for authentication. |
-| from#
_string_ | _(Optional)_
The sender address.
fallback to global setting if empty |
-| headers
_object (keys:string, values:string)_ | _(Required)_
Further headers email header key/value pairs. Overrides any headers
previously set by the notification implementation. |
-| hello#
_string_ | _(Optional)_
The hostname to identify to the SMTP server. |
-| html#
_string_ | _(Optional)_
The HTML body of the email notification. |
-| require_tls#
_boolean_ | _(Optional)_
The SMTP TLS requirement.
Note that Go does not support unencrypted connections to remote SMTP endpoints. |
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| smarthost#
_string_ | _(Optional)_
The SMTP host through which emails are sent.
fallback to global setting if empty |
-| text#
_string_ | _(Optional)_
The text body of the email notification. |
-| tls_config#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration |
-| to#
_string_ | _(Optional)_
The email address to send notifications to. |
+| auth_identity#
_string_ | _(Optional)_
The identity to use for authentication. |
+| auth_password#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
AuthPassword defines secret name and key at CRD namespace. |
+| auth_secret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
AuthSecret defines secret name and key at CRD namespace.
It must contain the CRAM-MD5 secret. |
+| auth_username#
_string_ | _(Optional)_
The username to use for authentication. |
+| from#
_string_ | _(Optional)_
The sender address.
fallback to global setting if empty |
+| headers
_object (keys:string, values:string)_ | _(Required)_
Further headers email header key/value pairs. Overrides any headers
previously set by the notification implementation. |
+| hello#
_string_ | _(Optional)_
The hostname to identify to the SMTP server. |
+| html#
_string_ | _(Optional)_
The HTML body of the email notification. |
+| require_tls#
_boolean_ | _(Optional)_
The SMTP TLS requirement.
Note that Go does not support unencrypted connections to remote SMTP endpoints. |
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| smarthost#
_string_ | _(Optional)_
The SMTP host through which emails are sent.
fallback to global setting if empty |
+| text#
_string_ | _(Optional)_
The text body of the email notification. |
+| tls_config#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration |
+| to#
_string_ | _(Optional)_
The email address to send notifications to. |
-#### EmbeddedHPA
+#### EmbeddedHPA {#v1beta1-embeddedhpa}
EmbeddedHPA embeds HorizontalPodAutoScaler spec v2.
https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2/
-Appears in: [VLInsert](#vlinsert), [VLSelect](#vlselect), [VLStorage](#vlstorage), [VMAgentSpec](#vmagentspec), [VMAuthLoadBalancerSpec](#vmauthloadbalancerspec), [VMAuthSpec](#vmauthspec), [VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec), [VMInsert](#vminsert), [VMSelect](#vmselect), [VMStorage](#vmstorage), [VTInsert](#vtinsert), [VTSelect](#vtselect), [VTStorage](#vtstorage)
+Appears in: [VLInsert (v1)](#v1-vlinsert), [VLSelect (v1)](#v1-vlselect), [VLStorage (v1)](#v1-vlstorage), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAuthLoadBalancerSpec (v1beta1)](#v1beta1-vmauthloadbalancerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec), [VMInsert (v1beta1)](#v1beta1-vminsert), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTInsert (v1)](#v1-vtinsert), [VTSelect (v1)](#v1-vtselect), [VTStorage (v1)](#v1-vtstorage)
| Field | Description |
| --- | --- |
-| behaviour#
_[HorizontalPodAutoscalerBehavior](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#horizontalpodautoscalerbehavior-v2-autoscaling)_ | _(Required)_
|
-| maxReplicas#
_integer_ | _(Required)_
|
-| metrics#
_[MetricSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#metricspec-v2-autoscaling) array_ | _(Required)_
|
-| minReplicas#
_integer_ | _(Required)_
|
+| behaviour#
_[HorizontalPodAutoscalerBehavior (v2)](#v2-horizontalpodautoscalerbehavior)_ | _(Required)_
|
+| maxReplicas#
_integer_ | _(Required)_
|
+| metrics#
_[MetricSpec (v2)](#v2-metricspec) array_ | _(Required)_
|
+| minReplicas#
_integer_ | _(Required)_
|
-#### EmbeddedHTTPRoute
+#### EmbeddedHTTPRoute {#v1beta1-embeddedhttproute}
EmbeddedHTTPRoute describes httproute configuration options.
Requires gateway-controller CRD installed and VM_GATEWAY_API_ENABLED=true env var
See https://gateway-api.sigs.k8s.io/guides/#installing-a-gateway-controller
-Appears in: [VMAuthSpec](#vmauthspec)
+Appears in: [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec)
| Field | Description |
| --- | --- |
-| annotations#
_object (keys:string, values:string)_ | _(Optional)_
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
-| extraRules
_[RawExtension](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#rawextension-runtime-pkg) array_ | _(Optional)_
ExtraRules defines custom HTTPRouteRule in raw form, bypassing Gateway API CEL validations. |
-| hostnames#
_Hostname array_ | _(Optional)_
Hostnames defines a set of hostnames that should match against the HTTP Host
header to select a HTTPRoute used to process the request. |
-| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels |
-| name#
_string_ | _(Optional)_
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
-| parentRefs#
_ParentReference array_ | _(Required)_
ParentRefs references the resources (usually Gateways) that a Route wants to be attached to. |
+| annotations#
_object (keys:string, values:string)_ | _(Optional)_
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
+| extraRules
_[RawExtension (runtime)](#runtime-rawextension) array_ | _(Optional)_
ExtraRules defines custom HTTPRouteRule in raw form, bypassing Gateway API CEL validations. |
+| hostnames#
_[Hostname (v1)](#v1-hostname) array_ | _(Optional)_
Hostnames defines a set of hostnames that should match against the HTTP Host
header to select a HTTPRoute used to process the request. |
+| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels |
+| name#
_string_ | _(Optional)_
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
+| parentRefs#
_[ParentReference (v1)](#v1-parentreference) array_ | _(Required)_
ParentRefs references the resources (usually Gateways) that a Route wants to be attached to. |
-#### EmbeddedIngress
+#### EmbeddedIngress {#v1beta1-embeddedingress}
EmbeddedIngress describes ingress configuration options.
-Appears in: [VMAuthSpec](#vmauthspec)
+Appears in: [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec)
| Field | Description |
| --- | --- |
-| annotations#
_object (keys:string, values:string)_ | _(Optional)_
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
-| class_name#
_string_ | _(Optional)_
ClassName defines ingress class name for VMAuth |
-| extraRules
_[IngressRule](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#ingressrule-v1-networking) array_ | _(Optional)_
ExtraRules - additional rules for ingress,
must be checked for correctness by user. |
-| extraTls
_[IngressTLS](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#ingresstls-v1-networking) array_ | _(Optional)_
ExtraTLS - additional TLS configuration for ingress
must be checked for correctness by user. |
-| host#
_string_ | _(Optional)_
Host defines ingress host parameter for default rule
It will be used, only if TlsHosts is empty |
-| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels |
-| name#
_string_ | _(Optional)_
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
-| paths#
_string array_ | _(Optional)_
Paths defines ingress paths parameter for default rule |
-| tlsHosts#
_string array_ | _(Required)_
TlsHosts configures TLS access for ingress, tlsSecretName must be defined for it. |
-| tlsSecretName#
_string_ | _(Optional)_
TlsSecretName defines secretname at the VMAuth namespace with cert and key
https://kubernetes.io/docs/concepts/services-networking/ingress/#tls |
+| annotations#
_object (keys:string, values:string)_ | _(Optional)_
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
+| class_name#
_string_ | _(Optional)_
ClassName defines ingress class name for VMAuth |
+| extraRules
_[IngressRule (v1)](#v1-ingressrule) array_ | _(Optional)_
ExtraRules - additional rules for ingress,
must be checked for correctness by user. |
+| extraTls
_[IngressTLS (v1)](#v1-ingresstls) array_ | _(Optional)_
ExtraTLS - additional TLS configuration for ingress
must be checked for correctness by user. |
+| host#
_string_ | _(Optional)_
Host defines ingress host parameter for default rule
It will be used, only if TlsHosts is empty |
+| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels |
+| name#
_string_ | _(Optional)_
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
+| paths#
_string array_ | _(Optional)_
Paths defines ingress paths parameter for default rule |
+| tlsHosts#
_string array_ | _(Required)_
TlsHosts configures TLS access for ingress, tlsSecretName must be defined for it. |
+| tlsSecretName#
_string_ | _(Optional)_
TlsSecretName defines secretname at the VMAuth namespace with cert and key
https://kubernetes.io/docs/concepts/services-networking/ingress/#tls |
-#### EmbeddedNetworkPolicy
+#### EmbeddedNetworkPolicy {#v1beta1-embeddednetworkpolicy}
EmbeddedNetworkPolicy defines configuration for a NetworkPolicy protecting pods owned by the CR.
-Appears in: [VLAgentSpec](#vlagentspec), [VLInsert](#vlinsert), [VLSelect](#vlselect), [VLSingleSpec](#vlsinglespec), [VLStorage](#vlstorage), [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAnomalySpec](#vmanomalyspec), [VMAuthLoadBalancerSpec](#vmauthloadbalancerspec), [VMAuthSpec](#vmauthspec), [VMInsert](#vminsert), [VMSelect](#vmselect), [VMSingleSpec](#vmsinglespec), [VMStorage](#vmstorage), [VTInsert](#vtinsert), [VTSelect](#vtselect), [VTSingleSpec](#vtsinglespec), [VTStorage](#vtstorage)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec), [VLInsert (v1)](#v1-vlinsert), [VLSelect (v1)](#v1-vlselect), [VLSingleSpec (v1)](#v1-vlsinglespec), [VLStorage (v1)](#v1-vlstorage), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAnomalySpec (v1)](#v1-vmanomalyspec), [VMAuthLoadBalancerSpec (v1beta1)](#v1beta1-vmauthloadbalancerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMInsert (v1beta1)](#v1beta1-vminsert), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTInsert (v1)](#v1-vtinsert), [VTSelect (v1)](#v1-vtselect), [VTSingleSpec (v1)](#v1-vtsinglespec), [VTStorage (v1)](#v1-vtstorage)
| Field | Description |
| --- | --- |
-| egress#
_[NetworkPolicyEgressRule](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#networkpolicyegressrule-v1-networking) array_ | _(Optional)_
Egress defines the list of egress rules applied to pods selected by this CR. |
-| ingress#
_[NetworkPolicyIngressRule](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#networkpolicyingressrule-v1-networking) array_ | _(Optional)_
Ingress defines the list of ingress rules applied to pods selected by this CR.
Each rule allows traffic which matches both the from and ports sections. |
+| egress#
_[NetworkPolicyEgressRule (v1)](#v1-networkpolicyegressrule) array_ | _(Optional)_
Egress defines the list of egress rules applied to pods selected by this CR. |
+| ingress#
_[NetworkPolicyIngressRule (v1)](#v1-networkpolicyingressrule) array_ | _(Optional)_
Ingress defines the list of ingress rules applied to pods selected by this CR.
Each rule allows traffic which matches both the from and ports sections. |
-#### EmbeddedObjectMetadata
+#### EmbeddedObjectMetadata {#v1beta1-embeddedobjectmetadata}
EmbeddedObjectMetadata contains a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta
Only fields which are relevant to embedded resources are included.
-Appears in: [AdditionalServiceSpec](#additionalservicespec), [EmbeddedHTTPRoute](#embeddedhttproute), [EmbeddedIngress](#embeddedingress), [EmbeddedPersistentVolumeClaim](#embeddedpersistentvolumeclaim), [VLAgentSpec](#vlagentspec), [VLDistributedZoneAgentSpec](#vldistributedzoneagentspec), [VLInsert](#vlinsert), [VLSelect](#vlselect), [VLSingleSpec](#vlsinglespec), [VLStorage](#vlstorage), [VLogsSpec](#vlogsspec), [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAnomalySpec](#vmanomalyspec), [VMAuthLoadBalancerSpec](#vmauthloadbalancerspec), [VMAuthSpec](#vmauthspec), [VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec), [VMInsert](#vminsert), [VMSelect](#vmselect), [VMSingleSpec](#vmsinglespec), [VMStorage](#vmstorage), [VTInsert](#vtinsert), [VTSelect](#vtselect), [VTSingleSpec](#vtsinglespec), [VTStorage](#vtstorage)
+Appears in: [AdditionalServiceSpec (v1beta1)](#v1beta1-additionalservicespec), [EmbeddedHTTPRoute (v1beta1)](#v1beta1-embeddedhttproute), [EmbeddedIngress (v1beta1)](#v1beta1-embeddedingress), [EmbeddedPersistentVolumeClaim (v1beta1)](#v1beta1-embeddedpersistentvolumeclaim), [VLAgentSpec (v1)](#v1-vlagentspec), [VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec), [VLInsert (v1)](#v1-vlinsert), [VLSelect (v1)](#v1-vlselect), [VLSingleSpec (v1)](#v1-vlsinglespec), [VLStorage (v1)](#v1-vlstorage), [VLogsSpec (v1beta1)](#v1beta1-vlogsspec), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAnomalySpec (v1)](#v1-vmanomalyspec), [VMAuthLoadBalancerSpec (v1beta1)](#v1beta1-vmauthloadbalancerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec), [VMInsert (v1beta1)](#v1beta1-vminsert), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTInsert (v1)](#v1-vtinsert), [VTSelect (v1)](#v1-vtselect), [VTSingleSpec (v1)](#v1-vtsinglespec), [VTStorage (v1)](#v1-vtstorage)
| Field | Description |
| --- | --- |
-| annotations#
_object (keys:string, values:string)_ | _(Optional)_
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
-| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels |
-| name#
_string_ | _(Optional)_
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
+| annotations#
_object (keys:string, values:string)_ | _(Optional)_
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
+| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels |
+| name#
_string_ | _(Optional)_
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
-#### EmbeddedPersistentVolumeClaim
+#### EmbeddedPersistentVolumeClaim {#v1beta1-embeddedpersistentvolumeclaim}
EmbeddedPersistentVolumeClaim is an embedded version of k8s.io/api/core/v1.PersistentVolumeClaim.
It contains TypeMeta and a reduced ObjectMeta.
-Appears in: [StorageSpec](#storagespec)
+Appears in: [StorageSpec (v1beta1)](#v1beta1-storagespec)
| Field | Description |
| --- | --- |
-| metadata#
_[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | _(Optional)_
Refer to Kubernetes API documentation for fields of `metadata`. |
-| spec#
_[PersistentVolumeClaimSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaimspec-v1-core)_ | _(Optional)_
Spec defines the desired characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
+| metadata#
_[EmbeddedObjectMetadata (v1beta1)](#v1beta1-embeddedobjectmetadata)_ | _(Optional)_
Refer to Kubernetes API documentation for fields of `metadata`. |
+| spec#
_[PersistentVolumeClaimSpec (v1)](#v1-persistentvolumeclaimspec)_ | _(Optional)_
Spec defines the desired characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
-#### EmbeddedPodDisruptionBudgetSpec
+#### EmbeddedPodDisruptionBudgetSpec {#v1beta1-embeddedpoddisruptionbudgetspec}
-Appears in: [VLAgentSpec](#vlagentspec), [VLDistributedZoneAgentSpec](#vldistributedzoneagentspec), [VLInsert](#vlinsert), [VLSelect](#vlselect), [VLStorage](#vlstorage), [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAnomalySpec](#vmanomalyspec), [VMAuthLoadBalancerSpec](#vmauthloadbalancerspec), [VMAuthSpec](#vmauthspec), [VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec), [VMInsert](#vminsert), [VMSelect](#vmselect), [VMStorage](#vmstorage), [VTInsert](#vtinsert), [VTSelect](#vtselect), [VTStorage](#vtstorage)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec), [VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec), [VLInsert (v1)](#v1-vlinsert), [VLSelect (v1)](#v1-vlselect), [VLStorage (v1)](#v1-vlstorage), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAnomalySpec (v1)](#v1-vmanomalyspec), [VMAuthLoadBalancerSpec (v1beta1)](#v1beta1-vmauthloadbalancerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec), [VMInsert (v1beta1)](#v1beta1-vminsert), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTInsert (v1)](#v1-vtinsert), [VTSelect (v1)](#v1-vtselect), [VTStorage (v1)](#v1-vtstorage)
| Field | Description |
| --- | --- |
-| maxUnavailable#
_[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#intorstring-intstr-util)_ | _(Optional)_
An eviction is allowed if at most "maxUnavailable" pods selected by
"selector" are unavailable after the eviction, i.e. even in absence of
the evicted pod. For example, one can prevent all voluntary evictions
by specifying 0. This is a mutually exclusive setting with "minAvailable". |
-| minAvailable#
_[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#intorstring-intstr-util)_ | _(Optional)_
An eviction is allowed if at least "minAvailable" pods selected by
"selector" will still be available after the eviction, i.e. even in the
absence of the evicted pod. So for example you can prevent all voluntary
evictions by specifying "100%". |
-| selectorLabels#
_object (keys:string, values:string)_ | _(Optional)_
replaces default labels selector generated by operator
it's useful when you need to create custom budget |
-| unhealthyPodEvictionPolicy#
_string_ | _(Optional)_
UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods
Valid policies are IfHealthyBudget and AlwaysAllow.
If no policy is specified, the default behavior will be used,
which corresponds to the IfHealthyBudget policy.
Available from: v0.64.0 |
+| maxUnavailable#
_[IntOrString (intstr)](#intstr-intorstring)_ | _(Optional)_
An eviction is allowed if at most "maxUnavailable" pods selected by
"selector" are unavailable after the eviction, i.e. even in absence of
the evicted pod. For example, one can prevent all voluntary evictions
by specifying 0. This is a mutually exclusive setting with "minAvailable". |
+| minAvailable#
_[IntOrString (intstr)](#intstr-intorstring)_ | _(Optional)_
An eviction is allowed if at least "minAvailable" pods selected by
"selector" will still be available after the eviction, i.e. even in the
absence of the evicted pod. So for example you can prevent all voluntary
evictions by specifying "100%". |
+| selectorLabels#
_object (keys:string, values:string)_ | _(Optional)_
replaces default labels selector generated by operator
it's useful when you need to create custom budget |
+| unhealthyPodEvictionPolicy#
_string_ | _(Optional)_
UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods
Valid policies are IfHealthyBudget and AlwaysAllow.
If no policy is specified, the default behavior will be used,
which corresponds to the IfHealthyBudget policy.
Available from: v0.64.0 |
-#### EmbeddedVPA
+#### EmbeddedVPA {#v1beta1-embeddedvpa}
EmbeddedVPA embeds VerticalPodAutoscaler spec v1.
https://github.com/kubernetes/autoscaler/tree/master/vertical-pod-autoscaler
-Appears in: [VLAgentSpec](#vlagentspec), [VLDistributedZoneAgentSpec](#vldistributedzoneagentspec), [VLInsert](#vlinsert), [VLSelect](#vlselect), [VLSingleSpec](#vlsinglespec), [VLStorage](#vlstorage), [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAnomalySpec](#vmanomalyspec), [VMAuthSpec](#vmauthspec), [VMInsert](#vminsert), [VMSelect](#vmselect), [VMSingleSpec](#vmsinglespec), [VMStorage](#vmstorage), [VTInsert](#vtinsert), [VTSelect](#vtselect), [VTSingleSpec](#vtsinglespec), [VTStorage](#vtstorage)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec), [VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec), [VLInsert (v1)](#v1-vlinsert), [VLSelect (v1)](#v1-vlselect), [VLSingleSpec (v1)](#v1-vlsinglespec), [VLStorage (v1)](#v1-vlstorage), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAnomalySpec (v1)](#v1-vmanomalyspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMInsert (v1beta1)](#v1beta1-vminsert), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTInsert (v1)](#v1-vtinsert), [VTSelect (v1)](#v1-vtselect), [VTSingleSpec (v1)](#v1-vtsinglespec), [VTStorage (v1)](#v1-vtstorage)
| Field | Description |
| --- | --- |
-| recommenders#
_VerticalPodAutoscalerRecommenderSelector array_ | _(Optional)_
Recommenders specifies custom VPA recommender names. |
-| resourcePolicy#
_[PodResourcePolicy](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/docs/api.md#podresourcepolicy)_ | _(Required)_
ResourcePolicy controls how the autoscaler computes recommended resources per container. |
-| updatePolicy#
_[PodUpdatePolicy](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/docs/api.md#podupdatepolicy)_ | _(Required)_
UpdatePolicy controls how the autoscaler applies changes to pod resources. |
+| recommenders#
_[VerticalPodAutoscalerRecommenderSelector (v1)](#v1-verticalpodautoscalerrecommenderselector) array_ | _(Optional)_
Recommenders specifies custom VPA recommender names. |
+| resourcePolicy#
_[PodResourcePolicy (v1)](#v1-podresourcepolicy)_ | _(Required)_
ResourcePolicy controls how the autoscaler computes recommended resources per container. |
+| updatePolicy#
_[PodUpdatePolicy (v1)](#v1-podupdatepolicy)_ | _(Required)_
UpdatePolicy controls how the autoscaler applies changes to pod resources. |
-#### Endpoint
+#### Endpoint {#v1beta1-endpoint}
Endpoint defines a scrapeable endpoint serving metrics.
-Appears in: [VMServiceScrapeSpec](#vmservicescrapespec)
-
-| Field | Description |
-| --- | --- |
-| attach_metadata#
_[AttachMetadata](#attachmetadata)_ | _(Optional)_
AttachMetadata configures metadata attaching from service discovery |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization with http header Authorization |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
-| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for scraping targets. |
-| bearerTokenSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
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. |
-| follow_redirects#
_boolean_ | _(Optional)_
FollowRedirects controls redirects for scraping. |
-| honorLabels#
_boolean_ | _(Optional)_
HonorLabels chooses the metric's labels on collisions with target labels. |
-| honorTimestamps#
_boolean_ | _(Optional)_
HonorTimestamps controls whether vmagent or vmsingle respects the timestamps present in scraped data. |
-| interval#
_string_ | _(Optional)_
Interval at which metrics should be scraped |
-| max_scrape_size#
_string_ | _(Optional)_
MaxScrapeSize defines a maximum size of scraped data for a job |
-| metricRelabelConfigs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
MetricRelabelConfigs to apply to samples after scrapping. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| params#
_object (keys:string, values:string array)_ | _(Optional)_
Optional HTTP URL parameters |
-| path#
_string_ | _(Optional)_
HTTP path to scrape for metrics. |
-| port#
_string_ | _(Optional)_
Name of the port exposed at Service. |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| relabelConfigs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
RelabelConfigs to apply to samples during service discovery. |
-| sampleLimit#
_integer_ | _(Optional)_
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. |
-| scheme#
_string_ | _(Optional)_
HTTP scheme to use for scraping. |
-| scrapeTimeout#
_string_ | _(Optional)_
Timeout after which the scrape is ended |
-| scrape_interval#
_string_ | _(Optional)_
ScrapeInterval is the same as Interval and has priority over it.
one of scrape_interval or interval can be used |
-| seriesLimit#
_integer_ | _(Optional)_
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. |
-| targetPort#
_[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#intorstring-intstr-util)_ | _(Optional)_
TargetPort
Name or number of the pod port this endpoint refers to. Mutually exclusive with port. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
-| vm_scrape_params#
_[VMScrapeParams](#vmscrapeparams)_ | _(Optional)_
VMScrapeParams defines VictoriaMetrics specific scrape parameters |
-
-#### EndpointAuth
+Appears in: [VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)
+
+| Field | Description |
+| --- | --- |
+| attach_metadata#
_[AttachMetadata (v1beta1)](#v1beta1-attachmetadata)_ | _(Optional)_
AttachMetadata configures metadata attaching from service discovery |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization with http header Authorization |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
+| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for scraping targets. |
+| bearerTokenSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
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. |
+| follow_redirects#
_boolean_ | _(Optional)_
FollowRedirects controls redirects for scraping. |
+| honorLabels#
_boolean_ | _(Optional)_
HonorLabels chooses the metric's labels on collisions with target labels. |
+| honorTimestamps#
_boolean_ | _(Optional)_
HonorTimestamps controls whether vmagent or vmsingle respects the timestamps present in scraped data. |
+| interval#
_string_ | _(Optional)_
Interval at which metrics should be scraped |
+| max_scrape_size#
_string_ | _(Optional)_
MaxScrapeSize defines a maximum size of scraped data for a job |
+| metricRelabelConfigs#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
MetricRelabelConfigs to apply to samples after scrapping. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| params#
_object (keys:string, values:string array)_ | _(Optional)_
Optional HTTP URL parameters |
+| path#
_string_ | _(Optional)_
HTTP path to scrape for metrics. |
+| port#
_string_ | _(Optional)_
Name of the port exposed at Service. |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| relabelConfigs#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
RelabelConfigs to apply to samples during service discovery. |
+| sampleLimit#
_integer_ | _(Optional)_
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. |
+| scheme#
_string_ | _(Optional)_
HTTP scheme to use for scraping. |
+| scrapeTimeout#
_string_ | _(Optional)_
Timeout after which the scrape is ended |
+| scrape_interval#
_string_ | _(Optional)_
ScrapeInterval is the same as Interval and has priority over it.
one of scrape_interval or interval can be used |
+| seriesLimit#
_integer_ | _(Optional)_
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. |
+| targetPort#
_[IntOrString (intstr)](#intstr-intorstring)_ | _(Optional)_
TargetPort
Name or number of the pod port this endpoint refers to. Mutually exclusive with port. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
+| vm_scrape_params#
_[VMScrapeParams (v1beta1)](#v1beta1-vmscrapeparams)_ | _(Optional)_
VMScrapeParams defines VictoriaMetrics specific scrape parameters |
+
+#### EndpointAuth {#v1beta1-endpointauth}
EndpointAuth defines target endpoint authorization options for scrapping
-Appears in: [Endpoint](#endpoint), [EndpointScrapeParams](#endpointscrapeparams), [PodMetricsEndpoint](#podmetricsendpoint), [ScrapeClass](#scrapeclass), [TargetEndpoint](#targetendpoint), [VMNodeScrapeSpec](#vmnodescrapespec), [VMProbeSpec](#vmprobespec), [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [Endpoint (v1beta1)](#v1beta1-endpoint), [EndpointScrapeParams (v1beta1)](#v1beta1-endpointscrapeparams), [PodMetricsEndpoint (v1beta1)](#v1beta1-podmetricsendpoint), [ScrapeClass (v1beta1)](#v1beta1-scrapeclass), [TargetEndpoint (v1beta1)](#v1beta1-targetendpoint), [VMNodeScrapeSpec (v1beta1)](#v1beta1-vmnodescrapespec), [VMProbeSpec (v1beta1)](#v1beta1-vmprobespec), [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization with http header Authorization |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
-| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for scraping targets. |
-| bearerTokenSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
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. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization with http header Authorization |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
+| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for scraping targets. |
+| bearerTokenSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
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. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
-#### EndpointRelabelings
+#### EndpointRelabelings {#v1beta1-endpointrelabelings}
EndpointRelabelings defines service discovery and metrics relabeling configuration for endpoints
-Appears in: [Endpoint](#endpoint), [PodMetricsEndpoint](#podmetricsendpoint), [ScrapeClass](#scrapeclass), [TargetEndpoint](#targetendpoint), [VMNodeScrapeSpec](#vmnodescrapespec), [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [Endpoint (v1beta1)](#v1beta1-endpoint), [PodMetricsEndpoint (v1beta1)](#v1beta1-podmetricsendpoint), [ScrapeClass (v1beta1)](#v1beta1-scrapeclass), [TargetEndpoint (v1beta1)](#v1beta1-targetendpoint), [VMNodeScrapeSpec (v1beta1)](#v1beta1-vmnodescrapespec), [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| metricRelabelConfigs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
MetricRelabelConfigs to apply to samples after scrapping. |
-| relabelConfigs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
RelabelConfigs to apply to samples during service discovery. |
+| metricRelabelConfigs#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
MetricRelabelConfigs to apply to samples after scrapping. |
+| relabelConfigs#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
RelabelConfigs to apply to samples during service discovery. |
-#### EndpointScrapeParams
+#### EndpointScrapeParams {#v1beta1-endpointscrapeparams}
EndpointScrapeParams defines common configuration params for all scrape endpoint targets
-Appears in: [Endpoint](#endpoint), [PodMetricsEndpoint](#podmetricsendpoint), [TargetEndpoint](#targetendpoint), [VMNodeScrapeSpec](#vmnodescrapespec), [VMProbeSpec](#vmprobespec), [VMScrapeConfigSpec](#vmscrapeconfigspec)
-
-| Field | Description |
-| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization with http header Authorization |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
-| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for scraping targets. |
-| bearerTokenSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
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. |
-| follow_redirects#
_boolean_ | _(Optional)_
FollowRedirects controls redirects for scraping. |
-| honorLabels#
_boolean_ | _(Optional)_
HonorLabels chooses the metric's labels on collisions with target labels. |
-| honorTimestamps#
_boolean_ | _(Optional)_
HonorTimestamps controls whether vmagent or vmsingle respects the timestamps present in scraped data. |
-| interval#
_string_ | _(Optional)_
Interval at which metrics should be scraped |
-| max_scrape_size#
_string_ | _(Optional)_
MaxScrapeSize defines a maximum size of scraped data for a job |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| params#
_object (keys:string, values:string array)_ | _(Optional)_
Optional HTTP URL parameters |
-| path#
_string_ | _(Optional)_
HTTP path to scrape for metrics. |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| sampleLimit#
_integer_ | _(Optional)_
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. |
-| scheme#
_string_ | _(Optional)_
HTTP scheme to use for scraping. |
-| scrapeTimeout#
_string_ | _(Optional)_
Timeout after which the scrape is ended |
-| scrape_interval#
_string_ | _(Optional)_
ScrapeInterval is the same as Interval and has priority over it.
one of scrape_interval or interval can be used |
-| seriesLimit#
_integer_ | _(Optional)_
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. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
-| vm_scrape_params#
_[VMScrapeParams](#vmscrapeparams)_ | _(Optional)_
VMScrapeParams defines VictoriaMetrics specific scrape parameters |
-
-#### EurekaSDConfig
+Appears in: [Endpoint (v1beta1)](#v1beta1-endpoint), [PodMetricsEndpoint (v1beta1)](#v1beta1-podmetricsendpoint), [TargetEndpoint (v1beta1)](#v1beta1-targetendpoint), [VMNodeScrapeSpec (v1beta1)](#v1beta1-vmnodescrapespec), [VMProbeSpec (v1beta1)](#v1beta1-vmprobespec), [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
+
+| Field | Description |
+| --- | --- |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization with http header Authorization |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
+| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for scraping targets. |
+| bearerTokenSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
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. |
+| follow_redirects#
_boolean_ | _(Optional)_
FollowRedirects controls redirects for scraping. |
+| honorLabels#
_boolean_ | _(Optional)_
HonorLabels chooses the metric's labels on collisions with target labels. |
+| honorTimestamps#
_boolean_ | _(Optional)_
HonorTimestamps controls whether vmagent or vmsingle respects the timestamps present in scraped data. |
+| interval#
_string_ | _(Optional)_
Interval at which metrics should be scraped |
+| max_scrape_size#
_string_ | _(Optional)_
MaxScrapeSize defines a maximum size of scraped data for a job |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| params#
_object (keys:string, values:string array)_ | _(Optional)_
Optional HTTP URL parameters |
+| path#
_string_ | _(Optional)_
HTTP path to scrape for metrics. |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| sampleLimit#
_integer_ | _(Optional)_
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. |
+| scheme#
_string_ | _(Optional)_
HTTP scheme to use for scraping. |
+| scrapeTimeout#
_string_ | _(Optional)_
Timeout after which the scrape is ended |
+| scrape_interval#
_string_ | _(Optional)_
ScrapeInterval is the same as Interval and has priority over it.
one of scrape_interval or interval can be used |
+| seriesLimit#
_integer_ | _(Optional)_
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. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
+| vm_scrape_params#
_[VMScrapeParams (v1beta1)](#v1beta1-vmscrapeparams)_ | _(Optional)_
VMScrapeParams defines VictoriaMetrics specific scrape parameters |
+
+#### EurekaSDConfig {#v1beta1-eurekasdconfig}
EurekaSDConfig configurations allows retrieving scrape targets from Eureka REST API.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#eureka_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| server#
_string_ | _(Optional)_
Server is an optional URL to connect to the Eureka server.
By default, the http://localhost:8080/eureka/v2 is used. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| server#
_string_ | _(Optional)_
Server is an optional URL to connect to the Eureka server.
By default, the http://localhost:8080/eureka/v2 is used. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### ExternalConfig
+#### ExternalConfig {#v1beta1-externalconfig}
ExternalConfig defines external source of configuration
-Appears in: [VMAuthSpec](#vmauthspec)
+Appears in: [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec)
| Field | Description |
| --- | --- |
-| localPath#
_string_ | _(Optional)_
LocalPath contains static path to a config, which is managed externally for cases
when using secrets is not applicable, e.g.: Vault sidecar. |
-| secretRef#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
SecretRef defines selector for externally managed secret which contains configuration |
+| localPath#
_string_ | _(Optional)_
LocalPath contains static path to a config, which is managed externally for cases
when using secrets is not applicable, e.g.: Vault sidecar. |
+| secretRef#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
SecretRef defines selector for externally managed secret which contains configuration |
-#### FileSDConfig
+#### FileSDConfig {#v1beta1-filesdconfig}
FileSDConfig defines a file service discovery configuration.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#file_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| files#
_string array_ | _(Required)_
List of files to be used for file discovery. |
+| files#
_string array_ | _(Required)_
List of files to be used for file discovery. |
-#### GCESDConfig
+#### GCESDConfig {#v1beta1-gcesdconfig}
GCESDConfig configures scrape targets from GCP GCE instances.
The private IP address is used by default, but may be changed to
@@ -2419,795 +2419,795 @@ The GCE service discovery will load the Google Cloud credentials
from the file specified by the GOOGLE_APPLICATION_CREDENTIALS environment variable.
See https://cloud.google.com/kubernetes-engine/docs/tutorials/authenticating-to-cloud-platform
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| filter#
_string_ | _(Optional)_
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_ | _(Optional)_
The port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule. |
-| project#
_string_ | _(Required)_
The Google Cloud Project ID |
-| tagSeparator#
_string_ | _(Optional)_
The tag separator is used to separate the tags on concatenation |
-| zone#
_[StringOrArray](#stringorarray)_ | _(Required)_
The zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs. |
+| filter#
_string_ | _(Optional)_
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_ | _(Optional)_
The port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule. |
+| project#
_string_ | _(Required)_
The Google Cloud Project ID |
+| tagSeparator#
_string_ | _(Optional)_
The tag separator is used to separate the tags on concatenation |
+| zone#
_[StringOrArray (v1beta1)](#v1beta1-stringorarray)_ | _(Required)_
The zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs. |
-#### HTTPAuth
+#### HTTPAuth {#v1beta1-httpauth}
HTTPAuth generic auth used with http protocols
-Appears in: [VMAlertDatasourceSpec](#vmalertdatasourcespec), [VMAlertNotifierSpec](#vmalertnotifierspec), [VMAlertRemoteReadSpec](#vmalertremotereadspec), [VMAlertRemoteWriteSpec](#vmalertremotewritespec)
+Appears in: [VMAlertDatasourceSpec (v1beta1)](#v1beta1-vmalertdatasourcespec), [VMAlertNotifierSpec (v1beta1)](#v1beta1-vmalertnotifierspec), [VMAlertRemoteReadSpec (v1beta1)](#v1beta1-vmalertremotereadspec), [VMAlertRemoteWriteSpec (v1beta1)](#v1beta1-vmalertremotewritespec)
| Field | Description |
| --- | --- |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
|
-| headers
_string array_ | _(Optional)_
Headers allow configuring custom http headers
Must be in form of semicolon separated header with value
e.g.
headerName:headerValue
vmalert supports it since 1.79.0 version |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
|
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
|
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
|
+| headers
_string array_ | _(Optional)_
Headers allow configuring custom http headers
Must be in form of semicolon separated header with value
e.g.
headerName:headerValue
vmalert supports it since 1.79.0 version |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
|
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
|
-#### HTTPConfig
+#### HTTPConfig {#v1beta1-httpconfig}
HTTPConfig defines a client HTTP configuration for VMAlertmanagerConfig objects
See https://prometheus.io/docs/alerting/latest/configuration/#http_config
-Appears in: [DiscordConfig](#discordconfig), [IncidentioConfig](#incidentioconfig), [JiraConfig](#jiraconfig), [MSTeamsConfig](#msteamsconfig), [MSTeamsV2Config](#msteamsv2config), [MattermostConfig](#mattermostconfig), [OpsGenieConfig](#opsgenieconfig), [PagerDutyConfig](#pagerdutyconfig), [PushoverConfig](#pushoverconfig), [RocketchatConfig](#rocketchatconfig), [SNSConfig](#snsconfig), [SlackConfig](#slackconfig), [TelegramConfig](#telegramconfig), [VictorOpsConfig](#victoropsconfig), [WebexConfig](#webexconfig), [WebhookConfig](#webhookconfig), [WechatConfig](#wechatconfig)
+Appears in: [DiscordConfig (v1beta1)](#v1beta1-discordconfig), [IncidentioConfig (v1beta1)](#v1beta1-incidentioconfig), [JiraConfig (v1beta1)](#v1beta1-jiraconfig), [MSTeamsConfig (v1beta1)](#v1beta1-msteamsconfig), [MSTeamsV2Config (v1beta1)](#v1beta1-msteamsv2config), [MattermostConfig (v1beta1)](#v1beta1-mattermostconfig), [OpsGenieConfig (v1beta1)](#v1beta1-opsgenieconfig), [PagerDutyConfig (v1beta1)](#v1beta1-pagerdutyconfig), [PushoverConfig (v1beta1)](#v1beta1-pushoverconfig), [RocketchatConfig (v1beta1)](#v1beta1-rocketchatconfig), [SNSConfig (v1beta1)](#v1beta1-snsconfig), [SlackConfig (v1beta1)](#v1beta1-slackconfig), [TelegramConfig (v1beta1)](#v1beta1-telegramconfig), [VictorOpsConfig (v1beta1)](#v1beta1-victoropsconfig), [WebexConfig (v1beta1)](#v1beta1-webexconfig), [WebhookConfig (v1beta1)](#v1beta1-webhookconfig), [WechatConfig (v1beta1)](#v1beta1-wechatconfig)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header configuration for the client.
This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
-| basic_auth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth for the client. |
-| bearer_token_file#
_string_ | _(Optional)_
BearerTokenFile defines filename for bearer token, it must be mounted to pod. |
-| bearer_token_secret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
The secret's key that contains the bearer token
It must be at them same namespace as CRD |
-| follow_redirects#
_boolean_ | _(Optional)_
FollowRedirects controls redirects for scraping. |
-| http_headers
_object (keys:string, values:[HTTPHeaderConfig](#httpheaderconfig))_ | _(Optional)_
HTTPHeaders defines custom HTTP headers to be sent along with each request.
Only supported starting from Alertmanager v0.28.0; ignored by older versions.
Available from: v0.75.0 |
-| noProxy#
_string_ | _(Optional)_
NoProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying.
IP and domain names can contain port numbers. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 client credentials used to fetch a token for the targets. |
-| proxyConnectHeader
_object (keys:string, values:[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core))_ | _(Optional)_
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. |
-| proxyFromEnvironment#
_boolean_ | _(Optional)_
ProxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). |
-| proxyURL#
_string_ | _(Optional)_
ProxyUrl defines the HTTP proxy server to use. |
-| tls_config#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration for the client. |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header configuration for the client.
This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
+| basic_auth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth for the client. |
+| bearer_token_file#
_string_ | _(Optional)_
BearerTokenFile defines filename for bearer token, it must be mounted to pod. |
+| bearer_token_secret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
The secret's key that contains the bearer token
It must be at them same namespace as CRD |
+| follow_redirects#
_boolean_ | _(Optional)_
FollowRedirects controls redirects for scraping. |
+| http_headers
_object (keys:string, values:[HTTPHeaderConfig (v1beta1)](#v1beta1-httpheaderconfig))_ | _(Optional)_
HTTPHeaders defines custom HTTP headers to be sent along with each request.
Only supported starting from Alertmanager v0.28.0; ignored by older versions.
Available from: v0.75.0 |
+| noProxy#
_string_ | _(Optional)_
NoProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying.
IP and domain names can contain port numbers. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 client credentials used to fetch a token for the targets. |
+| proxyConnectHeader
_object (keys:string, values:[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core))_ | _(Optional)_
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. |
+| proxyFromEnvironment#
_boolean_ | _(Optional)_
ProxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). |
+| proxyURL#
_string_ | _(Optional)_
ProxyUrl defines the HTTP proxy server to use. |
+| tls_config#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration for the client. |
-#### HTTPHeaderConfig
+#### HTTPHeaderConfig {#v1beta1-httpheaderconfig}
HTTPHeaderConfig defines the value of a single HTTP header sent by the client.
See https://prometheus.io/docs/alerting/latest/configuration/#http_header
-Appears in: [HTTPConfig](#httpconfig)
+Appears in: [HTTPConfig (v1beta1)](#v1beta1-httpconfig)
| Field | Description |
| --- | --- |
-| files
_string array_ | _(Optional)_
Files are paths on the vmalertmanager container's filesystem to read header values from. |
-| secrets
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core) array_ | _(Optional)_
Secrets are header values read from Kubernetes Secrets. |
-| values
_string array_ | _(Optional)_
Values are literal header values to send as-is. |
+| files
_string array_ | _(Optional)_
Files are paths on the vmalertmanager container's filesystem to read header values from. |
+| secrets
_[SecretKeySelector (v1)](#v1-secretkeyselector) array_ | _(Optional)_
Secrets are header values read from Kubernetes Secrets. |
+| values
_string array_ | _(Optional)_
Values are literal header values to send as-is. |
-#### HTTPSDConfig
+#### HTTPSDConfig {#v1beta1-httpsdconfig}
HTTPSDConfig defines a HTTP service discovery configuration.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#http_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-| url#
_string_ | _(Required)_
URL from which the targets are fetched. |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| url#
_string_ | _(Required)_
URL from which the targets are fetched. |
-#### HTTPSDOptions
+#### HTTPSDOptions {#v1beta1-httpsdoptions}
HTTPSDOptions defines HTTP API client options
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#http-api-client-options)
-Appears in: [AzureSDConfig](#azuresdconfig), [ConsulAgentSDConfig](#consulagentsdconfig), [ConsulSDConfig](#consulsdconfig), [DigitalOceanSDConfig](#digitaloceansdconfig), [DockerSDConfig](#dockersdconfig), [DockerSwarmSDConfig](#dockerswarmsdconfig), [EurekaSDConfig](#eurekasdconfig), [HTTPSDConfig](#httpsdconfig), [HetznerSDConfig](#hetznersdconfig), [KubernetesSDConfig](#kubernetessdconfig), [KumaSDConfig](#kumasdconfig), [MarathonSDConfig](#marathonsdconfig), [NomadSDConfig](#nomadsdconfig), [OVHCloudSDConfig](#ovhcloudsdconfig), [PuppetDBSDConfig](#puppetdbsdconfig), [VultrSDConfig](#vultrsdconfig)
+Appears in: [AzureSDConfig (v1beta1)](#v1beta1-azuresdconfig), [ConsulAgentSDConfig (v1beta1)](#v1beta1-consulagentsdconfig), [ConsulSDConfig (v1beta1)](#v1beta1-consulsdconfig), [DigitalOceanSDConfig (v1beta1)](#v1beta1-digitaloceansdconfig), [DockerSDConfig (v1beta1)](#v1beta1-dockersdconfig), [DockerSwarmSDConfig (v1beta1)](#v1beta1-dockerswarmsdconfig), [EurekaSDConfig (v1beta1)](#v1beta1-eurekasdconfig), [HTTPSDConfig (v1beta1)](#v1beta1-httpsdconfig), [HetznerSDConfig (v1beta1)](#v1beta1-hetznersdconfig), [KubernetesSDConfig (v1beta1)](#v1beta1-kubernetessdconfig), [KumaSDConfig (v1beta1)](#v1beta1-kumasdconfig), [MarathonSDConfig (v1beta1)](#v1beta1-marathonsdconfig), [NomadSDConfig (v1beta1)](#v1beta1-nomadsdconfig), [OVHCloudSDConfig (v1beta1)](#v1beta1-ovhcloudsdconfig), [PuppetDBSDConfig (v1beta1)](#v1beta1-puppetdbsdconfig), [VultrSDConfig (v1beta1)](#v1beta1-vultrsdconfig)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### HetznerSDConfig
+#### HetznerSDConfig {#v1beta1-hetznersdconfig}
HetznerSDConfig configurations allows retrieving scrape targets from Hetzner Cloud and Hetzner Robot.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#hetzner_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| port#
_integer_ | _(Optional)_
Port is an optional port to scrape metrics from |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| role#
_string_ | _(Required)_
Role defines mandatory Hetzner role for entity discovery. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| port#
_integer_ | _(Optional)_
Port is an optional port to scrape metrics from |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| role#
_string_ | _(Required)_
Role defines mandatory Hetzner role for entity discovery. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### Image
+#### Image {#v1beta1-image}
Image defines docker image settings
-Appears in: [CommonAppsParams](#commonappsparams), [VLAgentSpec](#vlagentspec), [VLDistributedZoneAgentSpec](#vldistributedzoneagentspec), [VLInsert](#vlinsert), [VLSelect](#vlselect), [VLSingleSpec](#vlsinglespec), [VLStorage](#vlstorage), [VLogsSpec](#vlogsspec), [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAnomalySpec](#vmanomalyspec), [VMAuthLoadBalancerSpec](#vmauthloadbalancerspec), [VMAuthSpec](#vmauthspec), [VMBackup](#vmbackup), [VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec), [VMInsert](#vminsert), [VMSelect](#vmselect), [VMSingleSpec](#vmsinglespec), [VMStorage](#vmstorage), [VTInsert](#vtinsert), [VTSelect](#vtselect), [VTSingleSpec](#vtsinglespec), [VTStorage](#vtstorage)
+Appears in: [CommonAppsParams (v1beta1)](#v1beta1-commonappsparams), [VLAgentSpec (v1)](#v1-vlagentspec), [VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec), [VLInsert (v1)](#v1-vlinsert), [VLSelect (v1)](#v1-vlselect), [VLSingleSpec (v1)](#v1-vlsinglespec), [VLStorage (v1)](#v1-vlstorage), [VLogsSpec (v1beta1)](#v1beta1-vlogsspec), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAnomalySpec (v1)](#v1-vmanomalyspec), [VMAuthLoadBalancerSpec (v1beta1)](#v1beta1-vmauthloadbalancerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMBackup (v1beta1)](#v1beta1-vmbackup), [VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec), [VMInsert (v1beta1)](#v1beta1-vminsert), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTInsert (v1)](#v1-vtinsert), [VTSelect (v1)](#v1-vtselect), [VTSingleSpec (v1)](#v1-vtsinglespec), [VTStorage (v1)](#v1-vtstorage)
| Field | Description |
| --- | --- |
-| pullPolicy#
_[PullPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#pullpolicy-v1-core)_ | _(Required)_
PullPolicy describes how to pull docker image |
-| repository#
_string_ | _(Required)_
Repository contains name of docker image + it's repository if needed |
-| tag#
_string_ | _(Required)_
Tag contains desired docker image version.
It may be a regular tag (e.g. "v1.96.0") or a digest
(e.g. "sha256:"); a digest is joined to the repository with "@"
instead of ":", allowing images to be pinned by digest. |
+| pullPolicy#
_[PullPolicy (v1)](#v1-pullpolicy)_ | _(Required)_
PullPolicy describes how to pull docker image |
+| repository#
_string_ | _(Required)_
Repository contains name of docker image + it's repository if needed |
+| tag#
_string_ | _(Required)_
Tag contains desired docker image version.
It may be a regular tag (e.g. "v1.96.0") or a digest
(e.g. "sha256:"); a digest is joined to the repository with "@"
instead of ":", allowing images to be pinned by digest. |
-#### ImageConfig
+#### ImageConfig {#v1beta1-imageconfig}
ImageConfig is used to attach images to the incident.
See https://developer.pagerduty.com/docs/send-alert-event#the-images-property
for more information.
-Appears in: [PagerDutyConfig](#pagerdutyconfig)
+Appears in: [PagerDutyConfig (v1beta1)](#v1beta1-pagerdutyconfig)
| Field | Description |
| --- | --- |
-| alt#
_string_ | _(Optional)_
|
-| href#
_string_ | _(Optional)_
|
-| source#
_string_ | _(Required)_
|
+| alt#
_string_ | _(Optional)_
|
+| href#
_string_ | _(Optional)_
|
+| source#
_string_ | _(Required)_
|
-#### IncidentioConfig
+#### IncidentioConfig {#v1beta1-incidentioconfig}
IncidentioConfig configures notifications via incident.io.
https://prometheus.io/docs/alerting/latest/configuration/#incidentio_config
Available from v0.29.0 alertmanager version
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| alert_source_token#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
AlertSourceToken is used to authenticate with incident.io.
Mutually exclusive with AlertSourceTokenFile. |
-| alert_source_token_file#
_string_ | _(Optional)_
AlertSourceTokenFile defines the path to a file that contains the alert source token.
Mutually exclusive with AlertSourceToken. |
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
|
-| max_alerts#
_integer_ | _(Optional)_
MaxAlerts defines maximum number of alerts to be sent per incident.io message. |
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| timeout#
_string_ | _(Optional)_
Timeout is the maximum time allowed to invoke incident.io |
-| url#
_string_ | _(Optional)_
The URL to send the incident.io alert. This would typically be provided by the
incident.io team when setting up an alert source.
Mutually exclusive with URLFile. |
-| url_file#
_string_ | _(Optional)_
URLFile defines the path to a file that holds the incident.io alert URL.
Mutually exclusive with URL. |
+| alert_source_token#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
AlertSourceToken is used to authenticate with incident.io.
Mutually exclusive with AlertSourceTokenFile. |
+| alert_source_token_file#
_string_ | _(Optional)_
AlertSourceTokenFile defines the path to a file that contains the alert source token.
Mutually exclusive with AlertSourceToken. |
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
|
+| max_alerts#
_integer_ | _(Optional)_
MaxAlerts defines maximum number of alerts to be sent per incident.io message. |
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| timeout#
_string_ | _(Optional)_
Timeout is the maximum time allowed to invoke incident.io |
+| url#
_string_ | _(Optional)_
The URL to send the incident.io alert. This would typically be provided by the
incident.io team when setting up an alert source.
Mutually exclusive with URLFile. |
+| url_file#
_string_ | _(Optional)_
URLFile defines the path to a file that holds the incident.io alert URL.
Mutually exclusive with URL. |
-#### InhibitRule
+#### InhibitRule {#v1beta1-inhibitrule}
InhibitRule defines an inhibition rule that allows to mute alerts when other
alerts are already firing.
Note, it doesn't support deprecated alertmanager config options.
See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule
-Appears in: [VMAlertmanagerConfigSpec](#vmalertmanagerconfigspec)
+Appears in: [VMAlertmanagerConfigSpec (v1beta1)](#v1beta1-vmalertmanagerconfigspec)
| Field | Description |
| --- | --- |
-| equal#
_string array_ | _(Optional)_
Labels that must have an equal value in the source and target alert for
the inhibition to take effect. |
-| source_matchers#
_string array_ | _(Optional)_
SourceMatchers defines a list of matchers for which one or more alerts have
to exist for the inhibition to take effect. |
-| target_matchers#
_string array_ | _(Optional)_
TargetMatchers defines a list of matchers that have to be fulfilled by the target
alerts to be muted. |
+| equal#
_string array_ | _(Optional)_
Labels that must have an equal value in the source and target alert for
the inhibition to take effect. |
+| source_matchers#
_string array_ | _(Optional)_
SourceMatchers defines a list of matchers for which one or more alerts have
to exist for the inhibition to take effect. |
+| target_matchers#
_string array_ | _(Optional)_
TargetMatchers defines a list of matchers that have to be fulfilled by the target
alerts to be muted. |
-#### InsertPorts
+#### InsertPorts {#v1beta1-insertports}
-Appears in: [VMAgentSpec](#vmagentspec), [VMInsert](#vminsert), [VMSingleSpec](#vmsinglespec)
+Appears in: [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMInsert (v1beta1)](#v1beta1-vminsert), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
| Field | Description |
| --- | --- |
-| graphitePort#
_string_ | _(Optional)_
GraphitePort listen port |
-| influxPort#
_string_ | _(Optional)_
InfluxPort listen port |
-| openTSDBHTTPPort#
_string_ | _(Optional)_
OpenTSDBHTTPPort for http connections. |
-| openTSDBPort#
_string_ | _(Optional)_
OpenTSDBPort for tcp and udp listen |
+| graphitePort#
_string_ | _(Optional)_
GraphitePort listen port |
+| influxPort#
_string_ | _(Optional)_
InfluxPort listen port |
+| openTSDBHTTPPort#
_string_ | _(Optional)_
OpenTSDBHTTPPort for http connections. |
+| openTSDBPort#
_string_ | _(Optional)_
OpenTSDBPort for tcp and udp listen |
-#### JiraConfig
+#### JiraConfig {#v1beta1-jiraconfig}
JiraConfig represent alertmanager's jira_config entry
https://prometheus.io/docs/alerting/latest/configuration/#jira_config
Available from v0.28.0 alertmanager version
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| api_url#
_string_ | _(Optional)_
The URL to send API requests to. The full API path must be included.
Example: https://company.atlassian.net/rest/api/2/ |
-| custom_fields#
_object (keys:string, values:[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#json-v1-apiextensions-k8s-io))_ | _(Optional)_
Other issue and custom fields.
Jira issue field can have multiple types.
Depends on the field type, the values must be provided differently.
See https://developer.atlassian.com/server/jira/platform/jira-rest-api-examples/#setting-custom-field-data-for-other-field-types for further examples. |
-| description#
_string_ | _(Optional)_
Issue description template. |
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
The HTTP client's configuration. You must use this configuration to supply the personal access token (PAT) as part of the HTTP `Authorization` header.
For Jira Cloud, use basic_auth with the email address as the username and the PAT as the password.
For Jira Data Center, use the 'authorization' field with 'credentials: '. |
-| issue_type#
_string_ | _(Required)_
Type of the issue (e.g. Bug) |
-| labels#
_string array_ | _(Required)_
Labels to be added to the issue |
-| priority#
_string_ | _(Required)_
Priority of the issue |
-| project#
_string_ | _(Required)_
The project key where issues are created |
-| reopen_duration#
_string_ | _(Optional)_
If reopen_transition is defined, reopen the issue when it is not older than this value (rounded down to the nearest minute).
The resolutiondate field is used to determine the age of the issue. |
-| reopen_transition#
_string_ | _(Required)_
Name of the workflow transition to resolve an issue.
The target status must have the category "done". |
-| resolve_transition#
_string_ | _(Required)_
Name of the workflow transition to reopen an issue.
The target status should not have the category "done". |
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| summary#
_string_ | _(Optional)_
Issue summary template |
-| wont_fix_resolution#
_string_ | _(Required)_
If reopen_transition is defined, ignore issues with that resolution. |
+| api_url#
_string_ | _(Optional)_
The URL to send API requests to. The full API path must be included.
Example: https://company.atlassian.net/rest/api/2/ |
+| custom_fields#
_object (keys:string, values:[JSON (v1)](#v1-json))_ | _(Optional)_
Other issue and custom fields.
Jira issue field can have multiple types.
Depends on the field type, the values must be provided differently.
See https://developer.atlassian.com/server/jira/platform/jira-rest-api-examples/#setting-custom-field-data-for-other-field-types for further examples. |
+| description#
_string_ | _(Optional)_
Issue description template. |
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
The HTTP client's configuration. You must use this configuration to supply the personal access token (PAT) as part of the HTTP `Authorization` header.
For Jira Cloud, use basic_auth with the email address as the username and the PAT as the password.
For Jira Data Center, use the 'authorization' field with 'credentials: '. |
+| issue_type#
_string_ | _(Required)_
Type of the issue (e.g. Bug) |
+| labels#
_string array_ | _(Required)_
Labels to be added to the issue |
+| priority#
_string_ | _(Required)_
Priority of the issue |
+| project#
_string_ | _(Required)_
The project key where issues are created |
+| reopen_duration#
_string_ | _(Optional)_
If reopen_transition is defined, reopen the issue when it is not older than this value (rounded down to the nearest minute).
The resolutiondate field is used to determine the age of the issue. |
+| reopen_transition#
_string_ | _(Required)_
Name of the workflow transition to resolve an issue.
The target status must have the category "done". |
+| resolve_transition#
_string_ | _(Required)_
Name of the workflow transition to reopen an issue.
The target status should not have the category "done". |
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| summary#
_string_ | _(Optional)_
Issue summary template |
+| wont_fix_resolution#
_string_ | _(Required)_
If reopen_transition is defined, ignore issues with that resolution. |
-#### K8SSelectorConfig
+#### K8SSelectorConfig {#v1beta1-k8sselectorconfig}
K8SSelectorConfig is Kubernetes Selector Config
-Appears in: [KubernetesSDConfig](#kubernetessdconfig)
+Appears in: [KubernetesSDConfig (v1beta1)](#v1beta1-kubernetessdconfig)
| Field | Description |
| --- | --- |
-| field#
_string_ | _(Required)_
|
-| label#
_string_ | _(Required)_
|
-| role#
_string_ | _(Required)_
|
+| field#
_string_ | _(Required)_
|
+| label#
_string_ | _(Required)_
|
+| role#
_string_ | _(Required)_
|
-#### KubernetesSDConfig
+#### KubernetesSDConfig {#v1beta1-kubernetessdconfig}
KubernetesSDConfig allows retrieving scrape targets from Kubernetes' REST API.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#kubernetes_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| apiServer#
_string_ | _(Optional)_
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#
_[AttachMetadata](#attachmetadata)_ | _(Optional)_
AttachMetadata configures metadata attaching from service discovery |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| namespaces#
_[NamespaceDiscovery](#namespacediscovery)_ | _(Optional)_
Optional namespace discovery. If omitted, discover targets across all namespaces. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| role#
_string_ | _(Required)_
Role of the Kubernetes entities that should be discovered. |
-| selectors#
_[K8SSelectorConfig](#k8sselectorconfig) array_ | _(Optional)_
Selector to select objects. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| apiServer#
_string_ | _(Optional)_
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#
_[AttachMetadata (v1beta1)](#v1beta1-attachmetadata)_ | _(Optional)_
AttachMetadata configures metadata attaching from service discovery |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| namespaces#
_[NamespaceDiscovery (v1beta1)](#v1beta1-namespacediscovery)_ | _(Optional)_
Optional namespace discovery. If omitted, discover targets across all namespaces. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| role#
_string_ | _(Required)_
Role of the Kubernetes entities that should be discovered. |
+| selectors#
_[K8SSelectorConfig (v1beta1)](#v1beta1-k8sselectorconfig) array_ | _(Optional)_
Selector to select objects. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### KumaSDConfig
+#### KumaSDConfig {#v1beta1-kumasdconfig}
KumaSDConfig configurations allows retrieving scrape targets from Kuma control plane.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#kuma_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| clientID#
_string_ | _(Optional)_
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_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| server#
_string_ | _(Required)_
Server must contain the URL of Kuma Control Plane's MADS xDS server. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| clientID#
_string_ | _(Optional)_
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_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| server#
_string_ | _(Required)_
Server must contain the URL of Kuma Control Plane's MADS xDS server. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### License
+#### License {#v1beta1-license}
License holds license key for enterprise features.
Using license key is supported starting from VictoriaMetrics corev1.94.0.
See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/)
-Appears in: [VLAgentSpec](#vlagentspec), [VLClusterSpec](#vlclusterspec), [VLDistributedSpec](#vldistributedspec), [VLDistributedZoneAgentSpec](#vldistributedzoneagentspec), [VLSingleSpec](#vlsinglespec), [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAnomalySpec](#vmanomalyspec), [VMAuthLoadBalancerSpec](#vmauthloadbalancerspec), [VMAuthSpec](#vmauthspec), [VMClusterSpec](#vmclusterspec), [VMDistributedSpec](#vmdistributedspec), [VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec), [VMSingleSpec](#vmsinglespec)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec), [VLClusterSpec (v1)](#v1-vlclusterspec), [VLDistributedSpec (v1alpha1)](#v1alpha1-vldistributedspec), [VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec), [VLSingleSpec (v1)](#v1-vlsinglespec), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAnomalySpec (v1)](#v1-vmanomalyspec), [VMAuthLoadBalancerSpec (v1beta1)](#v1beta1-vmauthloadbalancerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMClusterSpec (v1beta1)](#v1beta1-vmclusterspec), [VMDistributedSpec (v1alpha1)](#v1alpha1-vmdistributedspec), [VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
| Field | Description |
| --- | --- |
-| forceOffline#
_boolean_ | _(Required)_
Enforce offline verification of the license key. |
-| key#
_string_ | _(Required)_
Enterprise license key. This flag is available only in [VictoriaMetrics enterprise](https://docs.victoriametrics.com/victoriametrics/enterprise/).
To request a trial license, [go to](https://victoriametrics.com/products/enterprise/trial) |
-| keyRef#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Required)_
KeyRef is reference to secret with license key for enterprise features. |
-| reloadInterval#
_string_ | _(Required)_
Interval to be used for checking for license key changes. Note that this is only applicable when using KeyRef. |
+| forceOffline#
_boolean_ | _(Required)_
Enforce offline verification of the license key. |
+| key#
_string_ | _(Required)_
Enterprise license key. This flag is available only in [VictoriaMetrics enterprise](https://docs.victoriametrics.com/victoriametrics/enterprise/).
To request a trial license, [go to](https://victoriametrics.com/products/enterprise/trial) |
+| keyRef#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Required)_
KeyRef is reference to secret with license key for enterprise features. |
+| reloadInterval#
_string_ | _(Required)_
Interval to be used for checking for license key changes. Note that this is only applicable when using KeyRef. |
-#### LinkConfig
+#### LinkConfig {#v1beta1-linkconfig}
LinkConfig is used to attach text links to the incident.
See https://developer.pagerduty.com/docs/send-alert-event#the-links-property
for more information.
-Appears in: [PagerDutyConfig](#pagerdutyconfig)
+Appears in: [PagerDutyConfig (v1beta1)](#v1beta1-pagerdutyconfig)
| Field | Description |
| --- | --- |
-| href#
_string_ | _(Required)_
|
-| text#
_string_ | _(Required)_
|
+| href#
_string_ | _(Required)_
|
+| text#
_string_ | _(Required)_
|
-#### MSTeamsConfig
+#### MSTeamsConfig {#v1beta1-msteamsconfig}
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
HTTP client configuration. |
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| text#
_string_ | _(Optional)_
The text body of the teams notification. |
-| title#
_string_ | _(Optional)_
The title of the teams notification. |
-| webhook_url#
_string_ | _(Optional)_
The incoming webhook URL
one of `urlSecret` and `url` must be defined. |
-| webhook_url_secret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
URLSecret defines secret name and key at the CRD namespace.
It must contain the webhook URL.
one of `urlSecret` and `url` must be defined. |
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
HTTP client configuration. |
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| text#
_string_ | _(Optional)_
The text body of the teams notification. |
+| title#
_string_ | _(Optional)_
The title of the teams notification. |
+| webhook_url#
_string_ | _(Optional)_
The incoming webhook URL
one of `urlSecret` and `url` must be defined. |
+| webhook_url_secret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
URLSecret defines secret name and key at the CRD namespace.
It must contain the webhook URL.
one of `urlSecret` and `url` must be defined. |
-#### MSTeamsV2Config
+#### MSTeamsV2Config {#v1beta1-msteamsv2config}
MSTeamsV2Config sends notifications using the new message format with adaptive cards as required by flows.
https://support.microsoft.com/en-gb/office/create-incoming-webhooks-with-workflows-for-microsoft-teams-8ae491c7-0394-4861-ba59-055e33f75498
Available from v0.28.0 alertmanager version
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
|
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| text#
_string_ | _(Optional)_
Message body template. |
-| title#
_string_ | _(Optional)_
Message title template. |
-| webhook_url#
_string_ | _(Optional)_
The incoming webhook URL
one of `urlSecret` and `url` must be defined. |
-| webhook_url_secret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
URLSecret defines secret name and key at the CRD namespace.
It must contain the webhook URL.
one of `webhook_url` or `webhook_url_secret` must be defined. |
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
|
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| text#
_string_ | _(Optional)_
Message body template. |
+| title#
_string_ | _(Optional)_
Message title template. |
+| webhook_url#
_string_ | _(Optional)_
The incoming webhook URL
one of `urlSecret` and `url` must be defined. |
+| webhook_url_secret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
URLSecret defines secret name and key at the CRD namespace.
It must contain the webhook URL.
one of `webhook_url` or `webhook_url_secret` must be defined. |
-#### ManagedObjectsMetadata
+#### ManagedObjectsMetadata {#v1beta1-managedobjectsmetadata}
ManagedObjectsMetadata contains Labels and Annotations
-Appears in: [VLAgentSpec](#vlagentspec), [VLClusterSpec](#vlclusterspec), [VLDistributedZoneAgentSpec](#vldistributedzoneagentspec), [VLSingleSpec](#vlsinglespec), [VLogsSpec](#vlogsspec), [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAnomalySpec](#vmanomalyspec), [VMAuthSpec](#vmauthspec), [VMClusterSpec](#vmclusterspec), [VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec), [VMSingleSpec](#vmsinglespec), [VMUserSpec](#vmuserspec), [VTClusterSpec](#vtclusterspec), [VTSingleSpec](#vtsinglespec)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec), [VLClusterSpec (v1)](#v1-vlclusterspec), [VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec), [VLSingleSpec (v1)](#v1-vlsinglespec), [VLogsSpec (v1beta1)](#v1beta1-vlogsspec), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAnomalySpec (v1)](#v1-vmanomalyspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMClusterSpec (v1beta1)](#v1beta1-vmclusterspec), [VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec), [VMUserSpec (v1beta1)](#v1beta1-vmuserspec), [VTClusterSpec (v1)](#v1-vtclusterspec), [VTSingleSpec (v1)](#v1-vtsinglespec)
| Field | Description |
| --- | --- |
-| annotations#
_object (keys:string, values:string)_ | _(Required)_
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
-| labels#
_object (keys:string, values:string)_ | _(Required)_
Labels Map of string keys and values that can be used to organize and categorize
(scope and select) objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels |
+| annotations#
_object (keys:string, values:string)_ | _(Required)_
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
+| labels#
_object (keys:string, values:string)_ | _(Required)_
Labels Map of string keys and values that can be used to organize and categorize
(scope and select) objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels |
-#### MarathonSDConfig
+#### MarathonSDConfig {#v1beta1-marathonsdconfig}
MarathonSDConfig configurations allows retrieving scrape targets from Marathon.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#marathon_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| servers#
_string array_ | _(Required)_
Servers is a list of Marathon servers. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| servers#
_string array_ | _(Required)_
Servers is a list of Marathon servers. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### MattermostAttachment
+#### MattermostAttachment {#v1beta1-mattermostattachment}
-Appears in: [MattermostConfig](#mattermostconfig)
+Appears in: [MattermostConfig (v1beta1)](#v1beta1-mattermostconfig)
| Field | Description |
| --- | --- |
-| author_icon#
_string_ | _(Required)_
|
-| author_link#
_string_ | _(Required)_
|
-| author_name#
_string_ | _(Required)_
|
-| color#
_string_ | _(Required)_
|
-| fallback#
_string_ | _(Required)_
|
-| fields#
_[MattermostField](#mattermostfield) array_ | _(Required)_
|
-| footer
_string_ | _(Required)_
|
-| footer_icon
_string_ | _(Required)_
|
-| image_url#
_string_ | _(Required)_
|
-| pretext#
_string_ | _(Required)_
|
-| text#
_string_ | _(Required)_
|
-| thumb_url#
_string_ | _(Required)_
|
-| title#
_string_ | _(Required)_
|
-| title_link#
_string_ | _(Required)_
|
+| author_icon#
_string_ | _(Required)_
|
+| author_link#
_string_ | _(Required)_
|
+| author_name#
_string_ | _(Required)_
|
+| color#
_string_ | _(Required)_
|
+| fallback#
_string_ | _(Required)_
|
+| fields#
_[MattermostField (v1beta1)](#v1beta1-mattermostfield) array_ | _(Required)_
|
+| footer
_string_ | _(Required)_
|
+| footer_icon
_string_ | _(Required)_
|
+| image_url#
_string_ | _(Required)_
|
+| pretext#
_string_ | _(Required)_
|
+| text#
_string_ | _(Required)_
|
+| thumb_url#
_string_ | _(Required)_
|
+| title#
_string_ | _(Required)_
|
+| title_link#
_string_ | _(Required)_
|
-#### MattermostConfig
+#### MattermostConfig {#v1beta1-mattermostconfig}
MattermostConfig configures notifications via Mattermost.
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| attachments#
_[MattermostAttachment](#mattermostattachment) array_ | _(Optional)_
Attachments defines richer formatting options |
-| channel#
_string_ | _(Optional)_
Channel overrides the channel the message posts in. |
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
|
-| icon_emoji#
_string_ | _(Optional)_
IconEmoji overrides the profile picture and icon_url parameter. |
-| icon_url#
_string_ | _(Optional)_
IconURL overrides the profile picture the message posts with. |
-| priority#
_[MattermostPriority](#mattermostpriority)_ | _(Optional)_
|
-| props#
_[MattermostProps](#mattermostprops)_ | _(Optional)_
|
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| text#
_string_ | _(Required)_
Text defines markdown-formatted message to display in the post. |
-| url#
_string_ | _(Optional)_
URL to send requests to,
one of `urlSecret` and `url` must be defined. |
-| url_secret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
URLSecret defines secret name and key at the CRD namespace.
It must contain the Mattermost URL.
one of `urlSecret` and `url` must be defined. |
-| username#
_string_ | _(Optional)_
Username overrides the username the message posts as |
+| attachments#
_[MattermostAttachment (v1beta1)](#v1beta1-mattermostattachment) array_ | _(Optional)_
Attachments defines richer formatting options |
+| channel#
_string_ | _(Optional)_
Channel overrides the channel the message posts in. |
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
|
+| icon_emoji#
_string_ | _(Optional)_
IconEmoji overrides the profile picture and icon_url parameter. |
+| icon_url#
_string_ | _(Optional)_
IconURL overrides the profile picture the message posts with. |
+| priority#
_[MattermostPriority (v1beta1)](#v1beta1-mattermostpriority)_ | _(Optional)_
|
+| props#
_[MattermostProps (v1beta1)](#v1beta1-mattermostprops)_ | _(Optional)_
|
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| text#
_string_ | _(Required)_
Text defines markdown-formatted message to display in the post. |
+| url#
_string_ | _(Optional)_
URL to send requests to,
one of `urlSecret` and `url` must be defined. |
+| url_secret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
URLSecret defines secret name and key at the CRD namespace.
It must contain the Mattermost URL.
one of `urlSecret` and `url` must be defined. |
+| username#
_string_ | _(Optional)_
Username overrides the username the message posts as |
-#### MattermostField
+#### MattermostField {#v1beta1-mattermostfield}
-Appears in: [MattermostAttachment](#mattermostattachment)
+Appears in: [MattermostAttachment (v1beta1)](#v1beta1-mattermostattachment)
| Field | Description |
| --- | --- |
-| short#
_boolean_ | _(Required)_
|
-| title#
_string_ | _(Required)_
|
-| value#
_string_ | _(Required)_
|
+| short#
_boolean_ | _(Required)_
|
+| title#
_string_ | _(Required)_
|
+| value#
_string_ | _(Required)_
|
-#### MattermostPriority
+#### MattermostPriority {#v1beta1-mattermostpriority}
-Appears in: [MattermostConfig](#mattermostconfig)
+Appears in: [MattermostConfig (v1beta1)](#v1beta1-mattermostconfig)
| Field | Description |
| --- | --- |
-| persistent_notifications#
_boolean_ | _(Required)_
|
-| priority#
_string_ | _(Required)_
|
-| requested_ack#
_boolean_ | _(Required)_
|
+| persistent_notifications#
_boolean_ | _(Required)_
|
+| priority#
_string_ | _(Required)_
|
+| requested_ack#
_boolean_ | _(Required)_
|
-#### MattermostProps
+#### MattermostProps {#v1beta1-mattermostprops}
-Appears in: [MattermostConfig](#mattermostconfig)
+Appears in: [MattermostConfig (v1beta1)](#v1beta1-mattermostconfig)
| Field | Description |
| --- | --- |
-| card#
_string_ | _(Required)_
|
+| card#
_string_ | _(Required)_
|
-#### NamespaceDiscovery
+#### NamespaceDiscovery {#v1beta1-namespacediscovery}
NamespaceDiscovery is the configuration for discovering
Kubernetes namespaces.
-Appears in: [KubernetesSDConfig](#kubernetessdconfig)
+Appears in: [KubernetesSDConfig (v1beta1)](#v1beta1-kubernetessdconfig)
| Field | Description |
| --- | --- |
-| names#
_string array_ | _(Optional)_
List of namespaces where to watch for resources.
If empty and `ownNamespace` isn't true, watch for resources in all namespaces. |
-| ownNamespace#
_boolean_ | _(Optional)_
Includes the namespace in which the pod exists to the list of watched namespaces. |
+| names#
_string array_ | _(Optional)_
List of namespaces where to watch for resources.
If empty and `ownNamespace` isn't true, watch for resources in all namespaces. |
+| ownNamespace#
_boolean_ | _(Optional)_
Includes the namespace in which the pod exists to the list of watched namespaces. |
-#### NamespaceSelector
+#### NamespaceSelector {#v1beta1-namespaceselector}
NamespaceSelector is a selector for selecting either all namespaces or a
list of namespaces.
-Appears in: [DiscoverySelector](#discoveryselector), [VMPodScrapeSpec](#vmpodscrapespec), [VMProbeTargetKubernetes](#vmprobetargetkubernetes), [VMServiceScrapeSpec](#vmservicescrapespec)
+Appears in: [DiscoverySelector (v1beta1)](#v1beta1-discoveryselector), [VMPodScrapeSpec (v1beta1)](#v1beta1-vmpodscrapespec), [VMProbeTargetKubernetes (v1beta1)](#v1beta1-vmprobetargetkubernetes), [VMServiceScrapeSpec (v1beta1)](#v1beta1-vmservicescrapespec)
| Field | Description |
| --- | --- |
-| any#
_boolean_ | _(Optional)_
Boolean describing whether all namespaces are selected in contrast to a
list restricting them. |
-| matchNames#
_string array_ | _(Optional)_
List of namespace names. |
+| any#
_boolean_ | _(Optional)_
Boolean describing whether all namespaces are selected in contrast to a
list restricting them. |
+| matchNames#
_string array_ | _(Optional)_
List of namespace names. |
-#### NamespacedName
+#### NamespacedName {#v1beta1-namespacedname}
NamespacedName defines name and namespace pairs to reference k8s object
-Appears in: [CRDRef](#crdref)
+Appears in: [CRDRef (v1beta1)](#v1beta1-crdref)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Required)_
Name of the target Kubernetes object |
-| namespace#
_string_ | _(Required)_
Namespace of the target Kubernetes object |
-| useExtraService
_boolean_ | _(Optional)_
UseExtraService instructs the operator to prefer the CR's additional service
(created via spec.serviceSpec) over the default service when building the target URL. |
+| name#
_string_ | _(Required)_
Name of the target Kubernetes object |
+| namespace#
_string_ | _(Required)_
Namespace of the target Kubernetes object |
+| useExtraService
_boolean_ | _(Optional)_
UseExtraService instructs the operator to prefer the CR's additional service
(created via spec.serviceSpec) over the default service when building the target URL. |
-#### NomadSDConfig
+#### NomadSDConfig {#v1beta1-nomadsdconfig}
NomadSDConfig configurations allow retrieving scrape targets from Nomad's Service API.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#nomad_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| allowStale#
_boolean_ | _(Optional)_
Allow stale Nomad results to reduce load on Nomad.
If unset, use its default value. |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| namespace#
_string_ | _(Optional)_
Namespace to use for Nomad service discovery. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| region#
_string_ | _(Optional)_
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. |
-| tagSeparator#
_string_ | _(Optional)_
The string by which Nomad tags are joined into the tag label.
If unset, use its default value. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| allowStale#
_boolean_ | _(Optional)_
Allow stale Nomad results to reduce load on Nomad.
If unset, use its default value. |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| namespace#
_string_ | _(Optional)_
Namespace to use for Nomad service discovery. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| region#
_string_ | _(Optional)_
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. |
+| tagSeparator#
_string_ | _(Optional)_
The string by which Nomad tags are joined into the tag label.
If unset, use its default value. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### OAuth2
+#### OAuth2 {#v1beta1-oauth2}
OAuth2 defines OAuth2 configuration
-Appears in: [AzureSDConfig](#azuresdconfig), [ConsulAgentSDConfig](#consulagentsdconfig), [ConsulSDConfig](#consulsdconfig), [DigitalOceanSDConfig](#digitaloceansdconfig), [DockerSDConfig](#dockersdconfig), [DockerSwarmSDConfig](#dockerswarmsdconfig), [Endpoint](#endpoint), [EndpointAuth](#endpointauth), [EndpointScrapeParams](#endpointscrapeparams), [EurekaSDConfig](#eurekasdconfig), [HTTPAuth](#httpauth), [HTTPConfig](#httpconfig), [HTTPSDConfig](#httpsdconfig), [HTTPSDOptions](#httpsdoptions), [HetznerSDConfig](#hetznersdconfig), [KubernetesSDConfig](#kubernetessdconfig), [KumaSDConfig](#kumasdconfig), [MarathonSDConfig](#marathonsdconfig), [NomadSDConfig](#nomadsdconfig), [OVHCloudSDConfig](#ovhcloudsdconfig), [PodMetricsEndpoint](#podmetricsendpoint), [ProxyClientConfig](#proxyclientconfig), [PuppetDBSDConfig](#puppetdbsdconfig), [ScrapeClass](#scrapeclass), [TargetEndpoint](#targetendpoint), [VMAgentRemoteWriteSpec](#vmagentremotewritespec), [VMAlertDatasourceSpec](#vmalertdatasourcespec), [VMAlertNotifierSpec](#vmalertnotifierspec), [VMAlertRemoteReadSpec](#vmalertremotereadspec), [VMAlertRemoteWriteSpec](#vmalertremotewritespec), [VMDistributedZoneRemoteWriteSpec](#vmdistributedzoneremotewritespec), [VMNodeScrapeSpec](#vmnodescrapespec), [VMProbeSpec](#vmprobespec), [VMScrapeConfigSpec](#vmscrapeconfigspec), [VultrSDConfig](#vultrsdconfig)
+Appears in: [AzureSDConfig (v1beta1)](#v1beta1-azuresdconfig), [ConsulAgentSDConfig (v1beta1)](#v1beta1-consulagentsdconfig), [ConsulSDConfig (v1beta1)](#v1beta1-consulsdconfig), [DigitalOceanSDConfig (v1beta1)](#v1beta1-digitaloceansdconfig), [DockerSDConfig (v1beta1)](#v1beta1-dockersdconfig), [DockerSwarmSDConfig (v1beta1)](#v1beta1-dockerswarmsdconfig), [Endpoint (v1beta1)](#v1beta1-endpoint), [EndpointAuth (v1beta1)](#v1beta1-endpointauth), [EndpointScrapeParams (v1beta1)](#v1beta1-endpointscrapeparams), [EurekaSDConfig (v1beta1)](#v1beta1-eurekasdconfig), [HTTPAuth (v1beta1)](#v1beta1-httpauth), [HTTPConfig (v1beta1)](#v1beta1-httpconfig), [HTTPSDConfig (v1beta1)](#v1beta1-httpsdconfig), [HTTPSDOptions (v1beta1)](#v1beta1-httpsdoptions), [HetznerSDConfig (v1beta1)](#v1beta1-hetznersdconfig), [KubernetesSDConfig (v1beta1)](#v1beta1-kubernetessdconfig), [KumaSDConfig (v1beta1)](#v1beta1-kumasdconfig), [MarathonSDConfig (v1beta1)](#v1beta1-marathonsdconfig), [NomadSDConfig (v1beta1)](#v1beta1-nomadsdconfig), [OVHCloudSDConfig (v1beta1)](#v1beta1-ovhcloudsdconfig), [PodMetricsEndpoint (v1beta1)](#v1beta1-podmetricsendpoint), [ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig), [PuppetDBSDConfig (v1beta1)](#v1beta1-puppetdbsdconfig), [ScrapeClass (v1beta1)](#v1beta1-scrapeclass), [TargetEndpoint (v1beta1)](#v1beta1-targetendpoint), [VMAgentRemoteWriteSpec (v1beta1)](#v1beta1-vmagentremotewritespec), [VMAlertDatasourceSpec (v1beta1)](#v1beta1-vmalertdatasourcespec), [VMAlertNotifierSpec (v1beta1)](#v1beta1-vmalertnotifierspec), [VMAlertRemoteReadSpec (v1beta1)](#v1beta1-vmalertremotereadspec), [VMAlertRemoteWriteSpec (v1beta1)](#v1beta1-vmalertremotewritespec), [VMDistributedZoneRemoteWriteSpec (v1alpha1)](#v1alpha1-vmdistributedzoneremotewritespec), [VMNodeScrapeSpec (v1beta1)](#v1beta1-vmnodescrapespec), [VMProbeSpec (v1beta1)](#v1beta1-vmprobespec), [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec), [VultrSDConfig (v1beta1)](#v1beta1-vultrsdconfig)
| Field | Description |
| --- | --- |
-| client_id#
_[SecretOrConfigMap](#secretorconfigmap)_ | _(Required)_
The secret or configmap containing the OAuth2 client id |
-| client_secret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
The secret containing the OAuth2 client secret |
-| client_secret_file#
_string_ | _(Optional)_
ClientSecretFile defines path for client secret file. |
-| endpoint_params#
_object (keys:string, values:string)_ | _(Optional)_
Parameters to append to the token URL |
-| proxy_url#
_string_ | _(Optional)_
The proxy URL for token_url connection
Is only supported by Scrape objects family
Available from: v0.55.0 |
-| scopes#
_string array_ | _(Optional)_
OAuth2 scopes used for the token request |
-| tls_config#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig for token_url connection
Is only supported by Scrape objects family
Available from: v0.55.0 |
-| token_url#
_string_ | _(Required)_
The URL to fetch the token from |
+| client_id#
_[SecretOrConfigMap (v1beta1)](#v1beta1-secretorconfigmap)_ | _(Required)_
The secret or configmap containing the OAuth2 client id |
+| client_secret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
The secret containing the OAuth2 client secret |
+| client_secret_file#
_string_ | _(Optional)_
ClientSecretFile defines path for client secret file. |
+| endpoint_params#
_object (keys:string, values:string)_ | _(Optional)_
Parameters to append to the token URL |
+| proxy_url#
_string_ | _(Optional)_
The proxy URL for token_url connection
Is only supported by Scrape objects family
Available from: v0.55.0 |
+| scopes#
_string array_ | _(Optional)_
OAuth2 scopes used for the token request |
+| tls_config#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLSConfig for token_url connection
Is only supported by Scrape objects family
Available from: v0.55.0 |
+| token_url#
_string_ | _(Required)_
The URL to fetch the token from |
-#### OVHCloudSDConfig
+#### OVHCloudSDConfig {#v1beta1-ovhcloudsdconfig}
OVHCloudSDConfig configurations allows retrieving scrape targets from OVH Cloud VPS and OVH Cloud dedicated server.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#ovhcloud_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| applicationKey#
_string_ | _(Required)_
ApplicationKey defines a self generated token. |
-| applicationSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Required)_
ApplicationSecret defines a generated secret. |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| consumerKey#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Required)_
ConsumerKey holds user/app specific token |
-| endpoint#
_string_ | _(Optional)_
Endpoint defines OVH Cloud endpoint |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| service#
_string_ | _(Required)_
Service could be either `vps` or `dedicated_server` |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| applicationKey#
_string_ | _(Required)_
ApplicationKey defines a self generated token. |
+| applicationSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Required)_
ApplicationSecret defines a generated secret. |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| consumerKey#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Required)_
ConsumerKey holds user/app specific token |
+| endpoint#
_string_ | _(Optional)_
Endpoint defines OVH Cloud endpoint |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| service#
_string_ | _(Required)_
Service could be either `vps` or `dedicated_server` |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-#### OpenStackSDConfig
+#### OpenStackSDConfig {#v1beta1-openstacksdconfig}
OpenStackSDConfig allow retrieving scrape targets from OpenStack Nova instances.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#openstack_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| allTenants#
_boolean_ | _(Optional)_
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_ | _(Optional)_
ApplicationCredentialID |
-| applicationCredentialName#
_string_ | _(Optional)_
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#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
The applicationCredentialSecret field is required if using an application
credential to authenticate. |
-| availability#
_string_ | _(Optional)_
Availability of the endpoint to connect to. |
-| domainID#
_string_ | _(Optional)_
DomainID |
-| domainName#
_string_ | _(Optional)_
At most one of domainId and domainName must be provided if using username
with Identity V3. Otherwise, either are optional. |
-| identityEndpoint#
_string_ | _(Optional)_
IdentityEndpoint specifies the HTTP endpoint that is required to work with
the Identity API of the appropriate version. |
-| password#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Password for the Identity V2 and V3 APIs. Consult with your provider's
control panel to discover your account's preferred method of authentication. |
-| port#
_integer_ | _(Optional)_
The port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule. |
-| projectID#
_string_ | _(Optional)_
ProjectID |
-| projectName#
_string_ | _(Optional)_
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. |
-| role#
_string_ | _(Required)_
The OpenStack role of entities that should be discovered. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-| userid#
_string_ | _(Optional)_
UserID |
-| username#
_string_ | _(Optional)_
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 |
+| allTenants#
_boolean_ | _(Optional)_
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_ | _(Optional)_
ApplicationCredentialID |
+| applicationCredentialName#
_string_ | _(Optional)_
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#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
The applicationCredentialSecret field is required if using an application
credential to authenticate. |
+| availability#
_string_ | _(Optional)_
Availability of the endpoint to connect to. |
+| domainID#
_string_ | _(Optional)_
DomainID |
+| domainName#
_string_ | _(Optional)_
At most one of domainId and domainName must be provided if using username
with Identity V3. Otherwise, either are optional. |
+| identityEndpoint#
_string_ | _(Optional)_
IdentityEndpoint specifies the HTTP endpoint that is required to work with
the Identity API of the appropriate version. |
+| password#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Password for the Identity V2 and V3 APIs. Consult with your provider's
control panel to discover your account's preferred method of authentication. |
+| port#
_integer_ | _(Optional)_
The port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule. |
+| projectID#
_string_ | _(Optional)_
ProjectID |
+| projectName#
_string_ | _(Optional)_
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. |
+| role#
_string_ | _(Required)_
The OpenStack role of entities that should be discovered. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| userid#
_string_ | _(Optional)_
UserID |
+| username#
_string_ | _(Optional)_
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 |
-#### OpsGenieConfig
+#### OpsGenieConfig {#v1beta1-opsgenieconfig}
OpsGenieConfig configures notifications via OpsGenie.
See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| actions#
_string_ | _(Required)_
Comma separated list of actions that will be available for the alert. |
-| apiURL#
_string_ | _(Optional)_
The URL to send OpsGenie API requests to. |
-| api_key#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
The secret's key that contains the OpsGenie API key.
It must be at them same namespace as CRD
fallback to global setting if empty |
-| description#
_string_ | _(Optional)_
Description of the incident. |
-| details#
_object (keys:string, values:string)_ | _(Optional)_
A set of arbitrary key/value pairs that provide further detail about the incident. |
-| entity#
_string_ | _(Required)_
Optional field that can be used to specify which domain alert is related to. |
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
HTTP client configuration. |
-| message#
_string_ | _(Optional)_
Alert text limited to 130 characters. |
-| note#
_string_ | _(Optional)_
Additional alert note. |
-| priority#
_string_ | _(Optional)_
Priority level of alert. Possible values are P1, P2, P3, P4, and P5. |
-| responders#
_[OpsGenieConfigResponder](#opsgenieconfigresponder) array_ | _(Optional)_
List of responders responsible for notifications. |
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| source#
_string_ | _(Optional)_
Backlink to the sender of the notification. |
-| tags#
_string_ | _(Optional)_
Comma separated list of tags attached to the notifications. |
-| update_alerts#
_boolean_ | _(Required)_
Whether to update message and description of the alert in OpsGenie if it already exists
By default, the alert is never updated in OpsGenie, the new message only appears in activity log. |
+| actions#
_string_ | _(Required)_
Comma separated list of actions that will be available for the alert. |
+| apiURL#
_string_ | _(Optional)_
The URL to send OpsGenie API requests to. |
+| api_key#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
The secret's key that contains the OpsGenie API key.
It must be at them same namespace as CRD
fallback to global setting if empty |
+| description#
_string_ | _(Optional)_
Description of the incident. |
+| details#
_object (keys:string, values:string)_ | _(Optional)_
A set of arbitrary key/value pairs that provide further detail about the incident. |
+| entity#
_string_ | _(Required)_
Optional field that can be used to specify which domain alert is related to. |
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
HTTP client configuration. |
+| message#
_string_ | _(Optional)_
Alert text limited to 130 characters. |
+| note#
_string_ | _(Optional)_
Additional alert note. |
+| priority#
_string_ | _(Optional)_
Priority level of alert. Possible values are P1, P2, P3, P4, and P5. |
+| responders#
_[OpsGenieConfigResponder (v1beta1)](#v1beta1-opsgenieconfigresponder) array_ | _(Optional)_
List of responders responsible for notifications. |
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| source#
_string_ | _(Optional)_
Backlink to the sender of the notification. |
+| tags#
_string_ | _(Optional)_
Comma separated list of tags attached to the notifications. |
+| update_alerts#
_boolean_ | _(Required)_
Whether to update message and description of the alert in OpsGenie if it already exists
By default, the alert is never updated in OpsGenie, the new message only appears in activity log. |
-#### OpsGenieConfigResponder
+#### OpsGenieConfigResponder {#v1beta1-opsgenieconfigresponder}
OpsGenieConfigResponder defines a responder to an incident.
One of `id`, `name` or `username` has to be defined.
-Appears in: [OpsGenieConfig](#opsgenieconfig)
+Appears in: [OpsGenieConfig (v1beta1)](#v1beta1-opsgenieconfig)
| Field | Description |
| --- | --- |
-| id#
_string_ | _(Optional)_
ID of the responder. |
-| name#
_string_ | _(Optional)_
Name of the responder. |
-| type#
_string_ | _(Required)_
Type of responder. |
-| username#
_string_ | _(Optional)_
Username of the responder. |
+| id#
_string_ | _(Optional)_
ID of the responder. |
+| name#
_string_ | _(Optional)_
Name of the responder. |
+| type#
_string_ | _(Required)_
Type of responder. |
+| username#
_string_ | _(Optional)_
Username of the responder. |
-#### PagerDutyConfig
+#### PagerDutyConfig {#v1beta1-pagerdutyconfig}
PagerDutyConfig configures notifications via PagerDuty.
See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| class
_string_ | _(Optional)_
The class/type of the event. |
-| client
_string_ | _(Optional)_
Client identification. |
-| client_url
_string_ | _(Optional)_
Backlink to the sender of notification. |
-| component
_string_ | _(Optional)_
The part or component of the affected system that is broken. |
-| description
_string_ | _(Optional)_
Description of the incident. |
-| details
_object (keys:string, values:string)_ | _(Optional)_
Arbitrary key/value pairs that provide further detail about the incident. |
-| group
_string_ | _(Optional)_
A cluster or grouping of sources. |
-| http_config
_[HTTPConfig](#httpconfig)_ | _(Optional)_
HTTP client configuration. |
-| images
_[ImageConfig](#imageconfig) array_ | _(Optional)_
Images to attach to the incident. |
-| links
_[LinkConfig](#linkconfig) array_ | _(Optional)_
Links to attach to the incident. |
-| routing_key
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
The secret's key that contains the PagerDuty integration key (when using
Events API v2). Either this field or `serviceKey` needs to be defined.
It must be at them same namespace as CRD |
-| send_resolved
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| service_key
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
The secret's key that contains the PagerDuty service key (when using
integration type "Prometheus"). Either this field or `routingKey` needs to
be defined.
It must be at them same namespace as CRD |
-| severity
_string_ | _(Optional)_
Severity of the incident. |
-| url
_string_ | _(Optional)_
The URL to send requests to. |
+| class
_string_ | _(Optional)_
The class/type of the event. |
+| client
_string_ | _(Optional)_
Client identification. |
+| client_url
_string_ | _(Optional)_
Backlink to the sender of notification. |
+| component
_string_ | _(Optional)_
The part or component of the affected system that is broken. |
+| description
_string_ | _(Optional)_
Description of the incident. |
+| details
_object (keys:string, values:string)_ | _(Optional)_
Arbitrary key/value pairs that provide further detail about the incident. |
+| group
_string_ | _(Optional)_
A cluster or grouping of sources. |
+| http_config
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
HTTP client configuration. |
+| images
_[ImageConfig (v1beta1)](#v1beta1-imageconfig) array_ | _(Optional)_
Images to attach to the incident. |
+| links
_[LinkConfig (v1beta1)](#v1beta1-linkconfig) array_ | _(Optional)_
Links to attach to the incident. |
+| routing_key
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
The secret's key that contains the PagerDuty integration key (when using
Events API v2). Either this field or `serviceKey` needs to be defined.
It must be at them same namespace as CRD |
+| send_resolved
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| service_key
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
The secret's key that contains the PagerDuty service key (when using
integration type "Prometheus"). Either this field or `routingKey` needs to
be defined.
It must be at them same namespace as CRD |
+| severity
_string_ | _(Optional)_
Severity of the incident. |
+| url
_string_ | _(Optional)_
The URL to send requests to. |
-#### PodMetricsEndpoint
+#### PodMetricsEndpoint {#v1beta1-podmetricsendpoint}
PodMetricsEndpoint defines a scrapeable endpoint of a Kubernetes Pod serving metrics.
-Appears in: [VMPodScrapeSpec](#vmpodscrapespec)
-
-| Field | Description |
-| --- | --- |
-| attach_metadata#
_[AttachMetadata](#attachmetadata)_ | _(Optional)_
AttachMetadata configures metadata attaching from service discovery |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization with http header Authorization |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
-| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for scraping targets. |
-| bearerTokenSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
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. |
-| filterRunning#
_boolean_ | _(Optional)_
FilterRunning applies filter with pod status == running
it prevents from scrapping metrics at failed or succeed state pods.
enabled by default |
-| follow_redirects#
_boolean_ | _(Optional)_
FollowRedirects controls redirects for scraping. |
-| honorLabels#
_boolean_ | _(Optional)_
HonorLabels chooses the metric's labels on collisions with target labels. |
-| honorTimestamps#
_boolean_ | _(Optional)_
HonorTimestamps controls whether vmagent or vmsingle respects the timestamps present in scraped data. |
-| interval#
_string_ | _(Optional)_
Interval at which metrics should be scraped |
-| max_scrape_size#
_string_ | _(Optional)_
MaxScrapeSize defines a maximum size of scraped data for a job |
-| metricRelabelConfigs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
MetricRelabelConfigs to apply to samples after scrapping. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| params#
_object (keys:string, values:string array)_ | _(Optional)_
Optional HTTP URL parameters |
-| path#
_string_ | _(Optional)_
HTTP path to scrape for metrics. |
-| port#
_string_ | _(Optional)_
Name of the port exposed at Pod. |
-| portNumber#
_integer_ | _(Optional)_
PortNumber defines the `Pod` port number which exposes the endpoint. |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| relabelConfigs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
RelabelConfigs to apply to samples during service discovery. |
-| sampleLimit#
_integer_ | _(Optional)_
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. |
-| scheme#
_string_ | _(Optional)_
HTTP scheme to use for scraping. |
-| scrapeTimeout#
_string_ | _(Optional)_
Timeout after which the scrape is ended |
-| scrape_interval#
_string_ | _(Optional)_
ScrapeInterval is the same as Interval and has priority over it.
one of scrape_interval or interval can be used |
-| seriesLimit#
_integer_ | _(Optional)_
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. |
-| targetPort#
_[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#intorstring-intstr-util)_ | _(Optional)_
TargetPort defines name or number of the pod port this endpoint refers to.
Mutually exclusive with Port and PortNumber. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
-| vm_scrape_params#
_[VMScrapeParams](#vmscrapeparams)_ | _(Optional)_
VMScrapeParams defines VictoriaMetrics specific scrape parameters |
-
-#### ProxyClientConfig
+Appears in: [VMPodScrapeSpec (v1beta1)](#v1beta1-vmpodscrapespec)
+
+| Field | Description |
+| --- | --- |
+| attach_metadata#
_[AttachMetadata (v1beta1)](#v1beta1-attachmetadata)_ | _(Optional)_
AttachMetadata configures metadata attaching from service discovery |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization with http header Authorization |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
+| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for scraping targets. |
+| bearerTokenSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
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. |
+| filterRunning#
_boolean_ | _(Optional)_
FilterRunning applies filter with pod status == running
it prevents from scrapping metrics at failed or succeed state pods.
enabled by default |
+| follow_redirects#
_boolean_ | _(Optional)_
FollowRedirects controls redirects for scraping. |
+| honorLabels#
_boolean_ | _(Optional)_
HonorLabels chooses the metric's labels on collisions with target labels. |
+| honorTimestamps#
_boolean_ | _(Optional)_
HonorTimestamps controls whether vmagent or vmsingle respects the timestamps present in scraped data. |
+| interval#
_string_ | _(Optional)_
Interval at which metrics should be scraped |
+| max_scrape_size#
_string_ | _(Optional)_
MaxScrapeSize defines a maximum size of scraped data for a job |
+| metricRelabelConfigs#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
MetricRelabelConfigs to apply to samples after scrapping. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| params#
_object (keys:string, values:string array)_ | _(Optional)_
Optional HTTP URL parameters |
+| path#
_string_ | _(Optional)_
HTTP path to scrape for metrics. |
+| port#
_string_ | _(Optional)_
Name of the port exposed at Pod. |
+| portNumber#
_integer_ | _(Optional)_
PortNumber defines the `Pod` port number which exposes the endpoint. |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| relabelConfigs#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
RelabelConfigs to apply to samples during service discovery. |
+| sampleLimit#
_integer_ | _(Optional)_
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. |
+| scheme#
_string_ | _(Optional)_
HTTP scheme to use for scraping. |
+| scrapeTimeout#
_string_ | _(Optional)_
Timeout after which the scrape is ended |
+| scrape_interval#
_string_ | _(Optional)_
ScrapeInterval is the same as Interval and has priority over it.
one of scrape_interval or interval can be used |
+| seriesLimit#
_integer_ | _(Optional)_
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. |
+| targetPort#
_[IntOrString (intstr)](#intstr-intorstring)_ | _(Optional)_
TargetPort defines name or number of the pod port this endpoint refers to.
Mutually exclusive with Port and PortNumber. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
+| vm_scrape_params#
_[VMScrapeParams (v1beta1)](#v1beta1-vmscrapeparams)_ | _(Optional)_
VMScrapeParams defines VictoriaMetrics specific scrape parameters |
+
+#### ProxyClientConfig {#v1beta1-proxyclientconfig}
ProxyClientConfig represent proxy client config
-Appears in: [AzureSDConfig](#azuresdconfig), [ConsulAgentSDConfig](#consulagentsdconfig), [ConsulSDConfig](#consulsdconfig), [DigitalOceanSDConfig](#digitaloceansdconfig), [DockerSDConfig](#dockersdconfig), [DockerSwarmSDConfig](#dockerswarmsdconfig), [EurekaSDConfig](#eurekasdconfig), [HTTPSDConfig](#httpsdconfig), [HTTPSDOptions](#httpsdoptions), [HetznerSDConfig](#hetznersdconfig), [KubernetesSDConfig](#kubernetessdconfig), [KumaSDConfig](#kumasdconfig), [MarathonSDConfig](#marathonsdconfig), [NomadSDConfig](#nomadsdconfig), [OVHCloudSDConfig](#ovhcloudsdconfig), [PuppetDBSDConfig](#puppetdbsdconfig), [VMScrapeParams](#vmscrapeparams), [VultrSDConfig](#vultrsdconfig)
+Appears in: [AzureSDConfig (v1beta1)](#v1beta1-azuresdconfig), [ConsulAgentSDConfig (v1beta1)](#v1beta1-consulagentsdconfig), [ConsulSDConfig (v1beta1)](#v1beta1-consulsdconfig), [DigitalOceanSDConfig (v1beta1)](#v1beta1-digitaloceansdconfig), [DockerSDConfig (v1beta1)](#v1beta1-dockersdconfig), [DockerSwarmSDConfig (v1beta1)](#v1beta1-dockerswarmsdconfig), [EurekaSDConfig (v1beta1)](#v1beta1-eurekasdconfig), [HTTPSDConfig (v1beta1)](#v1beta1-httpsdconfig), [HTTPSDOptions (v1beta1)](#v1beta1-httpsdoptions), [HetznerSDConfig (v1beta1)](#v1beta1-hetznersdconfig), [KubernetesSDConfig (v1beta1)](#v1beta1-kubernetessdconfig), [KumaSDConfig (v1beta1)](#v1beta1-kumasdconfig), [MarathonSDConfig (v1beta1)](#v1beta1-marathonsdconfig), [NomadSDConfig (v1beta1)](#v1beta1-nomadsdconfig), [OVHCloudSDConfig (v1beta1)](#v1beta1-ovhcloudsdconfig), [PuppetDBSDConfig (v1beta1)](#v1beta1-puppetdbsdconfig), [VMScrapeParams (v1beta1)](#v1beta1-vmscrapeparams), [VultrSDConfig (v1beta1)](#v1beta1-vultrsdconfig)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization with http header Authorization |
-| basic_auth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth allows proxy to authenticate over basic authentication |
-| bearer_token#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
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. |
-| bearer_token_file#
_string_ | _(Optional)_
BearerTokenFile defines file to read bearer token from for proxy auth. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| tls_config#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization with http header Authorization |
+| basic_auth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth allows proxy to authenticate over basic authentication |
+| bearer_token#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
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. |
+| bearer_token_file#
_string_ | _(Optional)_
BearerTokenFile defines file to read bearer token from for proxy auth. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| tls_config#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
-#### ProxyConfig
+#### ProxyConfig {#v1beta1-proxyconfig}
ProxyConfig defines proxy configs
-Appears in: [HTTPConfig](#httpconfig)
+Appears in: [HTTPConfig (v1beta1)](#v1beta1-httpconfig)
| Field | Description |
| --- | --- |
-| noProxy#
_string_ | _(Optional)_
NoProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying.
IP and domain names can contain port numbers. |
-| proxyConnectHeader
_object (keys:string, values:[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core))_ | _(Optional)_
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. |
-| proxyFromEnvironment#
_boolean_ | _(Optional)_
ProxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). |
-| proxyURL#
_string_ | _(Optional)_
ProxyUrl defines the HTTP proxy server to use. |
+| noProxy#
_string_ | _(Optional)_
NoProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying.
IP and domain names can contain port numbers. |
+| proxyConnectHeader
_object (keys:string, values:[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core))_ | _(Optional)_
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. |
+| proxyFromEnvironment#
_boolean_ | _(Optional)_
ProxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). |
+| proxyURL#
_string_ | _(Optional)_
ProxyUrl defines the HTTP proxy server to use. |
-#### PuppetDBSDConfig
+#### PuppetDBSDConfig {#v1beta1-puppetdbsdconfig}
PuppetDBSDConfig configurations allows retrieving scrape targets from PuppetDB resources.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#puppetdb_sd_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
-| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
-| includeParameters#
_boolean_ | _(Optional)_
IncludeParameters defines if parameters should be included as meta labels. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| port#
_integer_ | _(Optional)_
Port defines port to scrape metrics from |
-| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
-| proxy_client_config#
_[ProxyClientConfig](#proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
-| query#
_string_ | _(Required)_
Query defines PQL query that allows to filter discovered resources. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
-| url#
_string_ | _(Required)_
URL of the PuppetDB root query endpoint |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization header to use on every scrape request. |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth information to use on every scrape request. |
+| followRedirects#
_boolean_ | _(Optional)_
Configure whether HTTP requests follow HTTP 3xx redirects. |
+| includeParameters#
_boolean_ | _(Optional)_
IncludeParameters defines if parameters should be included as meta labels. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| port#
_integer_ | _(Optional)_
Port defines port to scrape metrics from |
+| proxyURL#
_string_ | _(Optional)_
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
+| proxy_client_config#
_[ProxyClientConfig (v1beta1)](#v1beta1-proxyclientconfig)_ | _(Optional)_
ProxyClientConfig configures proxy auth settings for scraping
See [feature description](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-targets-via-a-proxy) |
+| query#
_string_ | _(Required)_
Query defines PQL query that allows to filter discovered resources. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLS configuration to use on every scrape request |
+| url#
_string_ | _(Required)_
URL of the PuppetDB root query endpoint |
-#### PushoverConfig
+#### PushoverConfig {#v1beta1-pushoverconfig}
PushoverConfig configures notifications via Pushover.
See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| expire#
_string_ | _(Optional)_
How long your notification will continue to be retried for, unless the user
acknowledges the notification. |
-| html#
_boolean_ | _(Optional)_
Whether notification message is HTML or plain text. |
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
HTTP client configuration. |
-| message#
_string_ | _(Optional)_
Notification message. |
-| priority#
_string_ | _(Optional)_
Priority, see https://pushover.net/api#priority |
-| retry#
_string_ | _(Optional)_
How often the Pushover servers will send the same notification to the user.
Must be at least 30 seconds. |
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| sound#
_string_ | _(Optional)_
The name of one of the sounds supported by device clients to override the user's default sound choice |
-| title#
_string_ | _(Optional)_
Notification title. |
-| token#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Required)_
The secret's key that contains the registered application’s API token, see https://pushover.net/apps.
It must be at them same namespace as CRD |
-| url#
_string_ | _(Optional)_
A supplementary URL shown alongside the message. |
-| url_title#
_string_ | _(Optional)_
A title for supplementary URL, otherwise just the URL is shown |
-| user_key#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Required)_
The secret's key that contains the recipient user’s user key.
It must be at them same namespace as CRD |
+| expire#
_string_ | _(Optional)_
How long your notification will continue to be retried for, unless the user
acknowledges the notification. |
+| html#
_boolean_ | _(Optional)_
Whether notification message is HTML or plain text. |
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
HTTP client configuration. |
+| message#
_string_ | _(Optional)_
Notification message. |
+| priority#
_string_ | _(Optional)_
Priority, see https://pushover.net/api#priority |
+| retry#
_string_ | _(Optional)_
How often the Pushover servers will send the same notification to the user.
Must be at least 30 seconds. |
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| sound#
_string_ | _(Optional)_
The name of one of the sounds supported by device clients to override the user's default sound choice |
+| title#
_string_ | _(Optional)_
Notification title. |
+| token#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Required)_
The secret's key that contains the registered application’s API token, see https://pushover.net/apps.
It must be at them same namespace as CRD |
+| url#
_string_ | _(Optional)_
A supplementary URL shown alongside the message. |
+| url_title#
_string_ | _(Optional)_
A title for supplementary URL, otherwise just the URL is shown |
+| user_key#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Required)_
The secret's key that contains the recipient user’s user key.
It must be at them same namespace as CRD |
-#### QueryArg
+#### QueryArg {#v1beta1-queryarg}
QueryArg defines item for query arguments
-Appears in: [TargetRef](#targetref)
+Appears in: [TargetRef (v1beta1)](#v1beta1-targetref)
| Field | Description |
| --- | --- |
-| name#
_string_ | _(Required)_
Name of query argument |
-| values#
_string array_ | _(Required)_
Values of query argument |
+| name#
_string_ | _(Required)_
Name of query argument |
+| values#
_string array_ | _(Required)_
Values of query argument |
-#### Receiver
+#### Receiver {#v1beta1-receiver}
Receiver defines one or more notification integrations.
-Appears in: [VMAlertmanagerConfigSpec](#vmalertmanagerconfigspec)
+Appears in: [VMAlertmanagerConfigSpec (v1beta1)](#v1beta1-vmalertmanagerconfigspec)
| Field | Description |
| --- | --- |
-| discord_configs#
_[DiscordConfig](#discordconfig) array_ | _(Optional)_
|
-| email_configs#
_[EmailConfig](#emailconfig) array_ | _(Optional)_
EmailConfigs defines email notification configurations. |
-| incidentio_configs#
_[IncidentioConfig](#incidentioconfig) array_ | _(Optional)_
Available from: v0.66.0 |
-| jira_configs#
_[JiraConfig](#jiraconfig) array_ | _(Optional)_
Available from: v0.55.0 |
-| mattermost_configs#
_[MattermostConfig](#mattermostconfig) array_ | _(Optional)_
MattermostConfigs defines Mattermost notification configurations. |
-| msteams_configs#
_[MSTeamsConfig](#msteamsconfig) array_ | _(Optional)_
|
-| msteamsv2_configs#
_[MSTeamsV2Config](#msteamsv2config) array_ | _(Optional)_
Available from: v0.55.0 |
-| name#
_string_ | _(Required)_
Name of the receiver. Must be unique across all items from the list. |
-| opsgenie_configs#
_[OpsGenieConfig](#opsgenieconfig) array_ | _(Optional)_
OpsGenieConfigs defines ops genie notification configurations. |
-| pagerduty_configs
_[PagerDutyConfig](#pagerdutyconfig) array_ | _(Optional)_
PagerDutyConfigs defines pager duty notification configurations. |
-| pushover_configs#
_[PushoverConfig](#pushoverconfig) array_ | _(Optional)_
PushoverConfigs defines push over notification configurations. |
-| rocketchat_configs#
_[RocketchatConfig](#rocketchatconfig) array_ | _(Optional)_
Available from: v0.55.0 |
-| slack_configs#
_[SlackConfig](#slackconfig) array_ | _(Optional)_
SlackConfigs defines slack notification configurations. |
-| sns_configs#
_[SNSConfig](#snsconfig) array_ | _(Optional)_
|
-| telegram_configs#
_[TelegramConfig](#telegramconfig) array_ | _(Optional)_
|
-| victorops_configs#
_[VictorOpsConfig](#victoropsconfig) array_ | _(Optional)_
VictorOpsConfigs defines victor ops notification configurations. |
-| webex_configs#
_[WebexConfig](#webexconfig) array_ | _(Optional)_
|
-| webhook_configs#
_[WebhookConfig](#webhookconfig) array_ | _(Optional)_
WebhookConfigs defines webhook notification configurations. |
-| wechat_configs#
_[WechatConfig](#wechatconfig) array_ | _(Optional)_
WechatConfigs defines wechat notification configurations. |
+| discord_configs#
_[DiscordConfig (v1beta1)](#v1beta1-discordconfig) array_ | _(Optional)_
|
+| email_configs#
_[EmailConfig (v1beta1)](#v1beta1-emailconfig) array_ | _(Optional)_
EmailConfigs defines email notification configurations. |
+| incidentio_configs#
_[IncidentioConfig (v1beta1)](#v1beta1-incidentioconfig) array_ | _(Optional)_
Available from: v0.66.0 |
+| jira_configs#
_[JiraConfig (v1beta1)](#v1beta1-jiraconfig) array_ | _(Optional)_
Available from: v0.55.0 |
+| mattermost_configs#
_[MattermostConfig (v1beta1)](#v1beta1-mattermostconfig) array_ | _(Optional)_
MattermostConfigs defines Mattermost notification configurations. |
+| msteams_configs#
_[MSTeamsConfig (v1beta1)](#v1beta1-msteamsconfig) array_ | _(Optional)_
|
+| msteamsv2_configs#
_[MSTeamsV2Config (v1beta1)](#v1beta1-msteamsv2config) array_ | _(Optional)_
Available from: v0.55.0 |
+| name#
_string_ | _(Required)_
Name of the receiver. Must be unique across all items from the list. |
+| opsgenie_configs#
_[OpsGenieConfig (v1beta1)](#v1beta1-opsgenieconfig) array_ | _(Optional)_
OpsGenieConfigs defines ops genie notification configurations. |
+| pagerduty_configs
_[PagerDutyConfig (v1beta1)](#v1beta1-pagerdutyconfig) array_ | _(Optional)_
PagerDutyConfigs defines pager duty notification configurations. |
+| pushover_configs#
_[PushoverConfig (v1beta1)](#v1beta1-pushoverconfig) array_ | _(Optional)_
PushoverConfigs defines push over notification configurations. |
+| rocketchat_configs#
_[RocketchatConfig (v1beta1)](#v1beta1-rocketchatconfig) array_ | _(Optional)_
Available from: v0.55.0 |
+| slack_configs#
_[SlackConfig (v1beta1)](#v1beta1-slackconfig) array_ | _(Optional)_
SlackConfigs defines slack notification configurations. |
+| sns_configs#
_[SNSConfig (v1beta1)](#v1beta1-snsconfig) array_ | _(Optional)_
|
+| telegram_configs#
_[TelegramConfig (v1beta1)](#v1beta1-telegramconfig) array_ | _(Optional)_
|
+| victorops_configs#
_[VictorOpsConfig (v1beta1)](#v1beta1-victoropsconfig) array_ | _(Optional)_
VictorOpsConfigs defines victor ops notification configurations. |
+| webex_configs#
_[WebexConfig (v1beta1)](#v1beta1-webexconfig) array_ | _(Optional)_
|
+| webhook_configs#
_[WebhookConfig (v1beta1)](#v1beta1-webhookconfig) array_ | _(Optional)_
WebhookConfigs defines webhook notification configurations. |
+| wechat_configs#
_[WechatConfig (v1beta1)](#v1beta1-wechatconfig) array_ | _(Optional)_
WechatConfigs defines wechat notification configurations. |
-#### RelabelConfig
+#### RelabelConfig {#v1beta1-relabelconfig}
RelabelConfig allows dynamic rewriting of the label set
More info: https://docs.victoriametrics.com/victoriametrics/#relabeling
-Appears in: [CommonRelabelParams](#commonrelabelparams), [CommonScrapeParams](#commonscrapeparams), [Endpoint](#endpoint), [EndpointRelabelings](#endpointrelabelings), [PodMetricsEndpoint](#podmetricsendpoint), [ScrapeClass](#scrapeclass), [StreamAggrRule](#streamaggrrule), [TargetEndpoint](#targetendpoint), [VMAgentRemoteWriteSpec](#vmagentremotewritespec), [VMAgentSpec](#vmagentspec), [VMNodeScrapeSpec](#vmnodescrapespec), [VMProbeSpec](#vmprobespec), [VMProbeTargetKubernetes](#vmprobetargetkubernetes), [VMProbeTargetStatic](#vmprobetargetstatic), [VMScrapeConfigSpec](#vmscrapeconfigspec), [VMSingleSpec](#vmsinglespec)
+Appears in: [CommonRelabelParams (v1beta1)](#v1beta1-commonrelabelparams), [CommonScrapeParams (v1beta1)](#v1beta1-commonscrapeparams), [Endpoint (v1beta1)](#v1beta1-endpoint), [EndpointRelabelings (v1beta1)](#v1beta1-endpointrelabelings), [PodMetricsEndpoint (v1beta1)](#v1beta1-podmetricsendpoint), [ScrapeClass (v1beta1)](#v1beta1-scrapeclass), [StreamAggrRule (v1beta1)](#v1beta1-streamaggrrule), [TargetEndpoint (v1beta1)](#v1beta1-targetendpoint), [VMAgentRemoteWriteSpec (v1beta1)](#v1beta1-vmagentremotewritespec), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMNodeScrapeSpec (v1beta1)](#v1beta1-vmnodescrapespec), [VMProbeSpec (v1beta1)](#v1beta1-vmprobespec), [VMProbeTargetKubernetes (v1beta1)](#v1beta1-vmprobetargetkubernetes), [VMProbeTargetStatic (v1beta1)](#v1beta1-vmprobetargetstatic), [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
| Field | Description |
| --- | --- |
-| action#
_string_ | _(Optional)_
Action to perform based on regex matching. Default is 'replace' |
-| if#
_[StringOrArray](#stringorarray)_ | _(Optional)_
If represents metricsQL match expression (or list of expressions): '\{__name__=~"foo_.*"\}' |
-| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels is used together with Match for `action: graphite` |
-| match#
_string_ | _(Optional)_
Match is used together with Labels for `action: graphite` |
-| modulus#
_integer_ | _(Optional)_
Modulus to take of the hash of the source label values. |
-| regex#
_[StringOrArray](#stringorarray)_ | _(Optional)_
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_ | _(Optional)_
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1' |
-| separator#
_string_ | _(Optional)_
Separator placed between concatenated source label values. default is ';'. |
-| sourceLabels#
_string array_ | _(Optional)_
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 array_ | _(Optional)_
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_ | _(Optional)_
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_ | _(Optional)_
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 |
+| action#
_string_ | _(Optional)_
Action to perform based on regex matching. Default is 'replace' |
+| if#
_[StringOrArray (v1beta1)](#v1beta1-stringorarray)_ | _(Optional)_
If represents metricsQL match expression (or list of expressions): '\{__name__=~"foo_.*"\}' |
+| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels is used together with Match for `action: graphite` |
+| match#
_string_ | _(Optional)_
Match is used together with Labels for `action: graphite` |
+| modulus#
_integer_ | _(Optional)_
Modulus to take of the hash of the source label values. |
+| regex#
_[StringOrArray (v1beta1)](#v1beta1-stringorarray)_ | _(Optional)_
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_ | _(Optional)_
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1' |
+| separator#
_string_ | _(Optional)_
Separator placed between concatenated source label values. default is ';'. |
+| sourceLabels#
_string array_ | _(Optional)_
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 array_ | _(Optional)_
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_ | _(Optional)_
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_ | _(Optional)_
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 |
-#### RetentionFilter
+#### RetentionFilter {#v1beta1-retentionfilter}
RetentionFilter defines per-series retention based on a label filter.
Requires enterprise license.
See https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#retention-filters
-Appears in: [RetentionFiltersConfig](#retentionfiltersconfig)
+Appears in: [RetentionFiltersConfig (v1beta1)](#v1beta1-retentionfiltersconfig)
| Field | Description |
| --- | --- |
-| filter#
_string_ | _(Required)_
Filter is a MetricsQL label filter for matching time series.
Example: '\{env="dev"\}' |
-| retention#
_string_ | _(Required)_
Retention is the retention period for matching time series.
Must not exceed the global retentionPeriod.
Example: "3d", "1w" |
+| filter#
_string_ | _(Required)_
Filter is a MetricsQL label filter for matching time series.
Example: '\{env="dev"\}' |
+| retention#
_string_ | _(Required)_
Retention is the retention period for matching time series.
Must not exceed the global retentionPeriod.
Example: "3d", "1w" |
-#### RetentionFiltersConfig
+#### RetentionFiltersConfig {#v1beta1-retentionfiltersconfig}
_Underlying type:_ _[RetentionFilter](#retentionfilter)_
@@ -3215,248 +3215,248 @@ RetentionFiltersConfig defines configuration section for per-series retention ba
Requires enterprise license.
See https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#retention-filters
-Appears in: [VMSingleSpec](#vmsinglespec), [VMStorage](#vmstorage)
+Appears in: [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec), [VMStorage (v1beta1)](#v1beta1-vmstorage)
| Field | Description |
| --- | --- |
-| filter#
_string_ | _(Required)_
Filter is a MetricsQL label filter for matching time series.
Example: '\{env="dev"\}' |
-| retention#
_string_ | _(Required)_
Retention is the retention period for matching time series.
Must not exceed the global retentionPeriod.
Example: "3d", "1w" |
+| filter#
_string_ | _(Required)_
Filter is a MetricsQL label filter for matching time series.
Example: '\{env="dev"\}' |
+| retention#
_string_ | _(Required)_
Retention is the retention period for matching time series.
Must not exceed the global retentionPeriod.
Example: "3d", "1w" |
-#### RocketchatAttachmentAction
+#### RocketchatAttachmentAction {#v1beta1-rocketchatattachmentaction}
RocketchatAttachmentAction defines message attachments
https://github.com/RocketChat/Rocket.Chat.Go.SDK/blob/master/models/message.go
-Appears in: [RocketchatConfig](#rocketchatconfig)
+Appears in: [RocketchatConfig (v1beta1)](#v1beta1-rocketchatconfig)
| Field | Description |
| --- | --- |
-| msg#
_string_ | _(Optional)_
|
-| text#
_string_ | _(Optional)_
|
-| type#
_string_ | _(Optional)_
|
-| url#
_string_ | _(Optional)_
|
+| msg#
_string_ | _(Optional)_
|
+| text#
_string_ | _(Optional)_
|
+| type#
_string_ | _(Optional)_
|
+| url#
_string_ | _(Optional)_
|
-#### RocketchatAttachmentField
+#### RocketchatAttachmentField {#v1beta1-rocketchatattachmentfield}
RocketchatAttachmentField defines API fields
https://developer.rocket.chat/apidocs/post-message
-Appears in: [RocketchatConfig](#rocketchatconfig)
+Appears in: [RocketchatConfig (v1beta1)](#v1beta1-rocketchatconfig)
| Field | Description |
| --- | --- |
-| short#
_boolean_ | _(Optional)_
|
-| title#
_string_ | _(Optional)_
|
-| value#
_string_ | _(Optional)_
|
+| short#
_boolean_ | _(Optional)_
|
+| title#
_string_ | _(Optional)_
|
+| value#
_string_ | _(Optional)_
|
-#### RocketchatConfig
+#### RocketchatConfig {#v1beta1-rocketchatconfig}
RocketchatConfig configures notifications via Rocketchat.
https://prometheus.io/docs/alerting/latest/configuration/#rocketchat_config
Available from v0.28.0 alertmanager version
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| actions#
_[RocketchatAttachmentAction](#rocketchatattachmentaction) array_ | _(Optional)_
|
-| api_url#
_string_ | _(Optional)_
|
-| channel#
_string_ | _(Optional)_
RocketChat channel override, (like #other-channel or @username). |
-| color#
_string_ | _(Optional)_
|
-| emoji#
_string_ | _(Optional)_
|
-| fields#
_[RocketchatAttachmentField](#rocketchatattachmentfield) array_ | _(Optional)_
|
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
|
-| icon_url#
_string_ | _(Optional)_
|
-| image_url#
_string_ | _(Optional)_
|
-| link_names#
_boolean_ | _(Optional)_
|
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| short_fields#
_boolean_ | _(Optional)_
|
-| text#
_string_ | _(Optional)_
|
-| thumb_url#
_string_ | _(Optional)_
|
-| title#
_string_ | _(Optional)_
|
-| title_link#
_string_ | _(Optional)_
|
-| token#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
|
-| token_id#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
The sender token and token_id
See https://docs.rocket.chat/docs/manage-personal-access-tokens |
+| actions#
_[RocketchatAttachmentAction (v1beta1)](#v1beta1-rocketchatattachmentaction) array_ | _(Optional)_
|
+| api_url#
_string_ | _(Optional)_
|
+| channel#
_string_ | _(Optional)_
RocketChat channel override, (like #other-channel or @username). |
+| color#
_string_ | _(Optional)_
|
+| emoji#
_string_ | _(Optional)_
|
+| fields#
_[RocketchatAttachmentField (v1beta1)](#v1beta1-rocketchatattachmentfield) array_ | _(Optional)_
|
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
|
+| icon_url#
_string_ | _(Optional)_
|
+| image_url#
_string_ | _(Optional)_
|
+| link_names#
_boolean_ | _(Optional)_
|
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| short_fields#
_boolean_ | _(Optional)_
|
+| text#
_string_ | _(Optional)_
|
+| thumb_url#
_string_ | _(Optional)_
|
+| title#
_string_ | _(Optional)_
|
+| title_link#
_string_ | _(Optional)_
|
+| token#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
|
+| token_id#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
The sender token and token_id
See https://docs.rocket.chat/docs/manage-personal-access-tokens |
-#### Route
+#### Route {#v1beta1-route}
Route defines a node in the routing tree.
-Appears in: [VMAlertmanagerConfigSpec](#vmalertmanagerconfigspec)
+Appears in: [VMAlertmanagerConfigSpec (v1beta1)](#v1beta1-vmalertmanagerconfigspec)
| Field | Description |
| --- | --- |
-| active_time_intervals#
_string array_ | _(Optional)_
ActiveTimeIntervals Times when the route should be active
These must match the name at time_intervals |
-| continue#
_boolean_ | _(Optional)_
Continue indicating whether an alert should continue matching subsequent
sibling nodes. It will always be true for the first-level route if disableRouteContinueEnforce for vmalertmanager not set. |
-| group_by#
_string array_ | _(Optional)_
List of labels to group by. |
-| group_interval#
_string_ | _(Optional)_
How long to wait before sending an updated notification. |
-| group_wait#
_string_ | _(Optional)_
How long to wait before sending the initial notification. |
-| matchers#
_string array_ | _(Optional)_
List of matchers that the alert’s labels should match. For the first
level route, the operator adds a namespace: "CRD_NS" matcher.
https://prometheus.io/docs/alerting/latest/configuration/#matcher |
-| mute_time_intervals#
_string array_ | _(Optional)_
MuteTimeIntervals is a list of interval names that will mute matched alert |
-| receiver#
_string_ | _(Required)_
Name of the receiver for this route. |
-| repeat_interval#
_string_ | _(Optional)_
How long to wait before repeating the last notification. |
-| routes#
_[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#json-v1-apiextensions-k8s-io) array_ | _(Optional)_
Child routes.
https://prometheus.io/docs/alerting/latest/configuration/#route |
+| active_time_intervals#
_string array_ | _(Optional)_
ActiveTimeIntervals Times when the route should be active
These must match the name at time_intervals |
+| continue#
_boolean_ | _(Optional)_
Continue indicating whether an alert should continue matching subsequent
sibling nodes. It will always be true for the first-level route if disableRouteContinueEnforce for vmalertmanager not set. |
+| group_by#
_string array_ | _(Optional)_
List of labels to group by. |
+| group_interval#
_string_ | _(Optional)_
How long to wait before sending an updated notification. |
+| group_wait#
_string_ | _(Optional)_
How long to wait before sending the initial notification. |
+| matchers#
_string array_ | _(Optional)_
List of matchers that the alert’s labels should match. For the first
level route, the operator adds a namespace: "CRD_NS" matcher.
https://prometheus.io/docs/alerting/latest/configuration/#matcher |
+| mute_time_intervals#
_string array_ | _(Optional)_
MuteTimeIntervals is a list of interval names that will mute matched alert |
+| receiver#
_string_ | _(Required)_
Name of the receiver for this route. |
+| repeat_interval#
_string_ | _(Optional)_
How long to wait before repeating the last notification. |
+| routes#
_[JSON (v1)](#v1-json) array_ | _(Optional)_
Child routes.
https://prometheus.io/docs/alerting/latest/configuration/#route |
-#### Rule
+#### Rule {#v1beta1-rule}
Rule describes an alerting or recording rule.
-Appears in: [RuleGroup](#rulegroup)
+Appears in: [RuleGroup (v1beta1)](#v1beta1-rulegroup)
| Field | Description |
| --- | --- |
-| alert#
_string_ | _(Optional)_
Alert is a name for alert |
-| annotations#
_object (keys:string, values:string)_ | _(Optional)_
Annotations will be added to rule configuration |
-| debug#
_boolean_ | _(Optional)_
Debug enables logging for rule
it useful for tracking |
-| expr#
_string_ | _(Optional)_
Expr is query, that will be evaluated at dataSource |
-| for#
_string_ | _(Optional)_
For evaluation interval in time.Duration format
30s, 1m, 1h or nanoseconds |
-| keep_firing_for#
_string_ | _(Optional)_
KeepFiringFor will make alert continue firing for this long
even when the alerting expression no longer has results.
Use time.Duration format, 30s, 1m, 1h or nanoseconds |
-| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels will be added to rule configuration |
-| record#
_string_ | _(Optional)_
Record represents a query, that will be recorded to dataSource |
-| update_entries_limit#
_integer_ | _(Optional)_
UpdateEntriesLimit defines max number of rule's state updates stored in memory.
Overrides `-rule.updateEntriesLimit` in vmalert. |
+| alert#
_string_ | _(Optional)_
Alert is a name for alert |
+| annotations#
_object (keys:string, values:string)_ | _(Optional)_
Annotations will be added to rule configuration |
+| debug#
_boolean_ | _(Optional)_
Debug enables logging for rule
it useful for tracking |
+| expr#
_string_ | _(Optional)_
Expr is query, that will be evaluated at dataSource |
+| for#
_string_ | _(Optional)_
For evaluation interval in time.Duration format
30s, 1m, 1h or nanoseconds |
+| keep_firing_for#
_string_ | _(Optional)_
KeepFiringFor will make alert continue firing for this long
even when the alerting expression no longer has results.
Use time.Duration format, 30s, 1m, 1h or nanoseconds |
+| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels will be added to rule configuration |
+| record#
_string_ | _(Optional)_
Record represents a query, that will be recorded to dataSource |
+| update_entries_limit#
_integer_ | _(Optional)_
UpdateEntriesLimit defines max number of rule's state updates stored in memory.
Overrides `-rule.updateEntriesLimit` in vmalert. |
-#### RuleGroup
+#### RuleGroup {#v1beta1-rulegroup}
RuleGroup is a list of sequentially evaluated recording and alerting rules.
-Appears in: [VMRuleSpec](#vmrulespec)
+Appears in: [VMRuleSpec (v1beta1)](#v1beta1-vmrulespec)
| Field | Description |
| --- | --- |
-| concurrency#
_integer_ | _(Optional)_
Concurrency defines how many rules execute at once. |
-| eval_alignment#
_boolean_ | _(Required)_
Optional
The evaluation timestamp will be aligned with group's interval,
instead of using the actual timestamp that evaluation happens at.
It is enabled by default to get more predictable results
and to visually align with graphs plotted via Grafana or vmui. |
-| eval_delay#
_string_ | _(Required)_
Optional
Adjust the `time` parameter of group evaluation requests to compensate intentional query delay from the datasource. |
-| eval_offset#
_string_ | _(Required)_
Optional
Group will be evaluated at the exact offset in the range of [0...interval]. |
-| headers
_string array_ | _(Optional)_
Headers contains optional HTTP headers added to each rule request
Must be in form `header-name: value`
For example:
headers:
- "CustomHeader: foo"
- "CustomHeader2: bar" |
-| interval#
_string_ | _(Optional)_
evaluation interval for group |
-| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels optional list of labels added to every rule within a group.
It has priority over the external labels.
Labels are commonly used for adding environment
or tenant-specific tag. |
-| limit#
_integer_ | _(Optional)_
Limit the number of alerts an alerting rule and series a recording
rule can produce |
-| name#
_string_ | _(Required)_
Name of group |
-| notifier_headers
_string array_ | _(Optional)_
NotifierHeaders contains optional HTTP headers added to each alert request which will send to notifier
Must be in form `header-name: value`
For example:
headers:
- "CustomHeader: foo"
- "CustomHeader2: bar" |
-| params#
_[Values](https://pkg.go.dev/net/url#Values)_ | _(Optional)_
Params optional HTTP URL parameters added to each rule request |
-| rules#
_[Rule](#rule) array_ | _(Required)_
Rules list of alert rules.
Rules are merged by record and alert fields. |
-| tenant#
_string_ | _(Optional)_
Tenant id for group, can be used only with enterprise version of vmalert.
See more details [here](https://docs.victoriametrics.com/victoriametrics/vmalert/#multitenancy). |
-| type#
_string_ | _(Optional)_
Type defines datasource type for enterprise version of vmalert
possible values - prometheus,graphite,vlogs |
+| concurrency#
_integer_ | _(Optional)_
Concurrency defines how many rules execute at once. |
+| eval_alignment#
_boolean_ | _(Required)_
Optional
The evaluation timestamp will be aligned with group's interval,
instead of using the actual timestamp that evaluation happens at.
It is enabled by default to get more predictable results
and to visually align with graphs plotted via Grafana or vmui. |
+| eval_delay#
_string_ | _(Required)_
Optional
Adjust the `time` parameter of group evaluation requests to compensate intentional query delay from the datasource. |
+| eval_offset#
_string_ | _(Required)_
Optional
Group will be evaluated at the exact offset in the range of [0...interval]. |
+| headers
_string array_ | _(Optional)_
Headers contains optional HTTP headers added to each rule request
Must be in form `header-name: value`
For example:
headers:
- "CustomHeader: foo"
- "CustomHeader2: bar" |
+| interval#
_string_ | _(Optional)_
evaluation interval for group |
+| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels optional list of labels added to every rule within a group.
It has priority over the external labels.
Labels are commonly used for adding environment
or tenant-specific tag. |
+| limit#
_integer_ | _(Optional)_
Limit the number of alerts an alerting rule and series a recording
rule can produce |
+| name#
_string_ | _(Required)_
Name of group |
+| notifier_headers
_string array_ | _(Optional)_
NotifierHeaders contains optional HTTP headers added to each alert request which will send to notifier
Must be in form `header-name: value`
For example:
headers:
- "CustomHeader: foo"
- "CustomHeader2: bar" |
+| params#
_[Values (url)](#url-values)_ | _(Optional)_
Params optional HTTP URL parameters added to each rule request |
+| rules#
_[Rule (v1beta1)](#v1beta1-rule) array_ | _(Required)_
Rules list of alert rules.
Rules are merged by record and alert fields. |
+| tenant#
_string_ | _(Optional)_
Tenant id for group, can be used only with enterprise version of vmalert.
See more details [here](https://docs.victoriametrics.com/victoriametrics/vmalert/#multitenancy). |
+| type#
_string_ | _(Optional)_
Type defines datasource type for enterprise version of vmalert
possible values - prometheus,graphite,vlogs |
-#### SNSConfig
+#### SNSConfig {#v1beta1-snsconfig}
-Appears in: [Receiver](#receiver)
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
| Field | Description |
| --- | --- |
-| api_url#
_string_ | _(Optional)_
The api URL |
-| attributes#
_object (keys:string, values:string)_ | _(Optional)_
SNS message attributes |
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
HTTP client configuration. |
-| message#
_string_ | _(Optional)_
The message content of the SNS notification. |
-| phone_number#
_string_ | _(Required)_
Phone number if message is delivered via SMS
Specify this, topic_arn or target_arn |
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| sigv4#
_[Sigv4Config](#sigv4config)_ | _(Required)_
Configure the AWS Signature Verification 4 signing process |
-| subject#
_string_ | _(Optional)_
The subject line if message is delivered to an email endpoint. |
-| target_arn#
_string_ | _(Optional)_
Mobile platform endpoint ARN if message is delivered via mobile notifications
Specify this, topic_arn or phone_number |
-| topic_arn#
_string_ | _(Optional)_
SNS topic ARN, either specify this, phone_number or target_arn |
+| api_url#
_string_ | _(Optional)_
The api URL |
+| attributes#
_object (keys:string, values:string)_ | _(Optional)_
SNS message attributes |
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
HTTP client configuration. |
+| message#
_string_ | _(Optional)_
The message content of the SNS notification. |
+| phone_number#
_string_ | _(Required)_
Phone number if message is delivered via SMS
Specify this, topic_arn or target_arn |
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| sigv4#
_[Sigv4Config (v1beta1)](#v1beta1-sigv4config)_ | _(Required)_
Configure the AWS Signature Verification 4 signing process |
+| subject#
_string_ | _(Optional)_
The subject line if message is delivered to an email endpoint. |
+| target_arn#
_string_ | _(Optional)_
Mobile platform endpoint ARN if message is delivered via mobile notifications
Specify this, topic_arn or phone_number |
+| topic_arn#
_string_ | _(Optional)_
SNS topic ARN, either specify this, phone_number or target_arn |
-#### ScrapeClass
+#### ScrapeClass {#v1beta1-scrapeclass}
-Appears in: [CommonScrapeParams](#commonscrapeparams), [VMAgentSpec](#vmagentspec), [VMSingleSpec](#vmsinglespec)
+Appears in: [CommonScrapeParams (v1beta1)](#v1beta1-commonscrapeparams), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
| Field | Description |
| --- | --- |
-| attachMetadata#
_[AttachMetadata](#attachmetadata)_ | _(Optional)_
AttachMetadata defines additional metadata to the discovered targets.
When the scrape object defines its own configuration, it takes
precedence over the scrape class configuration. |
-| authorization#
_[Authorization](#authorization)_ | _(Optional)_
Authorization with http header Authorization |
-| basicAuth#
_[BasicAuth](#basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
-| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for scraping targets. |
-| bearerTokenSecret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
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. |
-| default#
_boolean_ | _(Optional)_
default defines that the scrape applies to all scrape objects that
don't configure an explicit scrape class name.
Only one scrape class can be set as the default. |
-| metricRelabelConfigs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
MetricRelabelConfigs to apply to samples after scrapping. |
-| name#
_string_ | _(Required)_
name of the scrape class. |
-| oauth2#
_[OAuth2](#oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
-| relabelConfigs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
RelabelConfigs to apply to samples during service discovery. |
-| tlsConfig#
_[TLSConfig](#tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
+| attachMetadata#
_[AttachMetadata (v1beta1)](#v1beta1-attachmetadata)_ | _(Optional)_
AttachMetadata defines additional metadata to the discovered targets.
When the scrape object defines its own configuration, it takes
precedence over the scrape class configuration. |
+| authorization#
_[Authorization (v1beta1)](#v1beta1-authorization)_ | _(Optional)_
Authorization with http header Authorization |
+| basicAuth#
_[BasicAuth (v1beta1)](#v1beta1-basicauth)_ | _(Optional)_
BasicAuth allow an endpoint to authenticate over basic authentication |
+| bearerTokenFile#
_string_ | _(Optional)_
File to read bearer token for scraping targets. |
+| bearerTokenSecret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
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. |
+| default#
_boolean_ | _(Optional)_
default defines that the scrape applies to all scrape objects that
don't configure an explicit scrape class name.
Only one scrape class can be set as the default. |
+| metricRelabelConfigs#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
MetricRelabelConfigs to apply to samples after scrapping. |
+| name#
_string_ | _(Required)_
name of the scrape class. |
+| oauth2#
_[OAuth2 (v1beta1)](#v1beta1-oauth2)_ | _(Optional)_
OAuth2 defines auth configuration |
+| relabelConfigs#
_[RelabelConfig (v1beta1)](#v1beta1-relabelconfig) array_ | _(Optional)_
RelabelConfigs to apply to samples during service discovery. |
+| tlsConfig#
_[TLSConfig (v1beta1)](#v1beta1-tlsconfig)_ | _(Optional)_
TLSConfig configuration to use when scraping the endpoint |
-#### SecretOrConfigMap
+#### SecretOrConfigMap {#v1beta1-secretorconfigmap}
SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive.
-Appears in: [OAuth2](#oauth2), [TLSConfig](#tlsconfig)
+Appears in: [OAuth2 (v1beta1)](#v1beta1-oauth2), [TLSConfig (v1beta1)](#v1beta1-tlsconfig)
| Field | Description |
| --- | --- |
-| configMap#
_[ConfigMapKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#configmapkeyselector-v1-core)_ | _(Optional)_
ConfigMap containing data to use for the targets. |
-| secret#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
Secret containing data to use for the targets. |
+| configMap#
_[ConfigMapKeySelector (v1)](#v1-configmapkeyselector)_ | _(Optional)_
ConfigMap containing data to use for the targets. |
+| secret#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
Secret containing data to use for the targets. |
-#### SecurityContext
+#### SecurityContext {#v1beta1-securitycontext}
SecurityContext extends PodSecurityContext with ContainerSecurityContext
It allows to globally configure security params for pod and all containers
-Appears in: [CommonAppsParams](#commonappsparams), [VLAgentSpec](#vlagentspec), [VLDistributedZoneAgentSpec](#vldistributedzoneagentspec), [VLInsert](#vlinsert), [VLSelect](#vlselect), [VLSingleSpec](#vlsinglespec), [VLStorage](#vlstorage), [VLogsSpec](#vlogsspec), [VMAgentSpec](#vmagentspec), [VMAlertSpec](#vmalertspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAnomalySpec](#vmanomalyspec), [VMAuthLoadBalancerSpec](#vmauthloadbalancerspec), [VMAuthSpec](#vmauthspec), [VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec), [VMInsert](#vminsert), [VMSelect](#vmselect), [VMSingleSpec](#vmsinglespec), [VMStorage](#vmstorage), [VTInsert](#vtinsert), [VTSelect](#vtselect), [VTSingleSpec](#vtsinglespec), [VTStorage](#vtstorage)
+Appears in: [CommonAppsParams (v1beta1)](#v1beta1-commonappsparams), [VLAgentSpec (v1)](#v1-vlagentspec), [VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec), [VLInsert (v1)](#v1-vlinsert), [VLSelect (v1)](#v1-vlselect), [VLSingleSpec (v1)](#v1-vlsinglespec), [VLStorage (v1)](#v1-vlstorage), [VLogsSpec (v1beta1)](#v1beta1-vlogsspec), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertSpec (v1beta1)](#v1beta1-vmalertspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAnomalySpec (v1)](#v1-vmanomalyspec), [VMAuthLoadBalancerSpec (v1beta1)](#v1beta1-vmauthloadbalancerspec), [VMAuthSpec (v1beta1)](#v1beta1-vmauthspec), [VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec), [VMInsert (v1beta1)](#v1beta1-vminsert), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTInsert (v1)](#v1-vtinsert), [VTSelect (v1)](#v1-vtselect), [VTSingleSpec (v1)](#v1-vtsinglespec), [VTStorage (v1)](#v1-vtstorage)
-#### Sigv4Config
+#### Sigv4Config {#v1beta1-sigv4config}
-Appears in: [SNSConfig](#snsconfig)
+Appears in: [SNSConfig (v1beta1)](#v1beta1-snsconfig)
| Field | Description |
| --- | --- |
-| access_key#
_string_ | _(Optional)_
The AWS API keys. Both access_key and secret_key must be supplied or both must be blank.
If blank the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are used. |
-| access_key_selector#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
secret key selector to get the keys from a Kubernetes Secret |
-| profile#
_string_ | _(Optional)_
Named AWS profile used to authenticate |
-| region#
_string_ | _(Optional)_
AWS region, if blank the region from the default credentials chain is used |
-| role_arn#
_string_ | _(Optional)_
AWS Role ARN, an alternative to using AWS API keys |
-| secret_key_selector#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
secret key selector to get the keys from a Kubernetes Secret |
+| access_key#
_string_ | _(Optional)_
The AWS API keys. Both access_key and secret_key must be supplied or both must be blank.
If blank the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are used. |
+| access_key_selector#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
secret key selector to get the keys from a Kubernetes Secret |
+| profile#
_string_ | _(Optional)_
Named AWS profile used to authenticate |
+| region#
_string_ | _(Optional)_
AWS region, if blank the region from the default credentials chain is used |
+| role_arn#
_string_ | _(Optional)_
AWS Role ARN, an alternative to using AWS API keys |
+| secret_key_selector#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
secret key selector to get the keys from a Kubernetes Secret |
-#### SlackAction
+#### SlackAction {#v1beta1-slackaction}
SlackAction configures a single Slack action that is sent with each
notification.
See https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#action_fields and
https://api.slack.com/docs/message-buttons for more information.
-Appears in: [SlackConfig](#slackconfig)
+Appears in: [SlackConfig (v1beta1)](#v1beta1-slackconfig)
| Field | Description |
| --- | --- |
-| confirm#
_[SlackConfirmationField](#slackconfirmationfield)_ | _(Optional)_
|
-| name#
_string_ | _(Optional)_
|
-| style#
_string_ | _(Optional)_
|
-| text#
_string_ | _(Required)_
|
-| type#
_string_ | _(Required)_
|
-| url#
_string_ | _(Optional)_
|
-| value#
_string_ | _(Optional)_
|
+| confirm#
_[SlackConfirmationField (v1beta1)](#v1beta1-slackconfirmationfield)_ | _(Optional)_
|
+| name#
_string_ | _(Optional)_
|
+| style#
_string_ | _(Optional)_
|
+| text#
_string_ | _(Required)_
|
+| type#
_string_ | _(Required)_
|
+| url#
_string_ | _(Optional)_
|
+| value#
_string_ | _(Optional)_
|
-#### SlackConfig
+#### SlackConfig {#v1beta1-slackconfig}
SlackConfig configures notifications via Slack.
See https://prometheus.io/docs/alerting/latest/configuration/#slack_config
-Appears in: [Receiver](#receiver)
-
-| Field | Description |
-| --- | --- |
-| actions#
_[SlackAction](#slackaction) array_ | _(Optional)_
A list of Slack actions that are sent with each notification. |
-| api_url#
_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | _(Optional)_
The secret's key that contains the Slack webhook URL.
It must be at them same namespace as CRD
fallback to global setting if empty |
-| callback_id#
_string_ | _(Optional)_
|
-| channel#
_string_ | _(Optional)_
The channel or user to send notifications to. |
-| color#
_string_ | _(Optional)_
|
-| fallback#
_string_ | _(Optional)_
|
-| fields#
_[SlackField](#slackfield) array_ | _(Optional)_
A list of Slack fields that are sent with each notification. |
-| footer
_string_ | _(Optional)_
|
-| http_config#
_[HTTPConfig](#httpconfig)_ | _(Optional)_
HTTP client configuration. |
-| icon_emoji#
_string_ | _(Optional)_
|
-| icon_url#
_string_ | _(Optional)_
|
-| image_url#
_string_ | _(Optional)_
|
-| link_names#
_boolean_ | _(Optional)_
|
-| mrkdwn_in#
_string array_ | _(Optional)_
|
-| pretext#
_string_ | _(Optional)_
|
-| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
-| short_fields#
_boolean_ | _(Optional)_
|
-| text#
_string_ | _(Optional)_
|
-| thumb_url#
_string_ | _(Optional)_
|
-| title#
_string_ | _(Optional)_
|
-| title_link#
_string_ | _(Optional)_
|
-| update_message#
_boolean_ | _(Optional)_
Whether to update the original message in-place instead of sending a new one.
Requires Slack Bot API and chat:write scope.
Available since alertmanager v0.32.0. |
-| username#
_string_ | _(Optional)_
|
-
-#### SlackConfirmationField
+Appears in: [Receiver (v1beta1)](#v1beta1-receiver)
+
+| Field | Description |
+| --- | --- |
+| actions#
_[SlackAction (v1beta1)](#v1beta1-slackaction) array_ | _(Optional)_
A list of Slack actions that are sent with each notification. |
+| api_url#
_[SecretKeySelector (v1)](#v1-secretkeyselector)_ | _(Optional)_
The secret's key that contains the Slack webhook URL.
It must be at them same namespace as CRD
fallback to global setting if empty |
+| callback_id#
_string_ | _(Optional)_
|
+| channel#
_string_ | _(Optional)_
The channel or user to send notifications to. |
+| color#
_string_ | _(Optional)_
|
+| fallback#
_string_ | _(Optional)_
|
+| fields#
_[SlackField (v1beta1)](#v1beta1-slackfield) array_ | _(Optional)_
A list of Slack fields that are sent with each notification. |
+| footer
_string_ | _(Optional)_
|
+| http_config#
_[HTTPConfig (v1beta1)](#v1beta1-httpconfig)_ | _(Optional)_
HTTP client configuration. |
+| icon_emoji#
_string_ | _(Optional)_
|
+| icon_url#
_string_ | _(Optional)_
|
+| image_url#
_string_ | _(Optional)_
|
+| link_names#
_boolean_ | _(Optional)_
|
+| mrkdwn_in#
_string array_ | _(Optional)_
|
+| pretext#
_string_ | _(Optional)_
|
+| send_resolved#
_boolean_ | _(Optional)_
SendResolved controls notify about resolved alerts. |
+| short_fields#
_boolean_ | _(Optional)_
|
+| text#
_string_ | _(Optional)_
|
+| thumb_url#
_string_ | _(Optional)_
|
+| title#
_string_ | _(Optional)_
|
+| title_link#
_string_ | _(Optional)_
|
+| update_message#
_boolean_ | _(Optional)_
Whether to update the original message in-place instead of sending a new one.
Requires Slack Bot API and chat:write scope.
Available since alertmanager v0.32.0. |
+| username#
_string_ | _(Optional)_
|
+
+#### SlackConfirmationField {#v1beta1-slackconfirmationfield}
SlackConfirmationField protect users from destructive actions or
particularly distinguished decisions by asking them to confirm their button
@@ -3464,334 +3464,334 @@ click one more time.
See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields
for more information.
-Appears in: [SlackAction](#slackaction)
+Appears in: [SlackAction (v1beta1)](#v1beta1-slackaction)
| Field | Description |
| --- | --- |
-| dismiss_text#
_string_ | _(Optional)_
|
-| ok_text#
_string_ | _(Optional)_
|
-| text#
_string_ | _(Required)_
|
-| title#
_string_ | _(Optional)_
|
+| dismiss_text#
_string_ | _(Optional)_
|
+| ok_text#
_string_ | _(Optional)_
|
+| text#
_string_ | _(Required)_
|
+| title#
_string_ | _(Optional)_
|
-#### SlackField
+#### SlackField {#v1beta1-slackfield}
SlackField configures a single Slack field that is sent with each notification.
See https://docs.slack.dev/legacy/legacy-messaging/legacy-secondary-message-attachments/#field_objects for more information.
-Appears in: [SlackConfig](#slackconfig)
+Appears in: [SlackConfig (v1beta1)](#v1beta1-slackconfig)
| Field | Description |
| --- | --- |
-| short#
_boolean_ | _(Optional)_
|
-| title#
_string_ | _(Required)_
|
-| value#
_string_ | _(Required)_
|
+| short#
_boolean_ | _(Optional)_
|
+| title#
_string_ | _(Required)_
|
+| value#
_string_ | _(Required)_
|
-#### StatefulSetUpdateStrategyBehavior
+#### StatefulSetUpdateStrategyBehavior {#v1beta1-statefulsetupdatestrategybehavior}
StatefulSetUpdateStrategyBehavior customizes behavior for StatefulSet updates.
-Appears in: [VLStorage](#vlstorage), [VMAgentSpec](#vmagentspec), [VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec), [VMSelect](#vmselect), [VMStorage](#vmstorage), [VTStorage](#vtstorage)
+Appears in: [VLStorage (v1)](#v1-vlstorage), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTStorage (v1)](#v1-vtstorage)
| Field | Description |
| --- | --- |
-| maxUnavailable#
_[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#intorstring-intstr-util)_ | _(Optional)_
MaxUnavailable defines the maximum number of pods that can be unavailable during the update.
It can be specified as an absolute number (e.g. 2) or a percentage of the total pods (e.g. "50%").
For example, if set to 100%, all pods will be upgraded at once, minimizing downtime when needed. |
+| maxUnavailable#
_[IntOrString (intstr)](#intstr-intorstring)_ | _(Optional)_
MaxUnavailable defines the maximum number of pods that can be unavailable during the update.
It can be specified as an absolute number (e.g. 2) or a percentage of the total pods (e.g. "50%").
For example, if set to 100%, all pods will be upgraded at once, minimizing downtime when needed. |
-#### StaticConfig
+#### StaticConfig {#v1beta1-staticconfig}
StaticConfig defines a static configuration.
See [here](https://docs.victoriametrics.com/victoriametrics/sd_configs/#static_configs)
-Appears in: [VMScrapeConfigSpec](#vmscrapeconfigspec)
+Appears in: [VMScrapeConfigSpec (v1beta1)](#v1beta1-vmscrapeconfigspec)
| Field | Description |
| --- | --- |
-| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels assigned to all metrics scraped from the targets. |
-| targets#
_string array_ | _(Optional)_
List of targets for this static configuration. |
+| labels#
_object (keys:string, values:string)_ | _(Optional)_
Labels assigned to all metrics scraped from the targets. |
+| targets#
_string array_ | _(Optional)_
List of targets for this static configuration. |
-#### StaticRef
+#### StaticRef {#v1beta1-staticref}
StaticRef - user-defined routing host address.
-Appears in: [TargetRef](#targetref)
+Appears in: [TargetRef (v1beta1)](#v1beta1-targetref)
| Field | Description |
| --- | --- |
-| url#
_string_ | _(Required)_
URL http url for given staticRef. |
-| urls#
_string array_ | _(Optional)_
URLs allows setting multiple urls for load-balancing at vmauth-side. |
+| url#
_string_ | _(Required)_
URL http url for given staticRef. |
+| urls#
_string array_ | _(Optional)_
URLs allows setting multiple urls for load-balancing at vmauth-side. |
-#### StorageSpec
+#### StorageSpec {#v1beta1-storagespec}
StorageSpec defines the configured storage for a group VM servers.
If neither `emptyDir` nor `volumeClaimTemplate` is specified, then by default an [EmptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) will be used.
-Appears in: [VLAgentSpec](#vlagentspec), [VLDistributedZoneAgentSpec](#vldistributedzoneagentspec), [VLStorage](#vlstorage), [VMAgentSpec](#vmagentspec), [VMAlertmanagerSpec](#vmalertmanagerspec), [VMAnomalySpec](#vmanomalyspec), [VMDistributedZoneAgentSpec](#vmdistributedzoneagentspec), [VMSelect](#vmselect), [VMStorage](#vmstorage), [VTStorage](#vtstorage)
+Appears in: [VLAgentSpec (v1)](#v1-vlagentspec), [VLDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vldistributedzoneagentspec), [VLStorage (v1)](#v1-vlstorage), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMAlertmanagerSpec (v1beta1)](#v1beta1-vmalertmanagerspec), [VMAnomalySpec (v1)](#v1-vmanomalyspec), [VMDistributedZoneAgentSpec (v1alpha1)](#v1alpha1-vmdistributedzoneagentspec), [VMSelect (v1beta1)](#v1beta1-vmselect), [VMStorage (v1beta1)](#v1beta1-vmstorage), [VTStorage (v1)](#v1-vtstorage)
| Field | Description |
| --- | --- |
-| emptyDir#
_[EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#emptydirvolumesource-v1-core)_ | _(Optional)_
EmptyDirVolumeSource to be used by the Prometheus StatefulSets. If specified, used in place of any volumeClaimTemplate. More
info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir |
-| volumeClaimTemplate#
_[EmbeddedPersistentVolumeClaim](#embeddedpersistentvolumeclaim)_ | _(Optional)_
A PVC spec to be used by the StatefulSets/Deployments. |
+| emptyDir#
_[EmptyDirVolumeSource (v1)](#v1-emptydirvolumesource)_ | _(Optional)_
EmptyDirVolumeSource to be used by the Prometheus StatefulSets. If specified, used in place of any volumeClaimTemplate. More
info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir |
+| volumeClaimTemplate#
_[EmbeddedPersistentVolumeClaim (v1beta1)](#v1beta1-embeddedpersistentvolumeclaim)_ | _(Optional)_
A PVC spec to be used by the StatefulSets/Deployments. |
-#### StreamAggrConfig
+#### StreamAggrConfig {#v1beta1-streamaggrconfig}
StreamAggrConfig defines the stream aggregation config
-Appears in: [VMAgentRemoteWriteSpec](#vmagentremotewritespec), [VMAgentSpec](#vmagentspec), [VMSingleSpec](#vmsinglespec)
+Appears in: [VMAgentRemoteWriteSpec (v1beta1)](#v1beta1-vmagentremotewritespec), [VMAgentSpec (v1beta1)](#v1beta1-vmagentspec), [VMSingleSpec (v1beta1)](#v1beta1-vmsinglespec)
| Field | Description |
| --- | --- |
-| configmap#
_[ConfigMapKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#configmapkeyselector-v1-core)_ | _(Optional)_
ConfigMap with stream aggregation rules |
-| dedupInterval#
_string_ | _(Optional)_
Allows setting different de-duplication intervals per each configured remote storage |
-| dropInput#
_boolean_ | _(Optional)_
Allow drop all the input samples after the aggregation |
-| dropInputLabels#
_string array_ | _(Optional)_
labels to drop from samples for aggregator before stream de-duplication and aggregation |
-| enableWindows#
_boolean_ | _(Optional)_
EnableWindows enables aggregating data in separate windows.
Available from: v0.54.0 |
-| ignoreFirstIntervals#
_integer_ | _(Optional)_
IgnoreFirstIntervals instructs to ignore first interval |
-| ignoreFirstSampleInterval#
_string_ | _(Required)_
IgnoreFirstSampleInterval sets interval for total and prometheus_total during which first samples will be ignored |
-| ignoreOldSamples#
_boolean_ | _(Optional)_
IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval. |
-| keepInput#
_boolean_ | _(Optional)_
Allows writing both raw and aggregate data |
-| rules#
_[StreamAggrRule](#streamaggrrule) array_ | _(Optional)_
Stream aggregation rules |
+| configmap#
_[ConfigMapKeySelector (v1)](#v1-configmapkeyselector)_ | _(Optional)_
ConfigMap with stream aggregation rules |
+| dedupInterval#
_string_ | _(Optional)_
Allows setting different de-duplication intervals per each configured remote storage |
+| dropInput#
_boolean_ | _(Optional)_
Allow drop all the input samples after the aggregation |
+| dropInputLabels#
_string array_ | _(Optional)_
labels to drop from samples for aggregator before stream de-duplication and aggregation |
+| enableWindows#
_boolean_ | _(Optional)_
EnableWindows enables aggregating data in separate windows.
Available from: v0.54.0 |
+| ignoreFirstIntervals#
_integer_ | _(Optional)_
IgnoreFirstIntervals instructs to ignore first interval |
+| ignoreFirstSampleInterval#
_string_ | _(Required)_
IgnoreFirstSampleInterval sets interval for total and prometheus_total during which first samples will be ignored |
+| ignoreOldSamples#
_boolean_ | _(Optional)_
IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval. |
+| keepInput#
_boolean_ | _(Optional)_
Allows writing both raw and aggregate data |
+| rules#
_[StreamAggrRule (v1beta1)](#v1beta1-streamaggrrule) array_ | _(Optional)_
Stream aggregation rules |
-#### StreamAggrRule
+#### StreamAggrRule {#v1beta1-streamaggrrule}
StreamAggrRule defines the rule in stream aggregation config
-Appears in: [StreamAggrConfig](#streamaggrconfig)
+Appears in: [StreamAggrConfig (v1beta1)](#v1beta1-streamaggrconfig)
| Field | Description |
| --- | --- |
-| by#
_string array_ | _(Optional)_
By is an optional list of labels for grouping input series.
See also Without.
If neither By nor Without are set, then the Outputs are calculated
individually per each input time series. |
-| dedup_interval#
_string_ | _(Optional)_
DedupInterval is an optional interval for deduplication. |
-| drop_input_labels#
_string_ | _(Optional)_
DropInputLabels is an optional list with labels, which must be dropped before further processing of input samples.
Labels are dropped before de-duplication and aggregation. |
-| enable_windows#
_boolean_ | _(Optional)_
EnableWindows enables aggregating data in separate windows |
-| flush_on_shutdown#
_boolean_ | _(Optional)_
FlushOnShutdown defines whether to flush the aggregation state on process termination
or config reload. Is `false` by default.
It is not recommended changing this setting, unless unfinished aggregations states
are preferred to missing data points. |
-| ignoreFirstSampleInterval#
_string_ | _(Required)_
IgnoreFirstSampleInterval sets interval for total and prometheus_total during which first samples will be ignored |
-| ignore_first_intervals#
_integer_ | _(Required)_
|
-| ignore_old_samples#
_boolean_ | _(Optional)_
IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval. |
-| input_relabel_configs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
InputRelabelConfigs is an optional relabeling rules, which are applied on the input
before aggregation. |
-| interval#
_string_ | _(Required)_
Interval is the interval between aggregations. |
-| keep_metric_names#
_boolean_ | _(Optional)_
KeepMetricNames instructs to leave metric names as is for the output time series without adding any suffix. |
-| match#
_[StringOrArray](#stringorarray)_ | _(Optional)_
Match is a label selector (or list of label selectors) for filtering time series for the given selector.
If the match isn't set, then all the input time series are processed. |
-| no_align_flush_to_interval#
_boolean_ | _(Optional)_
NoAlignFlushToInterval disables aligning of flushes to multiples of Interval.
By default flushes are aligned to Interval. |
-| output_relabel_configs#
_[RelabelConfig](#relabelconfig) array_ | _(Optional)_
OutputRelabelConfigs is an optional relabeling rules, which are applied
on the aggregated output before being sent to remote storage. |
-| outputs#
_string array_ | _(Required)_
Outputs is a list of output aggregate functions to produce.
The following names are allowed:
- total - aggregates input counters
- increase - counts the increase over input counters
- count_series - counts the input series
- count_samples - counts the input samples
- sum_samples - sums the input samples
- last - the last biggest sample value
- min - the minimum sample value
- max - the maximum sample value
- avg - the average value across all the samples
- stddev - standard deviation across all the samples
- stdvar - standard variance across all the samples
- histogram_bucket - creates VictoriaMetrics histogram for input samples
- quantiles(phi1, ..., phiN) - quantiles' estimation for phi in the range [0..1]
The output time series will have the following names:
input_name:aggr__