README.md

VictoriaMetrics operator

Overview

Design and implementation inspired by prometheus-operator. It's great a tool for managing monitoring configuration of your applications. VictoriaMetrics operator has api capability with it. So you can use familiar CRD objects: ServiceMonitor, PodMonitor, PrometheusRule, Probe and ScrapeConfig. Or you can use VictoriaMetrics CRDs:

• VMServiceScrape - defines scraping metrics configuration from pods backed by services.
• VMPodScrape - defines scraping metrics configuration from pods.
• VMRule - defines alerting or recording rules.
• VMProbe - defines a probing configuration for targets with blackbox exporter.
• VMScrapeConfig - define a scrape config using any of the service discovery options supported in victoriametrics.

Besides, operator allows you to manage VictoriaMetrics applications inside kubernetes cluster and simplifies this process quick-start With CRD (Custom Resource Definition) you can define application configuration and apply it to your cluster crd-objects.

Operator simplifies VictoriaMetrics cluster installation, upgrading and managing.

It has integration with VictoriaMetrics vmbackupmanager - advanced tools for making backups. Check Backup automation for VMSingle or Backup automation for VMCluster.

Use cases

For kubernetes-cluster administrators, it simplifies installation, configuration, management for VictoriaMetrics application. And the main feature of operator - is ability to delegate applications monitoring configuration to the end-users.

For applications developers, its great possibility for managing observability of applications. You can define metrics scraping and alerting configuration for your application and manage it with an application deployment process. Just define app_deployment.yaml, app_vmpodscrape.yaml and app_vmrule.yaml. That's it, you can apply it to a kubernetes cluster. Check quick-start for an example.

Operator vs helm-chart

VictoriaMetrics provides helm charts. Operator makes the same, simplifies it and provides advanced features.

Documentation

• quick start doc

• high availability doc

• relabeling configuration doc

• managing crd objects versions doc

• design and description of implementation design

• operator objects description doc

• backups docs

• external access to cluster resourcesdoc

• security doc

• resource validation doc

  NOTE documentations was moved into main VictoriaMetrics repo link All changes must be done there.

Configuration

Operator configured by env variables, list of it can be found at link

It defines default configuration options, like images for components, timeouts, features.

Kubernetes' compatibility versions

operator tested on officially supported Kubernetes versions

Community and contributions

Feel free asking any questions regarding VictoriaMetrics:

• slack
• reddit
• telegram-en
• telegram-ru
• google groups

Development

Dependencies:

• kubebuilder v4
• golang 1.22+
• kubectl
• docker

start:

make run

to run unit tests

make test

to run e2e tests on automatically configured Kind cluster

# make test-e2e