helm-charts
Victoria Metrics Helm Chart for vmanomaly
Victoria Metrics Anomaly Detection - a service that continuously scans Victoria Metrics time series and detects unexpected changes within data patterns in real-time.
Prerequisites
-
Install the follow packages:
git,kubectl,helm,helm-docs. See this tutorial. -
PV support on underlying infrastructure
Chart Details
This chart will do the following:
- Rollout victoria metrics anomaly
How to install
Access a Kubernetes cluster.
Add a chart helm repository with follow commands:
helm repo add vm https://victoriametrics.github.io/helm-charts/
helm repo update
List versions of vm/victoria-metrics-anomaly chart available to installation:
helm search repo vm/victoria-metrics-anomaly -l
Export default values of victoria-metrics-anomaly chart to file values.yaml:
helm show values vm/victoria-metrics-anomaly > values.yaml
Change the values according to the need of the environment in values.yaml file.
Test the installation with command:
helm install vmanomaly vm/victoria-metrics-anomaly -f values.yaml -n NAMESPACE --debug --dry-run
Install chart with command:
helm install vmanomaly vm/victoria-metrics-anomaly -f values.yaml -n NAMESPACE
Get the pods lists by running this commands:
kubectl get pods -A | grep 'vmanomaly'
Get the application by running this command:
helm list -f vmanomaly -n NAMESPACE
See the history of versions of vmanomaly application with command.
helm history vmanomaly -n NAMESPACE
How to uninstall
Remove application with command.
helm uninstall vmanomaly -n NAMESPACE
Documentation of Helm Chart
Install helm-docs following the instructions on this tutorial.
Generate docs with helm-docs command.
cd charts/victoria-metrics-anomaly
helm-docs
The markdown generation is entirely go template driven. The tool parses metadata from charts and generates a number of sub-templates that can be referenced in a template file (by default README.md.gotmpl). If no template file is provided, the tool has a default internal template that will generate a reasonably formatted README.
Parameters
The following tables lists the configurable parameters of the chart and their default values.
For more vmanomaly config parameters see https://docs.victoriametrics.com/anomaly-detection/components
Change the values according to the need of the environment in victoria-metrics-anomaly/values.yaml file.
| Key | Type | Default | Description |
|---|---|---|---|
| affinity | object | {} |
Affinity configurations |
| annotations | object | {} |
Annotations to be added to the deployment |
| config | object | {"models":{"prophet_model":{"args":{},"class":"model.prophet.ProphetModel"}},"preset":"","reader":{"class":"reader.vm.VmReader","datasource_url":"","queries":{},"sampling_period":"1m","tenant_id":""},"schedulers":{"scheduler_periodic_1m":{"class":"scheduler.periodic.PeriodicScheduler","fit_every":"2h","fit_window":"14d","infer_every":"1m"}},"writer":{"class":"writer.vm.VmWriter","datasource_url":"","tenant_id":""}} |
Full vmanomaly config section |
| config.models | object | {"prophet_model":{"args":{},"class":"model.prophet.ProphetModel"}} |
Models section |
| config.models.prophet_model | object | {"args":{},"class":"model.prophet.ProphetModel"} |
Model alias |
| config.models.prophet_model.args | object | {} |
Arguments specific to model |
| config.models.prophet_model.class | string | "model.prophet.ProphetModel" |
Supported model classs by vmanomaly |
| config.preset | string | "" |
Whether to use preset configuration. If not empty, preset name should be specified. |
| config.reader | object | {"class":"reader.vm.VmReader","datasource_url":"","queries":{},"sampling_period":"1m","tenant_id":""} |
Reader section |
| config.reader.class | string | "reader.vm.VmReader" |
Name of the class needed to enable reading from VictoriaMetrics or Prometheus. VmReader is the default option, if not specified. |
| config.reader.datasource_url | string | "" |
Datasource URL address. Required for example “http://single-victoria-metrics-single-server.default.svc.cluster.local:8428” or “http://cluster-victoria-metrics-cluster-vminsert.default.svc.cluster.local:8480/insert/” |
| config.reader.queries | object | {} |
Required. PromQL/MetricsQL query to select data in format: QUERY_ALIAS: “QUERY”. As accepted by “/query_range?query=%s”. |
| config.reader.sampling_period | string | "1m" |
Frequency of the points returned. Will be converted to “/query_range?step=%s” param (in seconds). Required since 1.9.0. |
| config.reader.tenant_id | string | "" |
For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs |
| config.schedulers | object | {"scheduler_periodic_1m":{"class":"scheduler.periodic.PeriodicScheduler","fit_every":"2h","fit_window":"14d","infer_every":"1m"}} |
Scheduler section |
| config.schedulers.scheduler_periodic_1m.class | string | "scheduler.periodic.PeriodicScheduler" |
Scheduler class |
| config.schedulers.scheduler_periodic_1m.fit_every | string | "2h" |
How often to completely retrain the models. If missing value of infer_every is used and retrain on every inference run. |
| config.schedulers.scheduler_periodic_1m.fit_window | string | "14d" |
What time range to use for training the models. Must be at least 1 second. |
| config.schedulers.scheduler_periodic_1m.infer_every | string | "1m" |
How often a model will write its conclusions on newly added data. Must be at least 1 second. |
| config.writer | object | {"class":"writer.vm.VmWriter","datasource_url":"","tenant_id":""} |
Writer section |
| config.writer.class | string | "writer.vm.VmWriter" |
Name of the class needed to enable writing to VictoriaMetrics or Prometheus. VmWriter is the default option, if not specified. |
| config.writer.datasource_url | string | "" |
Datasource URL address. Required for example “http://single-victoria-metrics-single-server.default.svc.cluster.local:8428” or “http://cluster-victoria-metrics-cluster-vminsert.default.svc.cluster.local:8480/insert/” |
| config.writer.tenant_id | string | "" |
For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs |
| containerWorkingDir | string | "/vmanomaly" |
|
| env | list | [] |
Additional environment variables (ex.: secret tokens, flags) |
| envFrom | list | [] |
|
| eula | bool | false |
should be true and means that you have the legal right to run a vmanomaly that can either be a signed contract or an email with confirmation to run the service in a trial period https://victoriametrics.com/legal/esa/ |
| extraArgs.loggerFormat | string | "json" |
|
| extraContainers | list | [] |
|
| extraHostPathMounts | list | [] |
Additional hostPath mounts |
| extraVolumeMounts | list | [] |
Extra Volume Mounts for the container |
| extraVolumes | list | [] |
Extra Volumes for the pod |
| fullnameOverride | string | "" |
|
| image.pullPolicy | string | "IfNotPresent" |
Pull policy of Docker image |
| image.repository | string | "docker.io/victoriametrics/vmanomaly" |
Victoria Metrics anomaly Docker repository and image name |
| image.tag | string | "" |
Tag of Docker image |
| imagePullSecrets | list | [] |
|
| license | object | {"key":"","secret":{"key":"","name":""}} |
License key configuration for vmanomaly. See docs Required starting from v1.5.0. |
| license.key | string | "" |
License key for vmanomaly |
| license.secret | object | {"key":"","name":""} |
Use existing secret with license key for vmanomaly |
| license.secret.key | string | "" |
Key in secret with license key |
| license.secret.name | string | "" |
Existing secret name |
| nameOverride | string | "" |
|
| nodeSelector | object | {} |
NodeSelector configurations. Ref: https://kubernetes.io/docs/user-guide/node-selection/ |
| podAnnotations | object | {} |
Annotations to be added to pod |
| podDisruptionBudget | object | {"enabled":false,"labels":{}} |
See kubectl explain poddisruptionbudget.spec for more. Ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb/ |
| podSecurityContext | object | {} |
|
| resources | object | {} |
|
| securityContext.runAsGroup | int | 1000 |
|
| securityContext.runAsNonRoot | bool | true |
|
| securityContext.runAsUser | int | 1000 |
|
| serviceAccount.annotations | object | {} |
|
| serviceAccount.create | bool | true |
|
| serviceAccount.name | string | nil |
|
| serviceMonitor.annotations | object | {} |
|
| serviceMonitor.enabled | bool | false |
|
| serviceMonitor.extraLabels | object | {} |
|
| tolerations | list | [] |
Tolerations configurations. Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |