VMAlert v1beta1 — operator.victoriametrics.com

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object

VMAlertSpec defines the desired state of VMAlert

affinity object

Affinity If specified, the pod's scheduling constraints.

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.

datasource object required

Datasource Victoria Metrics or VMSelect url. Required parameter. e.g. http://127.0.0.1:8428

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

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

optional boolean

Specify whether the Secret or its key must be defined

bearerTokenFile string

Path to bearer token file

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

optional boolean

Specify whether the Secret or its key must be defined

headers []string

Headers allow configuring custom http headers Must be in form of semicolon separated header with value e.g. headerName:headerValue vmalert supports it since 1.79.0 version

oauth2 object

OAuth2 defines OAuth2 configuration

tlsConfig object

TLSConfig specifies TLSConfig configuration parameters.

url string required

Victoria Metrics or VMSelect url. Required parameter. E.g. http://127.0.0.1:8428

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

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.

evaluationInterval string

EvaluationInterval defines how often to evaluate rules by default

pattern: [0-9]+(ms|s|m|h)

externalLabels object

ExternalLabels in the form 'name: value' to add to all generated recording rules and alerts.

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

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

optional boolean

Specify whether the Secret must be defined

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.

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

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/

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

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 VMAlert to be configured with. default or json

enum: default, json

logLevel string

LogLevel for VMAlert to be configured with.

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

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

format: int32

nodeSelector object

NodeSelector Define which Nodes the Pods are scheduled on.

notifier object

Notifier prometheus alertmanager endpoint spec. Required at least one of notifier or notifiers when there are alerting rules. e.g. http://127.0.0.1:9093 If specified both notifier and notifiers, notifier will be added as last element to notifiers. only one of notifier options could be chosen: notifierConfigRef or notifiers + notifier

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

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

optional boolean

Specify whether the Secret or its key must be defined

bearerTokenFile string

Path to bearer token file

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

optional boolean

Specify whether the Secret or its key must be defined

headers []string

Headers allow configuring custom http headers Must be in form of semicolon separated header with value e.g. headerName:headerValue vmalert supports it since 1.79.0 version

oauth2 object

OAuth2 defines OAuth2 configuration

selector object

Selector allows service discovery for alertmanager in this case all matched vmalertmanager replicas will be added into vmalert notifier.url as statefulset pod.fqdn

labelSelector object

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

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.

namespaceSelector object

NamespaceSelector is a selector for selecting either all namespaces or a list of namespaces.

any boolean

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

matchNames []string

List of namespace names.

tlsConfig object

TLSConfig specifies TLSConfig configuration parameters.

url string

AlertManager url. E.g. http://127.0.0.1:9093

notifierConfigRef object

NotifierConfigRef reference for secret with notifier configuration for vmalert only one of notifier options could be chosen: notifierConfigRef or notifiers + notifier

key string required

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

name string

optional boolean

Specify whether the Secret or its key must be defined

notifiers []object

Notifiers prometheus alertmanager endpoints. Required at least one of notifier or notifiers when there are alerting rules. e.g. http://127.0.0.1:9093 If specified both notifier and notifiers, notifier will be added as last element to notifiers. only one of notifier options could be chosen: notifierConfigRef or notifiers + notifier

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

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

optional boolean

Specify whether the Secret or its key must be defined

bearerTokenFile string

Path to bearer token file

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

optional boolean

Specify whether the Secret or its key must be defined

headers []string

Headers allow configuring custom http headers Must be in form of semicolon separated header with value e.g. headerName:headerValue vmalert supports it since 1.79.0 version

oauth2 object

OAuth2 defines OAuth2 configuration

selector object

Selector allows service discovery for alertmanager in this case all matched vmalertmanager replicas will be added into vmalert notifier.url as statefulset pod.fqdn

labelSelector object

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

matchLabels object

namespaceSelector object

NamespaceSelector is a selector for selecting either all namespaces or a list of namespaces.

any boolean

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

matchNames []string

List of namespace names.

tlsConfig object

TLSConfig specifies TLSConfig configuration parameters.

url string

AlertManager url. E.g. http://127.0.0.1:9093

paused boolean

Paused If set to true all actions on the underlying managed objects are not going to be performed, except for delete actions.

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 VMAlert pods.

annotations object

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

port string

Port listen address

priorityClassName string

PriorityClassName class assigned to the Pods

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

remoteRead object

RemoteRead Optional URL to read vmalert state (persisted via RemoteWrite) This configuration only makes sense if alerts state has been successfully persisted (via RemoteWrite) before. see -remoteRead.url docs in vmalerts for details. E.g. http://127.0.0.1:8428

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

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

optional boolean

Specify whether the Secret or its key must be defined

bearerTokenFile string

Path to bearer token file

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

optional boolean

Specify whether the Secret or its key must be defined

headers []string

Headers allow configuring custom http headers Must be in form of semicolon separated header with value e.g. headerName:headerValue vmalert supports it since 1.79.0 version

lookback string

Lookback defines how far to look into past for alerts timeseries. For example, if lookback=1h then range from now() to now()-1h will be scanned. (default 1h0m0s) Applied only to RemoteReadSpec

oauth2 object

OAuth2 defines OAuth2 configuration

tlsConfig object

TLSConfig specifies TLSConfig configuration parameters.

url string required

URL of the endpoint to send samples to.

remoteWrite object

RemoteWrite Optional URL to remote-write compatible storage to persist vmalert state and rule results to. Rule results will be persisted according to each rule. Alerts state will be persisted in the form of time series named ALERTS and ALERTS_FOR_STATE see -remoteWrite.url docs in vmalerts for details. E.g. http://127.0.0.1:8428

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

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

optional boolean

Specify whether the Secret or its key must be defined

bearerTokenFile string

Path to bearer token file

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

optional boolean

Specify whether the Secret or its key must be defined

concurrency integer

Defines number of readers that concurrently write into remote storage (default 1)

format: int32

flushInterval string

Defines interval of flushes to remote write endpoint (default 5s)

pattern: [0-9]+(ms|s|m|h)

headers []string

Headers allow configuring custom http headers Must be in form of semicolon separated header with value e.g. headerName:headerValue vmalert supports it since 1.79.0 version

maxBatchSize integer

Defines defines max number of timeseries to be flushed at once (default 1000)

format: int32

maxQueueSize integer

Defines the max number of pending datapoints to remote write endpoint (default 100000)

format: int32

oauth2 object

OAuth2 defines OAuth2 configuration

tlsConfig object

TLSConfig specifies TLSConfig configuration parameters.

url string required

URL of the endpoint to send samples to.

replicaCount integer

ReplicaCount is the expected size of the Application.

format: int32

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

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

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.

format: int32

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.

ruleNamespaceSelector object

RuleNamespaceSelector to be selected for VMRules discovery. Works in combination with Selector. If both nil - behaviour controlled by selectAllByDefault NamespaceSelector nil - only objects at VMAlert namespace.

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

matchLabels object

rulePath []string

RulePath to the file with alert rules. Supports patterns. Flag can be specified multiple times. Examples: -rule /path/to/file. Path to a single file with alerting rules -rule dir/*.yaml -rule /*.yaml. Relative path to all .yaml files in folder, absolute path to all .yaml files in root. by default operator adds /etc/vmalert/configs/base/vmalert.yaml

ruleSelector object

RuleSelector selector to select which VMRules to mount for loading alerting rules from. Works in combination with NamespaceSelector. If both nil - behaviour controlled by selectAllByDefault NamespaceSelector nil - only objects at VMAlert namespace.

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

matchLabels object

runtimeClassName string

RuntimeClassName - defines runtime class for kubernetes pod. https://kubernetes.io/docs/concepts/containers/runtime-class/

schedulerName string

SchedulerName - defines kubernetes scheduler name

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 RuleSelector. with selectAllByDefault: true and empty serviceScrapeSelector and RuleNamespaceSelector 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

serviceScrapeSpec object

ServiceScrapeSpec that will be added to vmalert VMServiceScrape spec

serviceSpec object

ServiceSpec that will be added to vmalert service spec

metadata object

EmbeddedObjectMetadata defines objectMeta for additional service.

annotations object

labels object

name string

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

startupProbe object

StartupProbe that will be added to CR pod

terminationGracePeriodSeconds integer

TerminationGracePeriodSeconds period for container graceful termination

format: int64

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.

format: int64

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.

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

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

status object

VMAlertStatus defines the observed state of VMAlert

conditions []object

Known .status.conditions.type are: "Available", "Progressing", and "Degraded"

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another.

format: date-time

lastUpdateTime string required

LastUpdateTime is the last time of given type update. This value is used for status TTL update and removal

format: date-time

message string

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

format: int64

minimum: 0

reason string required

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

Type of condition in CamelCase or in name.namespace.resource.victoriametrics.com/CamelCase.

maxLength: 316

lastAppliedSpec object

observedGeneration integer

ObservedGeneration defines current generation picked by operator for the reconcile

format: int64

reason string

Reason defines human readable error reason

updateStatus string

UpdateStatus defines a status for update rollout