VictoriaMetrics Distributed #

A Helm chart for Running VMCluster on Multiple Availability Zones

Prerequisites #

Before installing this chart, ensure your environment meets the following requirements:

Kubernetes cluster - A running Kubernetes cluster with sufficient resources
Helm - Helm package manager installed and configured

Additional requirements depend on your configuration:

Persistent storage - Required if you enable persistent volumes for data retention (enabled by default)
kubectl - Needed for cluster management and troubleshooting

For installation instructions, refer to the official documentation:

Installing Helm
Installing kubectl
Multiple availability zones.

Chart Details #

This chart sets up multiple VictoriaMetrics instances(cluster or single node version, using cluster by default) on multiple availability zones , provides both global write and read entrypoints.

The default setup is as shown below:

For write:

extra-vmagent(optional): scrapes external targets and all the components installed by this chart, sends data to global write entrypoint.
vmauth-global-write: global write entrypoint, proxies requests to one of the zone vmagent with least_loaded policy.
vmagent(per-zone): remote writes data to availability zones that enabled .Values.availabilityZones[*].write.allow, and buffer data on disk when zone is unavailable to ingest.
vmauth-write-balancer(per-zone): proxies requests to vminsert instances inside it’s zone with least_loaded policy.
vmcluster(per-zone): processes write requests and stores data.

For read:

vmcluster(per-zone): processes query requests and returns results.
vmauth-read-balancer(per-zone): proxies requests to vmselect instances inside it’s zone with least_loaded policy.
vmauth-read-proxy(per-zone): uses all the vmauth-read-balancer as servers if zone has .Values.availabilityZones[*].read.allow enabled, always prefer “local” vmauth-read-balancer to reduce cross-zone traffic with first_available policy.
vmauth-global-read: global query entrypoint, proxies requests to one of the zone vmauth-read-proxy with first_available policy.
grafana(optional): uses vmauth-global-read as default datasource.

Note

Note: As the topology shown above, this chart doesn’t include components like vmalert, alertmanager, etc by default. You can install them using dependency victoria-metrics-k8s-stack or having separate release.

Why use `victoria-metrics-distributed` chart? #

One of the best practice of running production kubernetes cluster is running with multiple availability zones . And apart from kubernetes control plane components, we also want to spread our application pods on multiple zones, to continue serving even if zone outage happens.

VictoriaMetrics supports data replication natively which can guarantees data availability when part of the vmstorage instances failed. But it doesn’t works well if vmstorage instances are spread on multiple availability zones, since data replication could be stored on single availability zone, which will be lost when zone outage happens. To avoid this, vmcluster must be installed on multiple availability zones, each containing a 100% copy of data. As long as one zone is available, both global write and read entrypoints should work without interruption.

How to write data? #

The chart provides vmauth-global-write as global write entrypoint, it supports push-based data ingestion protocols as VictoriaMetrics does. Optionally, you can push data to any of the per-zone vmagents, and they will replicate the received data across zones.

How to query data? #

The chart provides vmauth-global-read as global read entrypoint, it picks the first available zone (see first_available policy) as it’s preferred datasource and switches automatically to next zone if first one is unavailable, check vmauth first_available for more details. If you have services like vmalert or Grafana deployed in each zone, then configure them to use local vmauth-read-proxy. Per-zone vmauth-read-proxy always prefers “local” vmcluster for querying and reduces cross-zone traffic.

You can also pick other proxies like kubernetes service which supports Topology Aware Routing as global read entrypoint.

What happens if zone outage happen? #

If availability zone zone-eu-1 is experiencing an outage, vmauth-global-write and vmauth-global-read will work without interruption:

vmauth-global-write stops proxying write requests to zone-eu-1 automatically;
vmauth-global-read and vmauth-read-proxy stops proxying read requests to zone-eu-1 automatically;
vmagent on zone-us-1 fails to send data to zone-eu-1.vmauth-write-balancer, starts to buffer data on disk(unless -remoteWrite.disableOnDiskQueue is specified, which is not recommended for this topology); To keep data completeness for all the availability zones, make sure you have enough disk space on vmagent for buffer, see this doc for size recommendation.

And to avoid getting incomplete responses from zone-eu-1 which gets recovered from outage, check vmagent on zone-us-1 to see if persistent queue has been drained. If not, remove zone-eu-1 from serving query by setting .Values.availabilityZones.{zone-eu-1}.read.allow=false and change it back after confirm all data are restored.

How to use multitenancy? #

By default with multitenancy , all the data that written to vmauth-global-write belong to tenant 0. To write data to different tenants, set .Values.enableMultitenancy=true and create new tenant users for vmauth-global-write. For example, writing data to tenant 1088 with following steps:

create tenant VMUser for vmauth vmauth-global-write to use:

      apiVersion: operator.victoriametrics.com/v1beta1
kind: VMUser
metadata:
  name: tenant-1088-rw
  labels:
    tenant-test: "true"
spec:
  targetRefs:
  - static:
      ## list all the zone vmagent here
      url: "http://vmagent-vmagent-zone-eu-1:8429"
      url: "http://vmagent-vmagent-zone-us-1:8429"
    paths:
    - "/api/v1/write"
    - "/prometheus/api/v1/write"
    - "/write"
    - "/api/v1/import"
    - "/api/v1/import/.+"
    target_path_suffix: /insert/1088/
  username: tenant-1088
  password: secret
    

Add extra VMUser selector in vmauth vmauth-global-write

      spec:
  userSelector:
    matchLabels:
      tenant-test: "true"
    

send data to vmauth-global-write using above token. Example command using vmagent:

      /path/to/vmagent -remoteWrite.url=http://vmauth-vmauth-global-write-$ReleaseName-vm-distributed:8427/prometheus/api/v1/write -remoteWrite.basicAuth.username=tenant-1088 -remoteWrite.basicAuth.password=secret
    

How to install #

Access a Kubernetes cluster.

Setup chart repository (can be omitted for OCI repositories) #

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-distributed chart available to installation:

      helm search repo vm/victoria-metrics-distributed -l

Install `victoria-metrics-distributed` chart #

Export default values of victoria-metrics-distributed chart to file values.yaml:

For HTTPS repository

      helm show values vm/victoria-metrics-distributed > values.yaml

For OCI repository

      helm show values oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-distributed > values.yaml

Change the values according to the need of the environment in values.yaml file.

Note

Consider setting .Values.nameOverride to a small value like vmd to avoid hitting resource name limits of 63 characters

Test the installation with command:

For HTTPS repository

      helm install vmd vm/victoria-metrics-distributed -f values.yaml -n NAMESPACE --debug

For OCI repository

      helm install vmd oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-distributed -f values.yaml -n NAMESPACE --debug

Install chart with command:

For HTTPS repository

      helm install vmd vm/victoria-metrics-distributed -f values.yaml -n NAMESPACE

For OCI repository

      helm install vmd oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-distributed -f values.yaml -n NAMESPACE

Get the pods lists by running this commands:

      kubectl get pods -A | grep 'vmd'

Get the application by running this command:

      helm list -f vmd -n NAMESPACE

See the history of versions of vmd application with command.

      helm history vmd -n NAMESPACE

How to upgrade #

In order to serving query and ingestion while upgrading components version or changing configurations, it’s recommended to perform maintenance on availability zone one by one. First, performing update on availability zone zone-eu-1:

remove zone-eu-1 from serving query by setting .Values.availabilityZones.{zone-eu-1}.read.allow=false;
run helm upgrade vm-dis -n NAMESPACE with updated configurations for zone-eu-1 in values.yaml;
wait for all the components on zone zone-eu-1 running;
wait zone-us-1 vmagent persistent queue for zone-eu-1 been drained, add zone-eu-1 back to serving query by setting .Values.availabilityZones.{zone-eu-1}.read.allow=true.

Then, perform update on availability zone zone-us-1 with the same steps1~4.

Upgrade to 0.13.0 #

Introduction of VMCluster’s requestsLoadBalancer allowed to simplify distributed chart setup by removing VMAuth CRs for read and write load balancing. Some parameters are not needed anymore:

removed availabilityZones[*].write.vmauth
removed availabilityZones[*].read.perZone.vmauth
removed zoneTpl.write.vmauth
removed zoneTpl.read.perZone.vmauth
moved zoneTpl.read.crossZone.vmauth to zoneTpl.read.vmauth
moved availabilityZones[*].read.perZone.vmauth to availabilityZones[*].read.vmauth

Upgrade to 0.5.0 #

This release was refactored, names of the parameters was changed:

vmauthIngestGlobal was changed to write.global.vmauth
vmauthQueryGlobal was changed to read.global.vmauth
availabilityZones[*].allowIngest was changed to availabilityZones[*].write.allow
availabilityZones[*].allowRead was changed to availabilityZones[*].read.allow
availabilityZones[*].nodeSelector was moved to availabilityZones[*].common.spec.nodeSelector
availabilityZones[*].extraAffinity was moved to availabilityZones[*].common.spec.affinity
availabilityZones[*].topologySpreadConstraints was moved to availabilityZones[*].common.spec.topologySpreadConstraints
availabilityZones[*].vmauthIngest was moved to availabilityZones[*].write.vmauth
availabilityZones[*].vmauthQueryPerZone was moved to availabilityZones[*].read.perZone.vmauth
availabilityZones[*].vmauthCrossAZQuery was moved to availabilityZones[*].read.crossZone.vmauth

Example:

If before an upgrade you had given below configuration

      vmauthIngestGlobal:
  spec:
    extraArgs:
      discoverBackendIPs: "true"
vmauthQueryGlobal:
  spec:
    extraArgs:
      discoverBackendIPs: "true"
availabilityZones:
  - name: zone-eu-1
    vmauthIngest:
      spec:
        extraArgs:
          discoverBackendIPs: "true"
    vmcluster:
      spec:
        retentionPeriod: "14"
    

after upgrade it will look like this:

      write:
  global:
    vmauth:
      spec:
        extraArgs:
          discoverBackendIPs: "true"
read:
  global:
    vmauth:
      spec:
        extraArgs:
          discoverBackendIPs: "true"
availabilityZones:
  - name: zone-eu-1
    write:
      vmauth:
        spec:
          extraArgs:
            discoverBackendIPs: "true"
    vmcluster:
      spec:
        retentionPeriod: "14"
    

How to uninstall #

Remove application with command.

      helm uninstall vmd -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-distributed

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.

Change the values according to the need of the environment in victoria-metrics-distributed`/values.yaml file.

Key	Description
`availabilityZones: - name: zone-eu-1 - name: zone-us-1`	`(list)` Config for all availability zones. Each element represents custom zone config, which overrides a default one from `zoneTpl`
`availabilityZones[0].name: zone-eu-1`	`(string)` Availability zone name
`availabilityZones[1].name: zone-us-1`	`(string)` Availability zone name
`common.vmagent.spec: port: "8429"`	`(object)` Common VMAgent spec, which can be overridden by each VMAgent configuration. Available parameters can be found here
`common.vmauth.spec.port: "8427"`	`(string)`
`common.vmcluster.spec: requestsLoadBalancer: enabled: true spec: replicaCount: 2 vminsert: port: "8480" vmselect: port: "8481"`	`(object)` Common VMCluster spec, which can be overridden by each VMCluster configuration. Available parameters can be found here
`common.vmsingle.spec: port: "8428"`	`(object)` Common VMSingle spec, which can be overridden by each VMSingle configuration. Available parameters can be found here
`enableMultitenancy: false`	`(bool)` Enable multitenancy mode see here
`extra: vmagent: enabled: false name: test-vmagent spec: selectAllByDefault: true`	`(object)` Set up an extra vmagent to scrape all the scrape objects by default, and write data to above write-global endpoint.
`fullnameOverride: ""`	`(string)` Overrides the chart’s computed fullname.
`global: cluster: dnsDomain: cluster.local.`	`(object)` Global chart properties
`global.cluster.dnsDomain: cluster.local.`	`(string)` K8s cluster domain suffix, uses for building storage pods’ FQDN. Details are here
`nameOverride: vm-distributed`	`(string)` Overrides the chart’s name
`read.global.vmauth.enabled: true`	`(bool)` Create vmauth as the global read entrypoint
`read.global.vmauth.name: vmauth-global-read-{{ .fullname }}`	`(string)` Override the name of the vmauth object
`read.global.vmauth.spec: unauthorizedUserAccessSpec: url_map: - load_balancing_policy: first_available retry_status_codes: - 500 - 502 - 503`	`(object)` Spec for VMAuth CRD, see here
`victoria-metrics-k8s-stack: alertmanager: enabled: false enabled: true grafana: enabled: true victoria-metrics-operator: enabled: true vmagent: enabled: false vmalert: enabled: false vmcluster: enabled: false vmsingle: enabled: false`	`(object)` Set up vm operator and other resources like vmalert, grafana if needed
`write.global.vmauth.enabled: true`	`(bool)` Create a vmauth as the global write entrypoint
`write.global.vmauth.name: vmauth-global-write-{{ .fullname }}`	`(string)` Override the name of the vmauth object
`write.global.vmauth.spec: {}`	`(object)` Spec for VMAuth CRD, see here
zoneTpl: common: spec: affinity: {} nodeSelector: {} topologySpreadConstraints: - maxSkew: 1 topologyKey: kubernetes.io/hostname whenUnsatisfiable: ScheduleAnyway read: allow: true vmauth: enabled: true name: vmauth-read-proxy-{{ (.zone).name }} spec: unauthorizedUserAccessSpec: url_map: - load_balancing_policy: first_available retry_status_codes: - 500 - 502 - 503 vmagent: annotations: {} enabled: true name: vmagent-{{ (.zone).name }} spec: {} vmcluster: enabled: true name: vmcluster-{{ (.zone).name }} spec: replicationFactor: 2 retentionPeriod: "14" vminsert: extraArgs: {} replicaCount: 2 resources: {} vmselect: extraArgs: {} replicaCount: 2 resources: {} vmstorage: replicaCount: 2 resources: {} storageDataPath: /vm-data vmsingle: enabled: false name: '{{ (.zone).name }}' spec: extraArgs: {} resources: {} retentionPeriod: "14" write: allow: true	`(object)` Default config for each availability zone components, including vmagent, vmcluster, vmsingle, vmauth etc. Defines a template for each availability zone, which can be overridden for each availability zone at `availabilityZones[*]`
`zoneTpl.common.spec: affinity: {} nodeSelector: {} topologySpreadConstraints: - maxSkew: 1 topologyKey: kubernetes.io/hostname whenUnsatisfiable: ScheduleAnyway`	`(object)` Common for VMAgent, VMAuth, VMCluster spec params, like nodeSelector, affinity, topologySpreadConstraint, etc
`zoneTpl.read.allow: true`	`(bool)` Allow data query from this zone through global query endpoint
`zoneTpl.read.vmauth.enabled: true`	`(bool)` Create a vmauth with all the zone with `allow: true` as query backends
`zoneTpl.read.vmauth.name: vmauth-read-proxy-{{ (.zone).name }}`	`(string)` Override the name of the vmauth object
`zoneTpl.read.vmauth.spec: unauthorizedUserAccessSpec: url_map: - load_balancing_policy: first_available retry_status_codes: - 500 - 502 - 503`	`(object)` Spec for VMAuth CRD, see here
`zoneTpl.vmagent.annotations: {}`	`(object)` VMAgent remote write proxy annotations
`zoneTpl.vmagent.enabled: true`	`(bool)` Create VMAgent remote write proxy
`zoneTpl.vmagent.name: vmagent-{{ (.zone).name }}`	`(string)` Override the name of the vmagent object
`zoneTpl.vmagent.spec: {}`	`(object)` Spec for VMAgent CRD, see here
`zoneTpl.vmcluster.enabled: true`	`(bool)` Create VMCluster
`zoneTpl.vmcluster.name: vmcluster-{{ (.zone).name }}`	`(string)` Override the name of the vmcluster, by default is
`zoneTpl.vmcluster.spec: replicationFactor: 2 retentionPeriod: "14" vminsert: extraArgs: {} replicaCount: 2 resources: {} vmselect: extraArgs: {} replicaCount: 2 resources: {} vmstorage: replicaCount: 2 resources: {} storageDataPath: /vm-data`	`(object)` Spec for VMCluster CRD, see here
`zoneTpl.vmsingle.enabled: false`	`(bool)` Create VMSingle
`zoneTpl.vmsingle.name: '{{ (.zone).name }}'`	`(string)` Override the name of the vmsingle, by default is
`zoneTpl.vmsingle.spec: extraArgs: {} resources: {} retentionPeriod: "14"`	`(object)` Spec for VMSingle CRD, see here
`zoneTpl.write.allow: true`	`(bool)` Allow data ingestion to this zone

VictoriaMetrics Distributed #

Prerequisites #

Chart Details #

Why use victoria-metrics-distributed chart? #

How to write data? #

How to query data? #

What happens if zone outage happen? #

How to use multitenancy? #

How to install #

Setup chart repository (can be omitted for OCI repositories) #

Install victoria-metrics-distributed chart #

How to upgrade #

Upgrade to 0.13.0 #

Upgrade to 0.5.0 #

How to uninstall #

Documentation of Helm Chart #

Parameters #

Why use `victoria-metrics-distributed` chart? #

Install `victoria-metrics-distributed` chart #