mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-23 20:37:12 +01:00
8ed9978591
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Signed-off-by: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com> Co-authored-by: AndrewChubatiuk <3162380+AndrewChubatiuk@users.noreply.github.com>
83 lines
6.1 KiB
Markdown
83 lines
6.1 KiB
Markdown
Operator serves to make running VictoriaMetrics applications on top of Kubernetes as easy as possible while preserving Kubernetes-native configuration options.
|
|
|
|
VictoriaMetrics Operator (`vmoperator`) is the classic kubernetes-operator for VictoriaMetrics with many [great features](#features-of-vmoperator).
|
|
It allows you to manage Victoria Metrics components in Kubernetes or OpenShift clusters
|
|
in a declarative style according to [GitOps](https://www.redhat.com/en/topics/devops/what-is-gitops)
|
|
and [IaC](https://en.wikipedia.org/wiki/Infrastructure_as_code) concepts.
|
|
|
|
VictoriaMetrics also provides [helm charts](https://docs.victoriametrics.com/helm) without operator.
|
|
Operator makes the same, simplifies it and provides [advanced features](#features-of-vmoperator).
|
|
|
|
Learn more about [key concepts](#key-concepts) of `vmoperator` and follow the **[quick start guide](https://docs.victoriametrics.com/operator/quick-start/)** for a better experience.
|
|
|
|
## Features of vmoperator
|
|
|
|
- Deployment and management in a kubernetes clusters of any number of VictoriaMetrics applications (like vmsingle/vmcluster instances and another components like vmauth, vmagent, vmalert, etc...)
|
|
- Seamless [migration from prometheus-operator](https://docs.victoriametrics.com/operator/migration/) with auto-conversion of prometheus [custom resources](#custom-resources)
|
|
- Simple VictoriaMetrics cluster installation, configuring, upgrading and managing with [crd-objects](https://docs.victoriametrics.com/operator/resources/).
|
|
- Ability to delegate the configuration (parts of configuration) of applications monitoring to the end-users and managing access to different configurations or configuration sections.
|
|
- Integration with VictoriaMetrics [vmbackupmanager](https://docs.victoriametrics.com/vmbackupmanager/) - advanced tools for making backups. Check [Backup automation for VMSingle](https://docs.victoriametrics.com/operator/resources/vmsingle#backup-automation) or [Backup automation for VMCluster](https://docs.victoriametrics.com/operator/resources/vmcluster#backup-automation).
|
|
- Everything you need for monitoring out of the box in [k8s-stack helm chart](https://docs.victoriametrics.com/helm/victoriametrics-k8s-stack/) with ready-made usecases and solutions.
|
|
- Ability to template your own deployment scenarios.
|
|
|
|
## Key Concepts
|
|
|
|
### Kubernetes-operators
|
|
|
|
[Kubernetes-operators](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) are software extensions
|
|
for Kubernetes that make use of [custom resources](#custom-resources) to manage applications and their components.
|
|
Operators follow Kubernetes principles, notably the control loop.
|
|
It can be said that operators are custom controllers for Kubernetes that allow you to create business logic for custom resources.
|
|
|
|
Design and implementation of `vmoperator` inspired by [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator).
|
|
|
|
Useful links:
|
|
- [Custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
|
|
- [Custom resource definitions](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/)
|
|
- [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
|
|
- [Operator best practices](https://sdk.operatorframework.io/docs/best-practices/)
|
|
|
|
### Custom resources
|
|
|
|
Kubernetes-Operators use [custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
|
|
for interaction. Custom resources are a mechanism built into Kubernetes that allows you to create your own extensions for Kubernetes,
|
|
working on the same principles as those built into Kubernetes APIs. Custom resources make Kubernetes so modular and extensible.
|
|
|
|
In addition, thanks to CRD ([Custom Resource Definitions](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/)),
|
|
the mechanism of custom resources allows you to declare an API in the format of the OpenAPI specification and verify that the resources correspond to this API.
|
|
|
|
### Reconciliation cycle
|
|
|
|
The main task of the operator is to bring the state of the cluster in line with what is declared by the user in the custom resources.
|
|
This process of constant monitoring and adjustment is called the "Reconciliation cycle" - it is the operator's workflow.
|
|
|
|
The basic workflow of working with the operator can be simplified as the following diagram:
|
|
|
|
|
|
|
|
- Operator declares and owns [resources of Victoria Metrics](https://docs.victoriametrics.com/operator/resources/).
|
|
- Kubernetes validates of the resource according to the specification from CRD (see more in [custom resources](#custom-resources)).
|
|
- Operator subscribed to change events (`create`, `update`, `delete`) for related resources.
|
|
- When an event occurs, the operator reacts and updates the state of the objects in the cluster.
|
|
- For some objects in the cluster the reconciliation cycle is performed at a given interval, even without the occurrence of change events (see `VM_FORCERESYNCINTERVAL`).
|
|
|
|
### Next steps
|
|
- [Quick Start Guide](https://docs.victoriametrics.com/operator/quick-start/)
|
|
- [Setup](https://docs.victoriametrics.com/operator/setup/)
|
|
- [Security](https://docs.victoriametrics.com/operator/security/)
|
|
- [Configuration](https://docs.victoriametrics.com/operator/configuration/)
|
|
- [Migration from Prometheus](https://docs.victoriametrics.com/operator/migration/)
|
|
- [Monitoring](https://docs.victoriametrics.com/operator/monitoring/)
|
|
- [Authorization and exposing components](https://docs.victoriametrics.com/operator/auth/)
|
|
- [High Availability](https://docs.victoriametrics.com/operator/high-availability/)
|
|
- [Enterprise](https://docs.victoriametrics.com/operator/enterprise/)
|
|
- [Custom resources](https://docs.victoriametrics.com/operator/resources/)
|
|
|
|
If you have any questions, check out our [FAQ](https://docs.victoriametrics.com/operator/faq/)
|
|
and feel free to can ask them:
|
|
- [VictoriaMetrics Slack](https://victoriametrics.slack.com/)
|
|
- [VictoriaMetrics Telegram](https://t.me/VictoriaMetrics_en)
|
|
|
|
If you have any suggestions or find a bug, please create an issue
|
|
on [GitHub](https://github.com/VictoriaMetrics/operator/issues/new).
|