github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

Automatic update operator docs from VictoriaMetrics/operator@d661554 (#7069)

Browse source 
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>
This commit is contained in:
Github Actions 2024-09-22 19:39:52 +03:00 committed by GitHub
parent 55febc0920
commit 8ed9978591
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/operator/README.md
View file

@ -5,7 +5,7 @@ It allows you to manage Victoria Metrics components in Kubernetes or OpenShift c
in a declarative style according to [GitOps](https://www.redhat.com/en/topics/devops/what-is-gitops) 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. and [IaC](https://en.wikipedia.org/wiki/Infrastructure_as_code) concepts.
VictoriaMetrics also provides [helm charts](https://github.com/VictoriaMetrics/helm-charts) without operator. 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). 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. 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.
@ -17,7 +17,7 @@ Learn more about [key concepts](#key-concepts) of `vmoperator` and follow the **
- Simple VictoriaMetrics cluster installation, configuring, upgrading and managing with [crd-objects](https://docs.victoriametrics.com/operator/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. - 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). - 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://victoriametrics.github.io/helm-charts/charts/victoria-metrics-k8s-stack/) with ready-made usecases and solutions. - 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. - Ability to template your own deployment scenarios.
## Key Concepts ## Key Concepts

6
docs/operator/configuration.md
View file

@ -55,11 +55,11 @@ You can read detailed instructions about configuring prometheus-objects conversi
## Helm-charts ## Helm-charts
In [helm-charts](https://github.com/VictoriaMetrics/helm-charts) some important configuration parameters are implemented as separate flags in `values.yaml`: In [Helm charts](https://docs.victoriametrics.com/helm) some important configuration parameters are implemented as separate flags in `values.yaml`:
### victoria-metrics-k8s-stack ### victoria-metrics-k8s-stack
For possible values refer to [parameters](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-k8s-stack#parameters). For possible values refer to [parameters](https://docs.victoriametrics.com/helm/victoriametrics-k8s-stack#parameters).
Also, checkout [here possible ENV variables](https://docs.victoriametrics.com/operator/vars/) to configure operator behaviour. Also, checkout [here possible ENV variables](https://docs.victoriametrics.com/operator/vars/) to configure operator behaviour.
ENV variables can be set in the `victoria-metrics-operator.env` section. ENV variables can be set in the `victoria-metrics-operator.env` section.
@ -134,7 +134,7 @@ victoria-metrics-operator:
### victoria-metrics-operator ### victoria-metrics-operator
For possible values refer to [parameters](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-operator#parameters). For possible values refer to [parameters](https://docs.victoriametrics.com/helm/victoriametrics-operator#parameters).
Also, checkout [here possible ENV variables](https://docs.victoriametrics.com/operator/vars/) to configure operator behaviour. Also, checkout [here possible ENV variables](https://docs.victoriametrics.com/operator/vars/) to configure operator behaviour.
ENV variables can be set in the `env` section. ENV variables can be set in the `env` section.

4
docs/operator/migration.md
View file

@ -56,7 +56,7 @@ VM_ENABLEDPROMETHEUSCONVERTER_PROBE=false
VM_ENABLEDPROMETHEUSCONVERTER_SCRAPECONFIG=false VM_ENABLEDPROMETHEUSCONVERTER_SCRAPECONFIG=false
``` ```
For [victoria-metrics-operator helm-chart](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-operator/README.md) you can use following way: For [victoria-metrics-operator helm-chart](https://docs.victoriametrics.com/helm/victoriametrics-operator) you can use following way:
```yaml ```yaml
# values.yaml # values.yaml
@ -83,7 +83,7 @@ configure adding `OwnerReferences` to converted objects with following [operator
VM_ENABLEDPROMETHEUSCONVERTEROWNERREFERENCES=true VM_ENABLEDPROMETHEUSCONVERTEROWNERREFERENCES=true
``` ```
For [victoria-metrics-operator helm-chart](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-operator/README.md) you can use following way: For [victoria-metrics-operator helm-chart](https://docs.victoriametrics.com/helm/victoriametrics-operator) you can use following way:
```yaml ```yaml
# values.yaml # values.yaml

4
docs/operator/monitoring.md
View file

@ -29,13 +29,13 @@ Alerting rules for VictoriaMetrics operator are available [here](https://github.
### Helm-chart victoria-metrics-k8s-stack ### Helm-chart victoria-metrics-k8s-stack
In [victoria-metrics-k8s-stack](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-k8s-stack/README.md) helm-chart operator self-scrapes metrics by default. In [victoria-metrics-k8s-stack](https://docs.victoriametrics.com/helm/victoriametrics-k8s-stack/) helm-chart operator self-scrapes metrics by default.
This helm-chart also includes [official grafana dashboard for operator](#dashboard) and [official alerting rules for operator](#alerting-rules). This helm-chart also includes [official grafana dashboard for operator](#dashboard) and [official alerting rules for operator](#alerting-rules).
### Helm-chart victoria-metrics-operator ### Helm-chart victoria-metrics-operator
With [victoria-metrics-operator](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-operator/README.md) you can use following parameter in `values.yaml`: With [victoria-metrics-operator](https://docs.victoriametrics.com/helm/victoriametrics-operator) you can use following parameter in `values.yaml`:
```yaml ```yaml
# values.yaml # values.yaml

6
docs/operator/quick-start.md
View file

@ -13,7 +13,7 @@ VictoriaMetrics Operator serves to make running VictoriaMetrics applications on
while preserving Kubernetes-native configuration options. while preserving Kubernetes-native configuration options.
The shortest way to deploy full-stack monitoring cluster with VictoriaMetrics Operator is The shortest way to deploy full-stack monitoring cluster with VictoriaMetrics Operator is
to use Helm-chart [victoria-metrics-k8s-stack](https://victoriametrics.github.io/helm-charts/charts/victoria-metrics-k8s-stack/). to use Helm-chart [victoria-metrics-k8s-stack](https://docs.victoriametrics.com/helm/victoriametrics-k8s-stack/).
Also you can follow the other steps in documentation to use VictoriaMetrics Operator: Also you can follow the other steps in documentation to use VictoriaMetrics Operator:
@ -55,7 +55,7 @@ You can find out how to and instructions for installing the VictoriaMetrics oper
on the [Setup page](https://docs.victoriametrics.com/operator/setup). on the [Setup page](https://docs.victoriametrics.com/operator/setup).
Here we will elaborate on just one of the ways - for instance, we will install operator via Helm-chart Here we will elaborate on just one of the ways - for instance, we will install operator via Helm-chart
[victoria-metrics-operator](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-operator/README.md): [victoria-metrics-operator](https://docs.victoriametrics.com/helm/victoriametrics-operator/):
Add repo with helm-chart: Add repo with helm-chart:
@ -136,7 +136,7 @@ helm install vmoperator vm/victoria-metrics-operator -f values.yaml -n vm
# victoria-metrics-operator has been installed. Check its status by running: # victoria-metrics-operator has been installed. Check its status by running:
# kubectl --namespace vm get pods -l "app.kubernetes.io/instance=vmoperator" # kubectl --namespace vm get pods -l "app.kubernetes.io/instance=vmoperator"
# #
# Get more information on https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-operator. # Get more information on https://docs.victoriametrics.com/helm/victoriametrics-operator/
# See "Getting started guide for VM Operator" on https://docs.victoriametrics.com/guides/getting-started-with-vm-operator/. # See "Getting started guide for VM Operator" on https://docs.victoriametrics.com/guides/getting-started-with-vm-operator/.
``` ```

8
docs/operator/setup.md
View file

@ -13,13 +13,13 @@ aliases:
You can use one of the following official helm-charts with `vmoperator`: You can use one of the following official helm-charts with `vmoperator`:
- [victoria-metrics-operator helm-chart](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-operator/README.md) - [victoria-metrics-operator helm-chart](https://docs.victoriametrics.com/helm/victoriametrics-operator)
- [victoria-metrics-k8s-stack helm chart](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-k8s-stack/README.md) - [victoria-metrics-k8s-stack helm chart](https://docs.victoriametrics.com/helm/victoriametrics-k8s-stack)
(includes the `victoria-metrics-operator` helm-chart and other components for full-fledged k8s monitoring, is an alternative for [kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack)). (includes the `victoria-metrics-operator` helm-chart and other components for full-fledged k8s monitoring, is an alternative for [kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack)).
For installing VictoriaMetrics operator with helm-chart follow the instructions from README of the corresponding helm-chart For installing VictoriaMetrics operator with helm-chart follow the instructions from README of the corresponding helm-chart
([this](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-operator/README.md) ([this](https://docs.victoriametrics.com/helm/victoriametrics-operator)
or [this](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-k8s-stack/README.md)). or [this](https://docs.victoriametrics.com/helm/victoriametrics-k8s-stack)).
in addition, you can use [quickstart guide](https://docs.victoriametrics.com/operator/quick-start) for in addition, you can use [quickstart guide](https://docs.victoriametrics.com/operator/quick-start) for
installing VictoriaMetrics operator with helm-chart. installing VictoriaMetrics operator with helm-chart.