Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VictoriaMetrics/operator
Kubernetes operator for Victoria Metrics
https://github.com/VictoriaMetrics/operator
Last synced: 3 months ago
JSON representation
Kubernetes operator for Victoria Metrics
- Host: GitHub
- URL: https://github.com/VictoriaMetrics/operator
- Owner: VictoriaMetrics
- License: apache-2.0
- Created: 2020-05-09T08:10:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T12:25:58.000Z (6 months ago)
- Last Synced: 2024-05-22T14:32:32.242Z (6 months ago)
- Language: Go
- Size: 14.1 MB
- Stars: 392
- Watchers: 16
- Forks: 143
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: docs/security.md
Awesome Lists containing this project
README
[](https://github.com/VictoriaMetrics/operator/releases/latest)
[](https://hub.docker.com/r/victoriametrics/operator)
[](http://slack.victoriametrics.com/)
[](https://github.com/VictoriaMetrics/operator/blob/master/LICENSE)
[](https://goreportcard.com/report/github.com/VictoriaMetrics/operator)
[](https://github.com/VictoriaMetrics/operator/actions)
# VictoriaMetrics operator
## Overview
Design and implementation inspired by [prometheus-operator](https://github.com/prometheus-operator/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](./docs/quick-start.md)
With CRD (Custom Resource Definition) you can define application configuration and apply it to your cluster [crd-objects](./docs/api.md).
Operator simplifies VictoriaMetrics cluster installation, upgrading and managing.
It has integration with VictoriaMetrics [vmbackupmanager](https://docs.victoriametrics.com/vmbackupmanager.html) - advanced tools for making backups. Check [Backup automation for VMSingle](./docs/resources/vmsingle.md#backup-automation) or [Backup automation for VMCluster](./docs/resources/vmcluster.md#backup-automation).
## 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](./docs/quick-start.md) for an example.
## Operator vs helm-chart
VictoriaMetrics provides [helm charts](https://github.com/VictoriaMetrics/helm-charts). Operator makes the same, simplifies it and provides advanced features.
## Documentation
- quick start [doc](https://docs.victoriametrics.com/operator/quick-start.html)
- high availability [doc](https://docs.victoriametrics.com/operator/high-availability.html)
- relabeling configuration [doc](https://docs.victoriametrics.com/operator/relabeling.html)
- managing crd objects versions [doc](https://docs.victoriametrics.com/operator/managing-versions.html)
- design and description of implementation [design](https://docs.victoriametrics.com/operator/design.html)
- operator objects description [doc](https://docs.victoriametrics.com/operator/api.html)
- backups [docs](https://docs.victoriametrics.com/operator/backups.html)
- external access to cluster resources[doc](https://docs.victoriametrics.com/operator/auth.html)
- security [doc](https://docs.victoriametrics.com/operator/security.html)
- resource validation [doc](https://docs.victoriametrics.com/operator/resources-validation.html)
NOTE documentations was moved into main VictoriaMetrics repo [link](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/operator)
All changes must be done there.
## Configuration
Operator configured by env variables, list of it can be found at [link](https://docs.victoriametrics.com/operator/vars.html)
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](http://slack.victoriametrics.com/)
* [reddit](https://www.reddit.com/r/VictoriaMetrics/)
* [telegram-en](https://t.me/VictoriaMetrics_en)
* [telegram-ru](https://t.me/VictoriaMetrics_ru1)
* [google groups](https://groups.google.com/forum/#!forum/victorametrics-users)
## Development
Dependencies:
- kubebuilder v4
- golang 1.22+
- kubectl
- docker
start:
```bash
make run
```
### to run unit tests
```bash
make test
```
### to run e2e tests on automatically configured Kind cluster
```bash
# make test-e2e
```