additionalScrapeConfigs
object
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.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
affinity
object
Affinity If specified, the pod's scheduling constraints.
apiServerConfig
object
APIServerConfig allows specifying a host and auth methods to access apiserver.
If left empty, VMAgent is assumed to run inside of the cluster
and will discover API servers automatically and use the pod's CA certificate
and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.
authorization
object
Authorization configures generic authorization params
credentials
object
Reference to the secret with value for authorization
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
credentialsFile
string
File with value for authorization
type
string
Type of authorization, default to bearer
basicAuth
object
BasicAuth allow an endpoint to authenticate over basic authentication
password
object
Password defines reference for secret with password value
The secret needs to be in the same namespace as scrape object
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
password_file
string
PasswordFile defines path to password file at disk
must be pre-mounted
username
object
Username defines reference for secret with username value
The secret needs to be in the same namespace as scrape object
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
bearerToken
string
Bearer token for accessing apiserver.
bearerTokenFile
string
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
object
TLSConfig Config to use for accessing apiserver.
ca
object
Struct containing the CA cert to use for the targets.
configMap
object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret
object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
caFile
string
Path to the CA cert in the container to use for the targets.
cert
object
Struct containing the client cert file for the targets.
configMap
object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret
object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
certFile
string
Path to the client cert file in the container for the targets.
insecureSkipVerify
boolean
Disable target certificate validation.
keyFile
string
Path to the client key file in the container for the targets.
keySecret
object
Secret containing the client key file for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
serverName
string
Used to verify the hostname for the targets.
arbitraryFSAccessThroughSMs
object
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
claimTemplates
[]object
ClaimTemplates allows adding additional VolumeClaimTemplates for VMAgent in StatefulMode
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
Standard object's metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec
object
spec defines the desired characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
accessModes
[]string
accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSource
object
dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.
apiGroup
string
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
kind
string required
Kind is the type of resource being referenced
name
string required
Name is the name of resource being referenced
dataSourceRef
object
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
apiGroup
string
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
kind
string required
Kind is the type of resource being referenced
name
string required
Name is the name of resource being referenced
namespace
string
Namespace is the namespace of resource being referenced
Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
resources
object
resources represents the minimum resources the volume should have.
Users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
limits
object
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests
object
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
selector
object
selector is a label query over volumes to consider for binding.
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
storageClassName
string
storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeAttributesClassName
string
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string or nil value indicates that no
VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
this field can be reset to its previous value (including nil) to cancel the modification.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/
volumeMode
string
volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
volumeName
string
volumeName is the binding reference to the PersistentVolume backing this claim.
status
object
status represents the current information/status of a persistent volume claim.
Read-only.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
accessModes
[]string
accessModes contains the actual access modes the volume backing the PVC has.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
allocatedResourceStatuses
object
allocatedResourceStatuses stores status of resource being resized for the given PVC.
Key names follow standard Kubernetes label syntax. Valid values are either:
* Un-prefixed keys:
- storage - the capacity of the volume.
* Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered
reserved and hence may not be used.
ClaimResourceStatus can be in any of following states:
- ControllerResizeInProgress:
State set when resize controller starts resizing the volume in control-plane.
- ControllerResizeFailed:
State set when resize has failed in resize controller with a terminal error.
- NodeResizePending:
State set when resize controller has finished resizing the volume but further resizing of
volume is needed on the node.
- NodeResizeInProgress:
State set when kubelet starts resizing the volume.
- NodeResizeFailed:
State set when resizing has failed in kubelet with a terminal error. Transient errors don't set
NodeResizeFailed.
For example: if expanding a PVC for more capacity - this field can be one of the following states:
- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress"
- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed"
- pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending"
- pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress"
- pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed"
When this field is not set, it means that no resize operation is in progress for the given PVC.
A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus
should ignore the update for the purpose it was designed. For example - a controller that
only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid
resources associated with PVC.
allocatedResources
object
allocatedResources tracks the resources allocated to a PVC including its capacity.
Key names follow standard Kubernetes label syntax. Valid values are either:
* Un-prefixed keys:
- storage - the capacity of the volume.
* Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered
reserved and hence may not be used.
Capacity reported here may be larger than the actual capacity when a volume expansion operation
is requested.
For storage quota, the larger value from allocatedResources and PVC.spec.resources is used.
If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation.
If a volume expansion capacity request is lowered, allocatedResources is only
lowered if there are no expansion operations in progress and if the actual volume capacity
is equal or lower than the requested capacity.
A controller that receives PVC update with previously unknown resourceName
should ignore the update for the purpose it was designed. For example - a controller that
only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid
resources associated with PVC.
capacity
object
capacity represents the actual resources of the underlying volume.
conditions
[]object
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being
resized then the Condition will be set to 'Resizing'.
lastProbeTime
string
lastProbeTime is the time we probed the condition.
lastTransitionTime
string
lastTransitionTime is the time the condition transitioned from one status to another.
message
string
message is the human-readable message indicating details about last transition.
reason
string
reason is a unique, this should be a short, machine understandable string that gives the reason
for condition's last transition. If it reports "Resizing" that means the underlying
persistent volume is being resized.
status
string required
Status is the status of the condition.
Can be True, False, Unknown.
More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required
type
string required
Type is the type of the condition.
More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about
currentVolumeAttributesClassName
string
currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using.
When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim
modifyVolumeStatus
object
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.
When this is unset, there is no ModifyVolume operation being attempted.
status
string required
status is the status of the ControllerModifyVolume operation. It can be in any of following states:
- Pending
Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as
the specified VolumeAttributesClass not existing.
- InProgress
InProgress indicates that the volume is being modified.
- Infeasible
Infeasible indicates that the request has been rejected as invalid by the CSI driver. To
resolve the error, a valid VolumeAttributesClass needs to be specified.
Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
targetVolumeAttributesClassName
string
targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
phase
string
phase represents the current phase of PersistentVolumeClaim.
componentVersion
string
ComponentVersion defines default images tag for all components.
it can be overwritten with component specific image.tag value.
configMaps
[]string
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
configReloadAuthKeySecret
object
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 since v0.57.0 version
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
configReloaderExtraArgs
object
ConfigReloaderExtraArgs that will be passed to VMAuths config-reloader container
for example resync-interval: "30s"
configReloaderImage
string
ConfigReloaderImage defines image:tag for config-reloader container
configReloaderImageTag
string
ConfigReloaderImageTag defines image:tag for config-reloader container
configReloaderResources
object
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
claims
[]object
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This field depends on the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
name
string required
Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.
request
string
Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.
limits
object
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests
object
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
containers
[]object
Containers property allows to inject additions sidecars or to patch existing containers.
It can be useful for proxies, backup, etc.
daemonSetMode
boolean
DaemonSetMode enables DaemonSet deployment mode instead of Deployment.
Supports only VMPodScrape
(available from v0.55.0).
Cannot be used with statefulMode
daemonSetRollingUpdateStrategyBehavior
object
DaemonSetRollingUpdateStrategyBehavior defines customized behavior for rolling updates.
It applies if the DaemonSetUpdateStrategy is set to RollingUpdate, which is the default.
maxSurge
string | integer
The maximum number of nodes with an existing available DaemonSet pod that
can have an updated DaemonSet pod during during an update.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
This can not be 0 if MaxUnavailable is 0.
Absolute number is calculated from percentage by rounding up to a minimum of 1.
Default value is 0.
Example: when this is set to 30%, at most 30% of the total number of nodes
that should be running the daemon pod (i.e. status.desiredNumberScheduled)
can have their a new pod created before the old pod is marked as deleted.
The update starts by launching new pods on 30% of nodes. Once an updated
pod is available (Ready for at least minReadySeconds) the old DaemonSet pod
on that node is marked deleted. If the old pod becomes unavailable for any
reason (Ready transitions to false, is evicted, or is drained) an updated
pod is immediately created on that node without considering surge limits.
Allowing surge implies the possibility that the resources consumed by the
daemonset on any given node can double if the readiness check fails, and
so resource intensive daemonsets should take into account that they may
cause evictions during disruption.
maxUnavailable
string | integer
The maximum number of DaemonSet pods that can be unavailable during the
update. Value can be an absolute number (ex: 5) or a percentage of total
number of DaemonSet pods at the start of the update (ex: 10%). Absolute
number is calculated from percentage by rounding up.
This cannot be 0 if MaxSurge is 0
Default value is 1.
Example: when this is set to 30%, at most 30% of the total number of nodes
that should be running the daemon pod (i.e. status.desiredNumberScheduled)
can have their pods stopped for an update at any given time. The update
starts by stopping at most 30% of those DaemonSet pods and then brings
up new DaemonSet pods in their place. Once the new pods are available,
it then proceeds onto other DaemonSet pods, thus ensuring that at least
70% of original number of DaemonSet pods are available at all times during
the update.
daemonSetUpdateStrategy
string
DaemonSetUpdateStrategy allows configuration for the DaemonSet update strategy type.
disableAutomountServiceAccountToken
boolean
DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes (available from v0.54.0).
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.
disableSelfServiceScrape
boolean
DisableSelfServiceScrape controls creation of VMServiceScrape by operator
for the application.
Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable
dnsConfig
object
Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy.
nameservers
[]string
A list of DNS name server IP addresses.
This will be appended to the base nameservers generated from DNSPolicy.
Duplicated nameservers will be removed.
options
[]object
A list of DNS resolver options.
This will be merged with the base options generated from DNSPolicy.
Duplicated entries will be removed. Resolution options given in Options
will override those that appear in the base DNSPolicy.
name
string
Name is this DNS resolver option's name.
Required.
value
string
Value is this DNS resolver option's value.
searches
[]string
A list of DNS search domains for host-name lookup.
This will be appended to the base search paths generated from DNSPolicy.
Duplicated search paths will be removed.
dnsPolicy
string
DNSPolicy sets DNS policy for the pod
enableKubernetesAPISelectors
boolean
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
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
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
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
extraArgs
object
ExtraArgs that will be passed to the application container
for example remoteWrite.tmpDataPath: /tmp
extraEnvs
[]object
ExtraEnvs that will be passed to the application container
name
string required
Name of the environment variable.
May consist of any printable ASCII characters except '='.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
extraEnvsFrom
[]object
ExtraEnvsFrom defines source of env variables for the application container
could either be secret or configmap
configMapRef
object
The ConfigMap to select from
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
Optional text to prepend to the name of each environment variable.
May consist of any printable ASCII characters except '='.
secretRef
object
The Secret to select from
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret must be defined
globalScrapeMetricRelabelConfigs
[]object
GlobalScrapeMetricRelabelConfigs is a global metric relabel configuration, which is applied to each scrape job.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
globalScrapeRelabelConfigs
[]object
GlobalScrapeRelabelConfigs is a global relabel configuration, which is applied to each samples of each scrape job during service discovery.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
hostAliases
[]object
HostAliases provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
hostnames
[]string
Hostnames for the above IP address.
ip
string required
IP address of the host file entry.
hostNetwork
boolean
HostNetwork controls whether the pod may use the node network namespace
host_aliases
[]object
HostAliasesUnderScore provides mapping for ip and hostname,
that would be propagated to pod,
cannot be used with HostNetwork.
Has Priority over hostAliases field
hostnames
[]string
Hostnames for the above IP address.
ip
string required
IP address of the host file entry.
hpa
object
Configures horizontal pod autoscaling.
behaviour
object
HorizontalPodAutoscalerBehavior configures the scaling behavior of the target
in both Up and Down directions (scaleUp and scaleDown fields respectively).
scaleDown
object
scaleDown is scaling policy for scaling Down.
If not set, the default value is to allow to scale down to minReplicas pods, with a
300 second stabilization window (i.e., the highest recommendation for
the last 300sec is used).
policies
[]object
policies is a list of potential scaling polices which can be used during scaling.
If not set, use the default values:
- For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window.
- For scale down: allow all pods to be removed in a 15s window.
periodSeconds
integer required
periodSeconds specifies the window of time for which the policy should hold true.
PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
type
string required
type is used to specify the scaling policy.
value
integer required
value contains the amount of change which is permitted by the policy.
It must be greater than zero
selectPolicy
string
selectPolicy is used to specify which policy should be used.
If not set, the default value Max is used.
stabilizationWindowSeconds
integer
stabilizationWindowSeconds is the number of seconds for which past recommendations should be
considered while scaling up or scaling down.
StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour).
If not set, use the default values:
- For scale up: 0 (i.e. no stabilization is done).
- For scale down: 300 (i.e. the stabilization window is 300 seconds long).
tolerance
string | integer
tolerance is the tolerance on the ratio between the current and desired
metric value under which no updates are made to the desired number of
replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not
set, the default cluster-wide tolerance is applied (by default 10%).
For example, if autoscaling is configured with a memory consumption target of 100Mi,
and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be
triggered when the actual consumption falls below 95Mi or exceeds 101Mi.
This is an beta field and requires the HPAConfigurableTolerance feature
gate to be enabled.
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
scaleUp
object
scaleUp is scaling policy for scaling Up.
If not set, the default value is the higher of:
* increase no more than 4 pods per 60 seconds
* double the number of pods per 60 seconds
No stabilization is used.
policies
[]object
policies is a list of potential scaling polices which can be used during scaling.
If not set, use the default values:
- For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window.
- For scale down: allow all pods to be removed in a 15s window.
periodSeconds
integer required
periodSeconds specifies the window of time for which the policy should hold true.
PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
type
string required
type is used to specify the scaling policy.
value
integer required
value contains the amount of change which is permitted by the policy.
It must be greater than zero
selectPolicy
string
selectPolicy is used to specify which policy should be used.
If not set, the default value Max is used.
stabilizationWindowSeconds
integer
stabilizationWindowSeconds is the number of seconds for which past recommendations should be
considered while scaling up or scaling down.
StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour).
If not set, use the default values:
- For scale up: 0 (i.e. no stabilization is done).
- For scale down: 300 (i.e. the stabilization window is 300 seconds long).
tolerance
string | integer
tolerance is the tolerance on the ratio between the current and desired
metric value under which no updates are made to the desired number of
replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not
set, the default cluster-wide tolerance is applied (by default 10%).
For example, if autoscaling is configured with a memory consumption target of 100Mi,
and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be
triggered when the actual consumption falls below 95Mi or exceeds 101Mi.
This is an beta field and requires the HPAConfigurableTolerance feature
gate to be enabled.
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
metrics
[]object
containerResource
object
containerResource refers to a resource metric (such as those specified in
requests and limits) known to Kubernetes describing a single container in
each pod of the current scale target (e.g. CPU or memory). Such metrics are
built in to Kubernetes, and have special scaling options on top of those
available to normal per-pod metrics using the "pods" source.
container
string required
container is the name of the container in the pods of the scaling target
name
string required
name is the name of the resource in question.
target
object required
target specifies the target value for the given metric
averageUtilization
integer
averageUtilization is the target value of the average of the
resource metric across all relevant pods, represented as a percentage of
the requested value of the resource for the pods.
Currently only valid for Resource metric source type
averageValue
string | integer
averageValue is the target value of the average of the
metric across all relevant pods (as a quantity)
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
type represents whether the metric type is Utilization, Value, or AverageValue
value
string | integer
value is the target value of the metric (as a quantity).
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
external
object
external refers to a global metric that is not associated
with any Kubernetes object. It allows autoscaling based on information
coming from components running outside of cluster
(for example length of queue in cloud messaging service, or
QPS from loadbalancer running outside of cluster).
metric
object required
metric identifies the target metric by name and selector
name
string required
name is the name of the given metric
selector
object
selector is the string-encoded form of a standard kubernetes label selector for the given metric
When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping.
When unset, just the metricName will be used to gather metrics.
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
target
object required
target specifies the target value for the given metric
averageUtilization
integer
averageUtilization is the target value of the average of the
resource metric across all relevant pods, represented as a percentage of
the requested value of the resource for the pods.
Currently only valid for Resource metric source type
averageValue
string | integer
averageValue is the target value of the average of the
metric across all relevant pods (as a quantity)
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
type represents whether the metric type is Utilization, Value, or AverageValue
value
string | integer
value is the target value of the metric (as a quantity).
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
object
object
object refers to a metric describing a single kubernetes object
(for example, hits-per-second on an Ingress object).
describedObject
object required
describedObject specifies the descriptions of a object,such as kind,name apiVersion
apiVersion
string
apiVersion is the API version of the referent
kind
string required
kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name
string required
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
metric
object required
metric identifies the target metric by name and selector
name
string required
name is the name of the given metric
selector
object
selector is the string-encoded form of a standard kubernetes label selector for the given metric
When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping.
When unset, just the metricName will be used to gather metrics.
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
target
object required
target specifies the target value for the given metric
averageUtilization
integer
averageUtilization is the target value of the average of the
resource metric across all relevant pods, represented as a percentage of
the requested value of the resource for the pods.
Currently only valid for Resource metric source type
averageValue
string | integer
averageValue is the target value of the average of the
metric across all relevant pods (as a quantity)
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
type represents whether the metric type is Utilization, Value, or AverageValue
value
string | integer
value is the target value of the metric (as a quantity).
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
pods
object
pods refers to a metric describing each pod in the current scale target
(for example, transactions-processed-per-second). The values will be
averaged together before being compared to the target value.
metric
object required
metric identifies the target metric by name and selector
name
string required
name is the name of the given metric
selector
object
selector is the string-encoded form of a standard kubernetes label selector for the given metric
When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping.
When unset, just the metricName will be used to gather metrics.
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
target
object required
target specifies the target value for the given metric
averageUtilization
integer
averageUtilization is the target value of the average of the
resource metric across all relevant pods, represented as a percentage of
the requested value of the resource for the pods.
Currently only valid for Resource metric source type
averageValue
string | integer
averageValue is the target value of the average of the
metric across all relevant pods (as a quantity)
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
type represents whether the metric type is Utilization, Value, or AverageValue
value
string | integer
value is the target value of the metric (as a quantity).
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
object
resource refers to a resource metric (such as those specified in
requests and limits) known to Kubernetes describing each pod in the
current scale target (e.g. CPU or memory). Such metrics are built in to
Kubernetes, and have special scaling options on top of those available
to normal per-pod metrics using the "pods" source.
name
string required
name is the name of the resource in question.
target
object required
target specifies the target value for the given metric
averageUtilization
integer
averageUtilization is the target value of the average of the
resource metric across all relevant pods, represented as a percentage of
the requested value of the resource for the pods.
Currently only valid for Resource metric source type
averageValue
string | integer
averageValue is the target value of the average of the
metric across all relevant pods (as a quantity)
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
type represents whether the metric type is Utilization, Value, or AverageValue
value
string | integer
value is the target value of the metric (as a quantity).
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
type is the type of metric source. It should be one of "ContainerResource", "External",
"Object", "Pods" or "Resource", each mapping to a matching field in the object.
ignoreNamespaceSelectors
boolean
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.
image
object
Image - docker image settings
if no specified operator uses default version from operator config
pullPolicy
string
PullPolicy describes how to pull docker image
repository
string
Repository contains name of docker image + it's repository if needed
tag
string
Tag contains desired docker image version
imagePullSecrets
[]object
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/#referring-to-an-imagepullsecrets-on-a-pod
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
ingestOnlyMode
boolean
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
initContainers
[]object
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/
inlineRelabelConfig
[]object
InlineRelabelConfig - defines GlobalRelabelConfig for vmagent, can be defined directly at CRD.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
inlineScrapeConfig
string
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"]
insertPorts
object
InsertPorts - additional listen ports for data ingestion.
graphitePort
string
GraphitePort listen port
influxPort
string
InfluxPort listen port
openTSDBHTTPPort
string
OpenTSDBHTTPPort for http connections.
openTSDBPort
string
OpenTSDBPort for tcp and udp listen
license
object
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/)
forceOffline
boolean
Enforce offline verification of the license key.
key
string
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
object
KeyRef is reference to secret with license key for enterprise features.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
reloadInterval
string
Interval to be used for checking for license key changes. Note that this is only applicable when using KeyRef.
livenessProbe
object
LivenessProbe that will be added to CR pod
logFormat
string
LogFormat for VMAgent to be configured with.
logLevel
string
LogLevel for VMAgent to be configured with.
INFO, WARN, ERROR, FATAL, PANIC
enum: INFO, WARN, ERROR, FATAL, PANIC
managedMetadata
object
ManagedMetadata defines metadata that will be added to the all objects
created by operator for the given CustomResource
annotations
object
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
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
maxScrapeInterval
string
MaxScrapeInterval allows limiting maximum scrape interval for VMServiceScrape, VMPodScrape and other scrapes
If interval is higher than defined limit, `maxScrapeInterval` will be used.
minReadySeconds
integer
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
minScrapeInterval
string
MinScrapeInterval allows limiting minimal scrape interval for VMServiceScrape, VMPodScrape and other scrapes
If interval is lower than defined limit, `minScrapeInterval` will be used.
nodeScrapeNamespaceSelector
object
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
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
nodeScrapeRelabelTemplate
[]object
NodeScrapeRelabelTemplate defines relabel config, that will be added to each VMNodeScrape.
it's useful for adding specific labels to all targets
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
nodeScrapeSelector
object
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
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
nodeSelector
object
NodeSelector Define which Nodes the Pods are scheduled on.
overrideHonorLabels
boolean
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
OverrideHonorTimestamps allows to globally enforce honoring timestamps in all scrape configs.
paused
boolean
Paused If set to true all actions on the underlying managed objects are not
going to be performed, except for delete actions.
persistentVolumeClaimRetentionPolicy
object
PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy
whenDeleted
string
WhenDeleted specifies what happens to PVCs created from StatefulSet
VolumeClaimTemplates when the StatefulSet is deleted. The default policy
of `Retain` causes PVCs to not be affected by StatefulSet deletion. The
`Delete` policy causes those PVCs to be deleted.
whenScaled
string
WhenScaled specifies what happens to PVCs created from StatefulSet
VolumeClaimTemplates when the StatefulSet is scaled down. The default
policy of `Retain` causes PVCs to not be affected by a scaledown. The
`Delete` policy causes the associated PVCs for any excess pods above
the replica count to be deleted.
podDisruptionBudget
object
PodDisruptionBudget created by operator
maxUnavailable
string | integer
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
string | integer
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
replaces default labels selector generated by operator
it's useful when you need to create custom budget
unhealthyPodEvictionPolicy
string
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 operator v0.64.0
enum: IfHealthyBudget, AlwaysAllow
podMetadata
object
PodMetadata configures Labels and Annotations which are propagated to the vmagent pods.
annotations
object
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
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
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
podScrapeNamespaceSelector
object
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
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
podScrapeRelabelTemplate
[]object
PodScrapeRelabelTemplate defines relabel config, that will be added to each VMPodScrape.
it's useful for adding specific labels to all targets
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
podScrapeSelector
object
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
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
port
string
Port listen address
priorityClassName
string
PriorityClassName class assigned to the Pods
probeNamespaceSelector
object
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
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
probeScrapeRelabelTemplate
[]object
ProbeScrapeRelabelTemplate defines relabel config, that will be added to each VMProbeScrape.
it's useful for adding specific labels to all targets
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
probeSelector
object
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
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
readinessGates
[]object
ReadinessGates defines pod readiness gates
conditionType
string required
ConditionType refers to a condition in the pod's condition list with matching type.
readinessProbe
object
ReadinessProbe that will be added to CR pod
relabelConfig
object
RelabelConfig ConfigMap with global relabel config -remoteWrite.relabelConfig
This relabeling is applied to all the collected metrics before sending them to remote storage.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
remoteWrite
[]object required
RemoteWrite list of victoria metrics /some other remote write system
for vm it must looks like: http://victoria-metrics-single:8428/api/v1/write
or for cluster different url
https://docs.victoriametrics.com/victoriametrics/vmagent/#splitting-data-streams-among-multiple-systems
aws
object
AWS describes params specific to AWS cloud
ec2Endpoint
string
EC2Endpoint is an optional AWS EC2 API endpoint to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
region
string
Region is an optional AWS region to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
roleARN
string
RoleARN is an optional AWS region to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
service
string
Service is an optional AWS Service to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
stsEndpoint
string
STSEndpoint is an optional AWS STS API endpoint to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
useSigv4
boolean
UseSigv4 enables SigV4 request signing for the corresponding -remoteWrite.url
basicAuth
object
BasicAuth allow an endpoint to authenticate over basic authentication
password
object
Password defines reference for secret with password value
The secret needs to be in the same namespace as scrape object
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
password_file
string
PasswordFile defines path to password file at disk
must be pre-mounted
username
object
Username defines reference for secret with username value
The secret needs to be in the same namespace as scrape object
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret
object
Optional bearer auth token to use for -remoteWrite.url
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
forceVMProto
boolean
ForceVMProto forces using VictoriaMetrics protocol for sending data to -remoteWrite.url
headers
[]string
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
inlineUrlRelabelConfig
[]object
InlineUrlRelabelConfig defines relabeling config for remoteWriteURL, it can be defined at crd spec.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
maxDiskUsage
object
MaxDiskUsage defines the maximum file-based buffer size in bytes for the given remoteWrite
It overrides global configuration defined at remoteWriteSettings.maxDiskUsagePerURL
oauth2
object
OAuth2 defines auth configuration
client_id
object required
The secret or configmap containing the OAuth2 client id
configMap
object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret
object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
client_secret
object
The secret containing the OAuth2 client secret
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
client_secret_file
string
ClientSecretFile defines path for client secret file.
endpoint_params
object
Parameters to append to the token URL
proxy_url
string
The proxy URL for token_url connection
( available from v0.55.0).
Is only supported by Scrape objects family
scopes
[]string
OAuth2 scopes used for the token request
tls_config
object
TLSConfig for token_url connection
( available from v0.55.0).
Is only supported by Scrape objects family
token_url
string required
The URL to fetch the token from
proxyURL
string
ProxyURL for -remoteWrite.url. Supported proxies: http, https, socks5. Example: socks5://proxy:1234
sendTimeout
string
Timeout for sending a single block of data to -remoteWrite.url (default 1m0s)
pattern: [0-9]+(ms|s|m|h)
streamAggrConfig
object
StreamAggrConfig defines stream aggregation configuration for VMAgent for -remoteWrite.url
configmap
object
ConfigMap with stream aggregation rules
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
dedupInterval
string
Allows setting different de-duplication intervals per each configured remote storage
dropInput
boolean
Allow drop all the input samples after the aggregation
dropInputLabels
[]string
labels to drop from samples for aggregator before stream de-duplication and aggregation
enableWindows
boolean
EnableWindows enables aggregating data in separate windows ( available from v0.54.0).
ignoreFirstIntervals
integer
IgnoreFirstIntervals instructs to ignore first interval
ignoreFirstSampleInterval
string
IgnoreFirstSampleInterval sets interval for total and prometheus_total during which first samples will be ignored
ignoreOldSamples
boolean
IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval.
keepInput
boolean
Allows writing both raw and aggregate data
rules
[]object
Stream aggregation rules
by
[]string
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
DedupInterval is an optional interval for deduplication.
drop_input_labels
[]string
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
EnableWindows enables aggregating data in separate windows
flush_on_shutdown
boolean
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
IgnoreFirstSampleInterval sets interval for total and prometheus_total during which first samples will be ignored
ignore_first_intervals
integer
ignore_old_samples
boolean
IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval.
input_relabel_configs
[]object
InputRelabelConfigs is an optional relabeling rules, which are applied on the input
before aggregation.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
interval
string required
Interval is the interval between aggregations.
keep_metric_names
boolean
KeepMetricNames instructs to leave metric names as is for the output time series without adding any suffix.
match
object
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
NoAlignFlushToInterval disables aligning of flushes to multiples of Interval.
By default flushes are aligned to Interval.
output_relabel_configs
[]object
OutputRelabelConfigs is an optional relabeling rules, which are applied
on the aggregated output before being sent to remote storage.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
outputs
[]string 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_<interval>_<output>
staleness_interval
string
Staleness interval is interval after which the series state will be reset if no samples have been sent during it.
The parameter is only relevant for outputs: total, total_prometheus, increase, increase_prometheus and histogram_bucket.
without
[]string
Without is an optional list of labels, which must be excluded when grouping input series.
See also By.
If neither By nor Without are set, then the Outputs are calculated
individually per each input time series.
tlsConfig
object
TLSConfig describes tls configuration for remote write target
ca
object
Struct containing the CA cert to use for the targets.
configMap
object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret
object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
caFile
string
Path to the CA cert in the container to use for the targets.
cert
object
Struct containing the client cert file for the targets.
configMap
object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret
object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
certFile
string
Path to the client cert file in the container for the targets.
insecureSkipVerify
boolean
Disable target certificate validation.
keyFile
string
Path to the client key file in the container for the targets.
keySecret
object
Secret containing the client key file for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
serverName
string
Used to verify the hostname for the targets.
url
string required
URL of the endpoint to send samples to.
urlRelabelConfig
object
ConfigMap with relabeling config which is applied to metrics before sending them to the corresponding -remoteWrite.url.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
remoteWriteSettings
object
RemoteWriteSettings defines global settings for all remoteWrite urls.
flushInterval
string
Interval for flushing the data to remote storage. (default 1s)
pattern: [0-9]+(ms|s|m|h)
label
object
Labels in the form 'name=value' to add to all the metrics before sending them. This overrides the label if it already exists.
maxBlockSize
integer
The maximum size in bytes of unpacked request to send to remote storage
maxDiskUsagePerURL
object
The maximum file-based buffer size in bytes at -remoteWrite.tmpDataPath
queues
integer
The number of concurrent queues
showURL
boolean
Whether to show -remoteWrite.url in the exported metrics. It is hidden by default, since it can contain sensitive auth info
tmpDataPath
string
Path to directory where temporary data for remote write component is stored (default vmagent-remotewrite-data)
useMultiTenantMode
boolean
Configures vmagent accepting data via the same multitenant endpoints as vminsert at VictoriaMetrics cluster does,
see [here](https://docs.victoriametrics.com/victoriametrics/vmagent/#multitenancy).
it's global setting and affects all remote storage configurations
replicaCount
integer
ReplicaCount is the expected size of the Application.
resources
object
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
claims
[]object
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This field depends on the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
name
string required
Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.
request
string
Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.
limits
object
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests
object
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
revisionHistoryLimitCount
integer
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
object
RollingUpdate - overrides deployment update params.
maxSurge
string | integer
The maximum number of pods that can be scheduled above the desired number of
pods.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
This can not be 0 if MaxUnavailable is 0.
Absolute number is calculated from percentage by rounding up.
Defaults to 25%.
Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when
the rolling update starts, such that the total number of old and new pods do not exceed
130% of desired pods. Once old pods have been killed,
new ReplicaSet can be scaled up further, ensuring that total number of pods running
at any time during the update is at most 130% of desired pods.
maxUnavailable
string | integer
The maximum number of pods that can be unavailable during the update.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
Absolute number is calculated from percentage by rounding down.
This can not be 0 if MaxSurge is 0.
Defaults to 25%.
Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods
immediately when the rolling update starts. Once new pods are ready, old ReplicaSet
can be scaled down further, followed by scaling up the new ReplicaSet, ensuring
that the total number of pods available at all times during the update is at
least 70% of desired pods.
runtimeClassName
string
RuntimeClassName - defines runtime class for kubernetes pod.
https://kubernetes.io/docs/concepts/containers/runtime-class/
sampleLimit
integer
SampleLimit defines global per target limit of scraped samples
schedulerName
string
SchedulerName - defines kubernetes scheduler name
scrapeClasses
[]object
ScrapeClasses defines the list of scrape classes to expose to scraping objects such as
PodScrapes, ServiceScrapes, Probes and ScrapeConfigs.
attachMetadata
object
AttachMetadata defines additional metadata to the discovered targets.
When the scrape object defines its own configuration, it takes
precedence over the scrape class configuration.
namespace
boolean
Namespace instructs vmagent or vmsingle to add namespace specific metadata from service discovery
Valid for roles: pod, service, endpoints, endpointslice, ingress.
node
boolean
Node instructs vmagent or vmsingle to add node specific metadata from service discovery
Valid for roles: pod, endpoints, endpointslice.
authorization
object
Authorization with http header Authorization
credentials
object
Reference to the secret with value for authorization
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
credentialsFile
string
File with value for authorization
type
string
Type of authorization, default to bearer
basicAuth
object
BasicAuth allow an endpoint to authenticate over basic authentication
password
object
Password defines reference for secret with password value
The secret needs to be in the same namespace as scrape object
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
password_file
string
PasswordFile defines path to password file at disk
must be pre-mounted
username
object
Username defines reference for secret with username value
The secret needs to be in the same namespace as scrape object
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
bearerTokenFile
string
File to read bearer token for scraping targets.
bearerTokenSecret
object
Secret to mount to read bearer token for scraping targets. The secret
needs to be in the same namespace as the scrape object and accessible by
the victoria-metrics operator.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
default
boolean
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
[]object
MetricRelabelConfigs to apply to samples after scrapping.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
name
string required
name of the scrape class.
oauth2
object
OAuth2 defines auth configuration
client_id
object required
The secret or configmap containing the OAuth2 client id
configMap
object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret
object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
client_secret
object
The secret containing the OAuth2 client secret
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
client_secret_file
string
ClientSecretFile defines path for client secret file.
endpoint_params
object
Parameters to append to the token URL
proxy_url
string
The proxy URL for token_url connection
( available from v0.55.0).
Is only supported by Scrape objects family
scopes
[]string
OAuth2 scopes used for the token request
tls_config
object
TLSConfig for token_url connection
( available from v0.55.0).
Is only supported by Scrape objects family
token_url
string required
The URL to fetch the token from
relabelConfigs
[]object
RelabelConfigs to apply to samples during service discovery.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
tlsConfig
object
TLSConfig configuration to use when scraping the endpoint
ca
object
Struct containing the CA cert to use for the targets.
configMap
object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret
object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
caFile
string
Path to the CA cert in the container to use for the targets.
cert
object
Struct containing the client cert file for the targets.
configMap
object
ConfigMap containing data to use for the targets.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
secret
object
Secret containing data to use for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
certFile
string
Path to the client cert file in the container for the targets.
insecureSkipVerify
boolean
Disable target certificate validation.
keyFile
string
Path to the client key file in the container for the targets.
keySecret
object
Secret containing the client key file for the targets.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
serverName
string
Used to verify the hostname for the targets.
scrapeConfigNamespaceSelector
object
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
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
scrapeConfigRelabelTemplate
[]object
ScrapeConfigRelabelTemplate defines relabel config, that will be added to each VMScrapeConfig.
it's useful for adding specific labels to all targets
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
scrapeConfigSelector
object
ScrapeConfigSelector defines VMScrapeConfig to be selected for target discovery.
Works in combination with NamespaceSelector.
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
scrapeInterval
string
ScrapeInterval defines how often scrape targets by default
pattern: [0-9]+(ms|s|m|h)
scrapeTimeout
string
ScrapeTimeout defines global timeout for targets scrape
pattern: [0-9]+(ms|s|m|h)
secrets
[]string
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
object
SecurityContext holds pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext.
selectAllByDefault
boolean
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
serviceAccountName
string
ServiceAccountName is the name of the ServiceAccount to use to run the pods
serviceScrapeNamespaceSelector
object
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
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
serviceScrapeRelabelTemplate
[]object
ServiceScrapeRelabelTemplate defines relabel config, that will be added to each VMServiceScrape.
it's useful for adding specific labels to all targets
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
serviceScrapeSelector
object
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
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
serviceScrapeSpec
object
ServiceScrapeSpec that will be added to vmagent VMServiceScrape spec
serviceSpec
object
ServiceSpec that will be added to vmagent service spec
metadata
object
EmbeddedObjectMetadata defines objectMeta for additional service.
annotations
object
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
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
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
spec
object required
ServiceSpec describes the attributes that a user creates on a service.
More info: https://kubernetes.io/docs/concepts/services-networking/service/
useAsDefault
boolean
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
shardCount
integer
ShardCount - numbers of shards of VMAgent
in this case operator will use 1 deployment/sts per shard with
replicas count according to spec.replicas,
see [here](https://docs.victoriametrics.com/victoriametrics/vmagent/#scraping-big-number-of-targets)
startupProbe
object
StartupProbe that will be added to CR pod
statefulMode
boolean
StatefulMode enables StatefulSet for `VMAgent` instead of Deployment
it allows using persistent storage for vmagent's persistentQueue
statefulRollingUpdateStrategy
string
StatefulRollingUpdateStrategy allows configuration for strategyType
set it to RollingUpdate for disabling operator statefulSet rollingUpdate
statefulRollingUpdateStrategyBehavior
object
StatefulRollingUpdateStrategyBehavior defines customized behavior for rolling updates.
It applies if the RollingUpdateStrategy is set to OnDelete, which is the default.
maxUnavailable
string | integer
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.
statefulStorage
object
StatefulStorage configures storage for StatefulSet
emptyDir
object
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
medium
string
medium represents what type of storage medium should back this directory.
The default is "" which means to use the node's default medium.
Must be an empty string (default) or Memory.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
sizeLimit
string | integer
sizeLimit is the total amount of local storage required for this EmptyDir volume.
The size limit is also applicable for memory medium.
The maximum usage on memory medium EmptyDir would be the minimum value between
the SizeLimit specified here and the sum of memory limits of all containers in a pod.
The default is nil which means that the limit is undefined.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
volumeClaimTemplate
object
A PVC spec to be used by the StatefulSets/Deployments.
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
annotations
object
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
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
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
spec
object
Spec defines the desired characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
accessModes
[]string
accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSource
object
dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.
apiGroup
string
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
kind
string required
Kind is the type of resource being referenced
name
string required
Name is the name of resource being referenced
dataSourceRef
object
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
apiGroup
string
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
kind
string required
Kind is the type of resource being referenced
name
string required
Name is the name of resource being referenced
namespace
string
Namespace is the namespace of resource being referenced
Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
resources
object
resources represents the minimum resources the volume should have.
Users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
limits
object
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests
object
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
selector
object
selector is a label query over volumes to consider for binding.
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
storageClassName
string
storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeAttributesClassName
string
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string or nil value indicates that no
VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
this field can be reset to its previous value (including nil) to cancel the modification.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/
volumeMode
string
volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
volumeName
string
volumeName is the binding reference to the PersistentVolume backing this claim.
status
object
Status represents the current information/status of a persistent volume claim.
Read-only.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
accessModes
[]string
accessModes contains the actual access modes the volume backing the PVC has.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
allocatedResourceStatuses
object
allocatedResourceStatuses stores status of resource being resized for the given PVC.
Key names follow standard Kubernetes label syntax. Valid values are either:
* Un-prefixed keys:
- storage - the capacity of the volume.
* Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered
reserved and hence may not be used.
ClaimResourceStatus can be in any of following states:
- ControllerResizeInProgress:
State set when resize controller starts resizing the volume in control-plane.
- ControllerResizeFailed:
State set when resize has failed in resize controller with a terminal error.
- NodeResizePending:
State set when resize controller has finished resizing the volume but further resizing of
volume is needed on the node.
- NodeResizeInProgress:
State set when kubelet starts resizing the volume.
- NodeResizeFailed:
State set when resizing has failed in kubelet with a terminal error. Transient errors don't set
NodeResizeFailed.
For example: if expanding a PVC for more capacity - this field can be one of the following states:
- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress"
- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed"
- pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending"
- pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress"
- pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed"
When this field is not set, it means that no resize operation is in progress for the given PVC.
A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus
should ignore the update for the purpose it was designed. For example - a controller that
only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid
resources associated with PVC.
allocatedResources
object
allocatedResources tracks the resources allocated to a PVC including its capacity.
Key names follow standard Kubernetes label syntax. Valid values are either:
* Un-prefixed keys:
- storage - the capacity of the volume.
* Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered
reserved and hence may not be used.
Capacity reported here may be larger than the actual capacity when a volume expansion operation
is requested.
For storage quota, the larger value from allocatedResources and PVC.spec.resources is used.
If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation.
If a volume expansion capacity request is lowered, allocatedResources is only
lowered if there are no expansion operations in progress and if the actual volume capacity
is equal or lower than the requested capacity.
A controller that receives PVC update with previously unknown resourceName
should ignore the update for the purpose it was designed. For example - a controller that
only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid
resources associated with PVC.
capacity
object
capacity represents the actual resources of the underlying volume.
conditions
[]object
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being
resized then the Condition will be set to 'Resizing'.
lastProbeTime
string
lastProbeTime is the time we probed the condition.
lastTransitionTime
string
lastTransitionTime is the time the condition transitioned from one status to another.
message
string
message is the human-readable message indicating details about last transition.
reason
string
reason is a unique, this should be a short, machine understandable string that gives the reason
for condition's last transition. If it reports "Resizing" that means the underlying
persistent volume is being resized.
status
string required
Status is the status of the condition.
Can be True, False, Unknown.
More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required
type
string required
Type is the type of the condition.
More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about
currentVolumeAttributesClassName
string
currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using.
When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim
modifyVolumeStatus
object
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.
When this is unset, there is no ModifyVolume operation being attempted.
status
string required
status is the status of the ControllerModifyVolume operation. It can be in any of following states:
- Pending
Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as
the specified VolumeAttributesClass not existing.
- InProgress
InProgress indicates that the volume is being modified.
- Infeasible
Infeasible indicates that the request has been rejected as invalid by the CSI driver. To
resolve the error, a valid VolumeAttributesClass needs to be specified.
Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
targetVolumeAttributesClassName
string
targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
phase
string
phase represents the current phase of PersistentVolumeClaim.
staticScrapeNamespaceSelector
object
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
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
staticScrapeRelabelTemplate
[]object
StaticScrapeRelabelTemplate defines relabel config, that will be added to each VMStaticScrape.
it's useful for adding specific labels to all targets
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
staticScrapeSelector
object
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.
matchExpressions
[]object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
streamAggrConfig
object
StreamAggrConfig defines global stream aggregation configuration for VMAgent
configmap
object
ConfigMap with stream aggregation rules
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
dedupInterval
string
Allows setting different de-duplication intervals per each configured remote storage
dropInput
boolean
Allow drop all the input samples after the aggregation
dropInputLabels
[]string
labels to drop from samples for aggregator before stream de-duplication and aggregation
enableWindows
boolean
EnableWindows enables aggregating data in separate windows ( available from v0.54.0).
ignoreFirstIntervals
integer
IgnoreFirstIntervals instructs to ignore first interval
ignoreFirstSampleInterval
string
IgnoreFirstSampleInterval sets interval for total and prometheus_total during which first samples will be ignored
ignoreOldSamples
boolean
IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval.
keepInput
boolean
Allows writing both raw and aggregate data
rules
[]object
Stream aggregation rules
by
[]string
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
DedupInterval is an optional interval for deduplication.
drop_input_labels
[]string
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
EnableWindows enables aggregating data in separate windows
flush_on_shutdown
boolean
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
IgnoreFirstSampleInterval sets interval for total and prometheus_total during which first samples will be ignored
ignore_first_intervals
integer
ignore_old_samples
boolean
IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval.
input_relabel_configs
[]object
InputRelabelConfigs is an optional relabeling rules, which are applied on the input
before aggregation.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
interval
string required
Interval is the interval between aggregations.
keep_metric_names
boolean
KeepMetricNames instructs to leave metric names as is for the output time series without adding any suffix.
match
object
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
NoAlignFlushToInterval disables aligning of flushes to multiples of Interval.
By default flushes are aligned to Interval.
output_relabel_configs
[]object
OutputRelabelConfigs is an optional relabeling rules, which are applied
on the aggregated output before being sent to remote storage.
action
string
Action to perform based on regex matching. Default is 'replace'
if
object
If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}'
labels
object
Labels is used together with Match for `action: graphite`
match
string
Match is used together with Labels for `action: graphite`
modulus
integer
Modulus to take of the hash of the source label values.
regex
object
Regular expression against which the extracted value is matched. Default is '(.*)'
victoriaMetrics supports multiline regex joined with |
https://docs.victoriametrics.com/victoriametrics/vmagent/#relabeling-enhancements
replacement
string
Replacement value against which a regex replace is performed if the
regular expression matches. Regex capture groups are available. Default is '$1'
separator
string
Separator placed between concatenated source label values. default is ';'.
sourceLabels
[]string
The source labels select values from existing labels. Their content is concatenated
using the configured separator and matched against the configured regular expression
for the replace, keep, and drop actions.
source_labels
[]string
UnderScoreSourceLabels - additional form of source labels source_labels
for compatibility with original relabel config.
if set both sourceLabels and source_labels, sourceLabels has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
targetLabel
string
Label to which the resulting value is written in a replace action.
It is mandatory for replace actions. Regex capture groups are available.
target_label
string
UnderScoreTargetLabel - additional form of target label - target_label
for compatibility with original relabel config.
if set both targetLabel and target_label, targetLabel has priority.
for details https://github.com/VictoriaMetrics/operator/issues/131
outputs
[]string 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_<interval>_<output>
staleness_interval
string
Staleness interval is interval after which the series state will be reset if no samples have been sent during it.
The parameter is only relevant for outputs: total, total_prometheus, increase, increase_prometheus and histogram_bucket.
without
[]string
Without is an optional list of labels, which must be excluded when grouping input series.
See also By.
If neither By nor Without are set, then the Outputs are calculated
individually per each input time series.
terminationGracePeriodSeconds
integer
TerminationGracePeriodSeconds period for container graceful termination
tolerations
[]object
Tolerations If specified, the pod's tolerations.
effect
string
Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key
string
Key is the taint key that the toleration applies to. Empty means match all taint keys.
If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator
string
Operator represents a key's relationship to the value.
Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal.
Exists is equivalent to wildcard for value, so that a pod can
tolerate all taints of a particular category.
Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).
tolerationSeconds
integer
TolerationSeconds represents the period of time the toleration (which must be
of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
it is not set, which means tolerate the taint forever (do not evict). Zero and
negative values will be treated as 0 (evict immediately) by the system.
value
string
Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.
topologySpreadConstraints
[]object
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
string
UpdateStrategy - overrides default update strategy.
works only for deployments, statefulset always use OnDelete.
enum: Recreate, RollingUpdate
useDefaultResources
boolean
UseDefaultResources controls resource settings
By default, operator sets built-in resource requirements
useStrictSecurity
boolean
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
useVMConfigReloader
boolean
UseVMConfigReloader replaces prometheus-like config-reloader
with vm one. It uses secrets watch instead of file watch
which greatly increases speed of config updates
Removed since v0.67.0: this property is ignored and no longer needed
vmAgentExternalLabelName
string
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 (`""`).
volumeMounts
[]object
VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the Application container
mountPath
string required
Path within the container at which the volume should be mounted. Must
not contain ':'.
mountPropagation
string
mountPropagation determines how mounts are propagated from the host
to container and the other way around.
When not set, MountPropagationNone is used.
This field is beta in 1.10.
When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
(which defaults to None).
name
string required
This must match the Name of a Volume.
readOnly
boolean
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
recursiveReadOnly
string
RecursiveReadOnly specifies whether read-only mounts should be handled
recursively.
If ReadOnly is false, this field has no meaning and must be unspecified.
If ReadOnly is true, and this field is set to Disabled, the mount is not made
recursively read-only. If this field is set to IfPossible, the mount is made
recursively read-only, if it is supported by the container runtime. If this
field is set to Enabled, the mount is made recursively read-only if it is
supported by the container runtime, otherwise the pod will not be started and
an error will be generated to indicate the reason.
If this field is set to IfPossible or Enabled, MountPropagation must be set to
None (or be unspecified, which defaults to None).
If this field is not specified, it is treated as an equivalent of Disabled.
subPath
string
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
subPathExpr
string
Expanded path within the volume from which the container's volume should be mounted.
Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
Defaults to "" (volume's root).
SubPathExpr and SubPath are mutually exclusive.
volumes
[]object
Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition.
Volumes specified will be appended to other volumes that are generated.
/ +optional