victoriametrics/operator repository overview

⁠VictoriaMetrics Operator

⁠What is operator?

The VictoriaMetrics Operator is a Kubernetes Operator that simplifies the deployment, scaling, and management of a full VictoriaMetrics monitoring stack on Kubernetes. It introduces Custom Resource Definitions (CRDs) like VMCluster, VMAgent, and VMAlert that let you manage complex VictoriaMetrics setups with simple declarative YAML manifests.

⁠How to Use This Image

The Operator image is not typically run with docker run. Instead, it's deployed into a Kubernetes cluster, usually via Helm, where it watches for VictoriaMetrics CRDs.

Deploying the Operator with Helm:

#  Add  the  VictoriaMetrics  Helm  repository\
helm  repo  add  vm  https://victoriametrics.github.io/helm-charts/\
helm  repo  update

#  Install  the  operator\
helm  install  vmoperator  vm/victoria-metrics-operator  -n  victoria-metrics  --create-namespace

After installation, you can create resources like a VMSingle or VMCluster in your cluster.

⁠Configuration

The operator itself is configured through its deployment manifest or Helm values.yaml. The VictoriaMetrics components it manages are configured through their respective CRD specs in YAML.