From 3c2c6f1dad5eb7ee7dc95e51e1c07ec87d658dd2 Mon Sep 17 00:00:00 2001
From: Alexander Marshalov <_@marshalov.org>
Date: Wed, 30 Aug 2023 11:40:15 +0200
Subject: [PATCH] WIP
---
docs/README.md | 14 ++++----
docs/auth.md | 36 ++++++-------------
docs/configuration.md | 4 +--
docs/faq.md | 24 ++++++-------
docs/guides/backups.md | 4 +--
docs/migration.md | 48 +++++++++++++-------------
docs/monitoring.md | 6 ++--
docs/quickstart.md | 4 +--
docs/resources/README.md | 32 ++++++++---------
docs/resources/vmagent.md | 6 ++--
docs/resources/vmalert.md | 2 +-
docs/resources/vmalertmanager.md | 2 +-
docs/resources/vmalertmanagerconfig.md | 2 +-
docs/resources/vmauth.md | 2 +-
docs/resources/vmcluster.md | 2 +-
docs/resources/vmnodescrape.md | 2 +-
docs/resources/vmpodscrape.md | 2 +-
docs/resources/vmprobe.md | 2 +-
docs/resources/vmrule.md | 2 +-
docs/resources/vmservicescrape.md | 2 +-
docs/resources/vmsingle.md | 4 +--
docs/resources/vmstaticscrape.md | 2 +-
docs/resources/vmuser.md | 2 +-
docs/security.md | 4 +--
docs/setup.md | 2 +-
25 files changed, 96 insertions(+), 116 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index f064105f..64682c25 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -14,18 +14,18 @@ in a declarative style according to [GitOps](https://www.redhat.com/en/topics/de
and [IaC](https://en.wikipedia.org/wiki/Infrastructure_as_code) concepts.
VictoriaMetrics also provides [helm charts](https://github.com/VictoriaMetrics/helm-charts) without operator.
-Operator makes the same, simplifies it and provides [advanced features](https://docs.victorimetrics.com/vmoperator/#features).
+Operator makes the same, simplifies it and provides [advanced features](https://docs.victorimetrics.com/operator/#features).
-Learn more about [key concepts](#key-concepts) of `vmoperator` and follow the **[quick start guide](https://docs.victoriametrics.com/vmoperator/quickstart.html)** for a better experience.
+Learn more about [key concepts](#key-concepts) of `vmoperator` and follow the **[quick start guide](https://docs.victoriametrics.com/operator/quickstart.html)** 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/vmoperator/migration.html) with auto-conversion of prometheus [custom resources](#custom-resources)
-- Simple VictoriaMetrics cluster installation, configuring, upgrading and managing with [crd-objects](https://docs.victoriametrics.com/vmoperator/resources/).
+- Seamless [migration from prometheus-operator](https://docs.victoriametrics.com/operator/migration.html) 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.html) - advanced tools for making backups. Check [backup docs](https://docs.victoriametrics.com/vmoperator/backups.html)
-- Everything you need for monitoring out of the box in [k8s-stack helm chart](http://docs.victoriametrics.com/vmoperator/deploy.html) with ready-made usecases and solutions.
+- Integration with VictoriaMetrics [vmbackupmanager](https://docs.victoriametrics.com/vmbackupmanager.html) - advanced tools for making backups. Check [backup docs](https://docs.victoriametrics.com/operator/backups.html)
+- Everything you need for monitoring out of the box in [k8s-stack helm chart](http://docs.victoriametrics.com/operator/deploy.html) with ready-made usecases and solutions.
- Ability to template your own deployment scenarios.
## Key Concepts
@@ -63,7 +63,7 @@ The basic workflow of working with the operator can be simplified as the followi
-- Operator declares and owns [resources of Victoria Metrics](http://docs.victoriametrics.com/vmoperator/resources/).
+- Operator declares and owns [resources of Victoria Metrics](http://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.
diff --git a/docs/auth.md b/docs/auth.md
index 1f9ff69b..e8a69d97 100644
--- a/docs/auth.md
+++ b/docs/auth.md
@@ -14,8 +14,7 @@ It adds missing authorization and access control features and enforces it.
Access can be given with `VMUser` definition. It supports basic auth and bearer token authentication:
-```console
-cat << EOF | kubectl apply -f -
+```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAuth
metadata:
@@ -24,13 +23,11 @@ spec:
userNamespaceSelector: {}
userSelector: {}
ingress: {}
-EOF
```
Advanced configuration with cert-manager annotations:
-```console
-cat << EOF | kubectl apply -f -
+```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAuth
metadata:
@@ -56,14 +53,12 @@ spec:
class_name: nginx
tlsHosts:
- vm-access.example.com
-EOF
```
Simple static routing with read-only access to vmagent for username - `user-1` with password `Asafs124142`:
-```console
+```yaml
# curl vmauth:8427/metrics -u 'user-1:Asafs124142'
-cat << EOF | kubectl apply -f
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMUser
metadata:
@@ -74,14 +69,12 @@ spec:
- static:
url: http://vmagent-base.default.svc:8429
paths: ["/targets/api/v1","/targets","/metrics"]
-EOF
```
With bearer token access:
-```console
+```yaml
# curl vmauth:8427/metrics -H 'Authorization: Bearer Asafs124142'
-cat << EOF | kubectl apply -f
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMUser
metadata:
@@ -92,14 +85,12 @@ spec:
- static:
url: http://vmagent-base.default.svc:8429
paths: ["/targets/api/v1","/targets","/metrics"]
-EOF
```
It's also possible to use service discovery for objects:
-```console
+```yaml
# curl vmauth:8427/metrics -H 'Authorization: Bearer Asafs124142'
-cat << EOF | kubectl apply -f
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMUser
metadata:
@@ -112,13 +103,11 @@ spec:
name: base
namespace: default
paths: ["/targets/api/v1","/targets","/metrics"]
-EOF
```
Cluster components supports auto path generation for single tenant view:
-```console
-cat << EOF | kubectl apply -f -
+```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMUser
metadata:
@@ -140,17 +129,15 @@ spec:
url: http://vmselect-test-persistent.default.svc:8481/
paths:
- /internal/resetRollupResultCache
-EOF
```
For each `VMUser` operator generates corresponding secret with username/password or bearer token at the same namespace as `VMUser`.
## Basic auth for targets
-To authenticate a `VMServiceScrape`s over a metrics endpoint use [`basicAuth`](https://docs.victoriametrics.com/vmoperator/api.html#basicauth):
+To authenticate a `VMServiceScrape`s over a metrics endpoint use [`basicAuth`](https://docs.victoriametrics.com/operator/api.html#basicauth):
-```console
-cat << EOF | kubectl apply -f -
+```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMServiceScrape
metadata:
@@ -170,11 +157,9 @@ spec:
selector:
matchLabels:
app: myapp
-EOF
-```
-```console
-cat << EOF | kubectl apply -f -
+---
+
apiVersion: v1
kind: Secret
metadata:
@@ -183,5 +168,4 @@ data:
password: dG9vcg== # toor
user: YWRtaW4= # admin
type: Opaque
-EOF
```
diff --git a/docs/configuration.md b/docs/configuration.md
index e8c14d82..8937c735 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -6,13 +6,13 @@ title: Configuration
# Configuration
-Operator configured by env variables, list of it can be found at [link](https://docs.victoriametrics.com/vmoperator/vars.html).
+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.
## Conversion of prometheus-operator objects
-You can read detailed instructions about configuring prometheus-objects conversion in [this document](http://docs.victoriametrics.com/vmoperator/migration.html).
+You can read detailed instructions about configuring prometheus-objects conversion in [this document](http://docs.victoriametrics.com/operator/migration.html).
## Helm-charts
diff --git a/docs/faq.md b/docs/faq.md
index 69e472ec..aef069ec 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -8,7 +8,7 @@ title: FAQ
## How do you monitor the operator itself?
-You can read about vmoperator monitoring in [this document](https://docs.victoriametrics.com/vmoperator/monitoring.html).
+You can read about vmoperator monitoring in [this document](https://docs.victoriametrics.com/operator/monitoring.html).
## How to change VMStorage PVC storage class
@@ -31,8 +31,8 @@ With Operator deployment:
You can use `VM_CONTAINERREGISTRY` parameter for operator:
-- See details about tuning [operator settings here](https://docs.victoriametrics.com/vmoperator/setup.html#settings).
-- See [available operator settings](https://docs.victoriametrics.com/vmoperator/vars.html) here.
+- See details about tuning [operator settings here](https://docs.victoriametrics.com/operator/setup.html#settings).
+- See [available operator settings](https://docs.victoriametrics.com/operator/vars.html) here.
## How to override image
@@ -40,27 +40,27 @@ TODO
## How to set up automatic backups?
-You can read about backups setup in [this guide](https://docs.victoriametrics.com/vmoperator/guides/backups.html).
+You can read about backups setup in [this guide](https://docs.victoriametrics.com/operator/guides/backups.html).
## How to migrate from Prometheus-operator to VictoriaMetrics operator?
-You can read about migration from prometheus operator on [this page](https://docs.victoriametrics.com/vmoperator/migration.html).
+You can read about migration from prometheus operator on [this page](https://docs.victoriametrics.com/operator/migration.html).
## How to turn off conversion for prometheus resources
-You can read about it on [this page](https://docs.victoriametrics.com/vmoperator/migration.html#objects-convesion).
+You can read about it on [this page](https://docs.victoriametrics.com/operator/migration.html#objects-convesion).
## My VM objects are not deleted/changed when I delete/change Prometheus objects
You can read about it in following sections of "Migration from prometheus-operator" docs:
-- [Deletion synchronization](https://docs.victoriametrics.com/vmoperator/migration.html#deletion-synchronization)
-- [Update synchronization](https://docs.victoriametrics.com/vmoperator/migration.html#update-synchronization)
-- [Labels synchronization](https://docs.victoriametrics.com/vmoperator/migration.html#labels-synchronization)
+- [Deletion synchronization](https://docs.victoriametrics.com/operator/migration.html#deletion-synchronization)
+- [Update synchronization](https://docs.victoriametrics.com/operator/migration.html#update-synchronization)
+- [Labels synchronization](https://docs.victoriametrics.com/operator/migration.html#labels-synchronization)
## What permissions does an operator need to run in a cluster?
-You can read about needed permissions for operator in [this document](https://docs.victoriametrics.com/vmoperator/security.html#roles).
+You can read about needed permissions for operator in [this document](https://docs.victoriametrics.com/operator/security.html#roles).
## How to run VictoriaMetrics operator with permissions for one namespace only?
@@ -83,10 +83,6 @@ and disable CRD controller with flag: `--controller.disableCRDOwnership=true`
**TODO**
-## **TODO** ArgoCD
-
-**TODO**
-
## TODO: How to scale/replicate vmoperator?
**TODO**
diff --git a/docs/guides/backups.md b/docs/guides/backups.md
index 0028aac9..d0878fe9 100644
--- a/docs/guides/backups.md
+++ b/docs/guides/backups.md
@@ -13,7 +13,7 @@ It contains a description of the service and its features. This documentation co
## Usage examples
-[`VMSingle`](https://docs.victoriametrics.com/vmoperator/resources/vmsingle.html) and [`VMCluster`](https://docs.victoriametrics.com/vmoperator/resources/vmcluster.html)
+[`VMSingle`](https://docs.victoriametrics.com/operator/resources/vmsingle.html) and [`VMCluster`](https://docs.victoriametrics.com/operator/resources/vmcluster.html)
has built-in backup configuration, it uses `vmbackupmanager` - proprietary tool for backups.
It supports incremental backups (hourly, daily, weekly, monthly) with popular object storages (aws s3, google cloud storage).
@@ -76,7 +76,7 @@ It's needed to make consistent backups for each storage node.
You can read more about backup configuration options and mechanics [here](https://docs.victoriametrics.com/vmbackup.html)
-Possible configuration options for backup crd can be found at [link](https://docs.victoriametrics.com/vmoperator/api.html#vmbackup)
+Possible configuration options for backup crd can be found at [link](https://docs.victoriametrics.com/operator/api.html#vmbackup)
## Restoring backups
diff --git a/docs/migration.md b/docs/migration.md
index 3a99cdcf..1d23ddf6 100644
--- a/docs/migration.md
+++ b/docs/migration.md
@@ -13,11 +13,11 @@ So you can use familiar CRD objects: `ServiceMonitor`, `PodMonitor`, `Prometheus
Or you can use VictoriaMetrics CRDs:
-- `VMServiceScrape` (instead of `ServiceMonitor`) - defines scraping metrics configuration from pods backed by services. [See details](https://docs.victoriametrics.com/vmoperator/resources/vmservicescrape.html).
-- `VMPodScrape` (instead of `PodMonitor`) - defines scraping metrics configuration from pods. [See details](https://docs.victoriametrics.com/vmoperator/resources/vmpodscrape.html).
-- `VMRule` (instead of `PrometheusRule`) - defines alerting or recording rules. [See details](https://docs.victoriametrics.com/vmoperator/resources/vmrule.html).
-- `VMProbe` (instead of `Probe`) - defines a probing configuration for targets with blackbox exporter. [See details](https://docs.victoriametrics.com/vmoperator/resources/vmprobe.html).
-- `VMAlertmanagerConfig` (instead of `AlertmanagerConfig`) - defines a configuration for AlertManager. [See details](https://docs.victoriametrics.com/vmoperator/resources/vmalertmanagerconfig.html).
+- `VMServiceScrape` (instead of `ServiceMonitor`) - defines scraping metrics configuration from pods backed by services. [See details](https://docs.victoriametrics.com/operator/resources/vmservicescrape.html).
+- `VMPodScrape` (instead of `PodMonitor`) - defines scraping metrics configuration from pods. [See details](https://docs.victoriametrics.com/operator/resources/vmpodscrape.html).
+- `VMRule` (instead of `PrometheusRule`) - defines alerting or recording rules. [See details](https://docs.victoriametrics.com/operator/resources/vmrule.html).
+- `VMProbe` (instead of `Probe`) - defines a probing configuration for targets with blackbox exporter. [See details](https://docs.victoriametrics.com/operator/resources/vmprobe.html).
+- `VMAlertmanagerConfig` (instead of `AlertmanagerConfig`) - defines a configuration for AlertManager. [See details](https://docs.victoriametrics.com/operator/resources/vmalertmanagerconfig.html).
Note that Prometheus CRDs are not supplied with the VictoriaMetrics operator,
so you need to [install them separately](https://github.com/prometheus-operator/prometheus-operator/releases).
@@ -64,12 +64,12 @@ Otherwise, VictoriaMetrics Operator would try to discover prometheus-operator AP
-For more information about the operator's workflow, see [this doc](https://docs.victoriametrics.com/vmoperator/#workflow).
+For more information about the operator's workflow, see [this doc](https://docs.victoriametrics.com/operator/#workflow).
## Deletion synchronization
By default, the operator doesn't make converted objects disappear after original ones are deleted. To change this behaviour
-configure adding `OwnerReferences` to converted objects with following [operator parameter](https://docs.victoriametrics.com/vmoperator/setup.html#settings):
+configure adding `OwnerReferences` to converted objects with following [operator parameter](https://docs.victoriametrics.com/operator/setup.html#settings):
```console
VM_ENABLEDPROMETHEUSCONVERTEROWNERREFERENCES=true
@@ -116,14 +116,14 @@ spec:
Annotation `operator.victoriametrics.com/ignore-prometheus-updates` can be set on one of the resources:
-- [VMServiceScrape](https://docs.victoriametrics.com/vmoperator/resources/vmservicescrape.html)
-- [VMPodScrape](https://docs.victoriametrics.com/vmoperator/resources/vmpodscrape.html)
-- [VMRule](https://docs.victoriametrics.com/vmoperator/resources/vmrule.html)
-- [VMProbe](https://docs.victoriametrics.com/vmoperator/resources/vmprobe.html)
-- [VMAlertmanagerConfig](https://docs.victoriametrics.com/vmoperator/resources/vmalertmanagerconfig.html)
+- [VMServiceScrape](https://docs.victoriametrics.com/operator/resources/vmservicescrape.html)
+- [VMPodScrape](https://docs.victoriametrics.com/operator/resources/vmpodscrape.html)
+- [VMRule](https://docs.victoriametrics.com/operator/resources/vmrule.html)
+- [VMProbe](https://docs.victoriametrics.com/operator/resources/vmprobe.html)
+- [VMAlertmanagerConfig](https://docs.victoriametrics.com/operator/resources/vmalertmanagerconfig.html)
-And annotation doesn't make sense for [VMStaticScrape](https://docs.victoriametrics.com/vmoperator/resources/vmstaticscrape.html)
-and [VMNodeScrape](https://docs.victoriametrics.com/vmoperator/resources/vmnodescrape.html) because these objects are not created as a result of conversion.
+And annotation doesn't make sense for [VMStaticScrape](https://docs.victoriametrics.com/operator/resources/vmstaticscrape.html)
+and [VMNodeScrape](https://docs.victoriametrics.com/operator/resources/vmnodescrape.html) because these objects are not created as a result of conversion.
## Labels and annotations synchronization
@@ -156,17 +156,17 @@ spec:
Annotation `operator.victoriametrics.com/merge-meta-strategy` can be set on one of the resources:
-- [VMServiceScrape](https://docs.victoriametrics.com/vmoperator/resources/vmservicescrape.html)
-- [VMPodScrape](https://docs.victoriametrics.com/vmoperator/resources/vmpodscrape.html)
-- [VMRule](https://docs.victoriametrics.com/vmoperator/resources/vmrule.html)
-- [VMProbe](https://docs.victoriametrics.com/vmoperator/resources/vmprobe.html)
-- [VMAlertmanagerConfig](https://docs.victoriametrics.com/vmoperator/resources/vmalertmanagerconfig.html)
+- [VMServiceScrape](https://docs.victoriametrics.com/operator/resources/vmservicescrape.html)
+- [VMPodScrape](https://docs.victoriametrics.com/operator/resources/vmpodscrape.html)
+- [VMRule](https://docs.victoriametrics.com/operator/resources/vmrule.html)
+- [VMProbe](https://docs.victoriametrics.com/operator/resources/vmprobe.html)
+- [VMAlertmanagerConfig](https://docs.victoriametrics.com/operator/resources/vmalertmanagerconfig.html)
-And annotation doesn't make sense for [VMStaticScrape](https://docs.victoriametrics.com/vmoperator/resources/vmstaticscrape.html)
-and [VMNodeScrape](https://docs.victoriametrics.com/vmoperator/resources/vmnodescrape.html) because these objects are not created as a result of conversion.
+And annotation doesn't make sense for [VMStaticScrape](https://docs.victoriametrics.com/operator/resources/vmstaticscrape.html)
+and [VMNodeScrape](https://docs.victoriametrics.com/operator/resources/vmnodescrape.html) because these objects are not created as a result of conversion.
You can filter labels for syncing
-with [operator parameter](https://docs.victoriametrics.com/vmoperator/setup.html#settings) `VM_FILTERPROMETHEUSCONVERTERLABELPREFIXES`:
+with [operator parameter](https://docs.victoriametrics.com/operator/setup.html#settings) `VM_FILTERPROMETHEUSCONVERTERLABELPREFIXES`:
```console
# it excludes all labels that start with "helm.sh" or "argoproj.io" from synchronization
@@ -174,7 +174,7 @@ VM_FILTERPROMETHEUSCONVERTERLABELPREFIXES=helm.sh,argoproj.io
```
In the same way, annotations with specified prefixes can be excluded from synchronization
-with [operator parameter](https://docs.victoriametrics.com/vmoperator/setup.html#settings) `VM_FILTERPROMETHEUSCONVERTERANNOTATIONPREFIXES`:
+with [operator parameter](https://docs.victoriametrics.com/operator/setup.html#settings) `VM_FILTERPROMETHEUSCONVERTERANNOTATIONPREFIXES`:
```console
# it excludes all annotations that start with "helm.sh" or "argoproj.io" from synchronization
@@ -184,7 +184,7 @@ VM_FILTERPROMETHEUSCONVERTERANNOTATIONPREFIXES=helm.sh,argoproj.io
## Using converter with ArgoCD
If you use ArgoCD, you can allow ignoring objects at ArgoCD converted from Prometheus CRD
-with [operator parameter](https://docs.victoriametrics.com/vmoperator/setup.html#settings) `VM_PROMETHEUSCONVERTERADDARGOCDIGNOREANNOTATIONS`.
+with [operator parameter](https://docs.victoriametrics.com/operator/setup.html#settings) `VM_PROMETHEUSCONVERTERADDARGOCDIGNOREANNOTATIONS`.
It helps to properly use converter with ArgoCD and should help prevent out-of-sync issues with argo-cd based deployments:
diff --git a/docs/monitoring.md b/docs/monitoring.md
index 743b07ed..8dd2f5db 100644
--- a/docs/monitoring.md
+++ b/docs/monitoring.md
@@ -8,7 +8,7 @@ title: Monitoring
VictoriaMetrics operator exports internal metrics in Prometheus exposition format at `/metrics` page.
-These metrics can be scraped via [vmagent](https://docs.victoriametrics.com/vmoperator/resources/vmagent.html) or Prometheus.
+These metrics can be scraped via [vmagent](https://docs.victoriametrics.com/operator/resources/vmagent.html) or Prometheus.
@@ -44,7 +44,7 @@ serviceMonitor:
This parameter makes helm-chart to create a scrape-object for installed operator instance.
-You will also need to deploy a (vmsingle)[https://docs.victoriametrics.com/vmoperator/resources/vmsingle.html] where the metrics will be collected.
+You will also need to deploy a (vmsingle)[https://docs.victoriametrics.com/operator/resources/vmsingle.html] where the metrics will be collected.
### Pure operator installation
@@ -68,7 +68,7 @@ spec:
- monitoring
```
-See more info about object [VMServiceScrape](https://docs.victoriametrics.com/vmoperator/resources/vmservicescrape.html).
+See more info about object [VMServiceScrape](https://docs.victoriametrics.com/operator/resources/vmservicescrape.html).
You will also need a [vmsingle](https://docs.victoriametrics.com/vmoperatos/resources/vmsingle.html) where the metrics will be collected.
diff --git a/docs/quickstart.md b/docs/quickstart.md
index 6b5a62cd..504d2cda 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -12,7 +12,7 @@ Kubernetes-native configuration options.
## 1. Setup
You can find out how to and instructions for installing the VictoriaMetrics operator into your kubernetes cluster
-on the [Setup page](https://docs.victoriametrics.com/vmoperator/setup.html).
+on the [Setup page](https://docs.victoriametrics.com/operator/setup.html).
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):
@@ -39,7 +39,7 @@ code values.yaml
Now you can change configuration in `values.yaml`. For more details
-see [configuration -> victoria-metrics-operator](https://docs.victoriametrics.com/vmoperator/configuration.html#victoria-metrics-operator).
+see [configuration -> victoria-metrics-operator](https://docs.victoriametrics.com/operator/configuration.html#victoria-metrics-operator).
After finishing with `values.yaml`, you can test the installation with command:
diff --git a/docs/resources/README.md b/docs/resources/README.md
index de7ed812..ee74e24a 100644
--- a/docs/resources/README.md
+++ b/docs/resources/README.md
@@ -9,23 +9,23 @@ title: Custom resources
This documentation section describes the design and interaction between the custom resource definitions (CRD) that the Victoria
Metrics Operator introduces.
-[Operator]((https://docs.victoriametrics.com/vmoperator/)) introduces the
-following [custom resources](https://docs.victoriametrics.com/vmoperator/#custom-resources):
+[Operator]((https://docs.victoriametrics.com/operator/)) introduces the
+following [custom resources](https://docs.victoriametrics.com/operator/#custom-resources):
-- [VMAgent](https://docs.victoriametrics.com/vmoperator/resources/vmagent.html)
-- [VMAlert](https://docs.victoriametrics.com/vmoperator/resources/vmalert.html)
-- [VMAlertManager](https://docs.victoriametrics.com/vmoperator/resources/vmalertmanager.html)
-- [VMAlertManagerConfig](https://docs.victoriametrics.com/vmoperator/resources/vmalertmanagerconfig.html)
-- [VMAuth](https://docs.victoriametrics.com/vmoperator/resources/vmauth.html)
-- [VMCluster](https://docs.victoriametrics.com/vmoperator/resources/vmcluster.html)
-- [VMNodeScrape](https://docs.victoriametrics.com/vmoperator/resources/vmnodescrape.html)
-- [VMPodScrape](https://docs.victoriametrics.com/vmoperator/resources/vmpodscrape.html)
-- [VMProbe](https://docs.victoriametrics.com/vmoperator/resources/vmprobe.html)
-- [VMRule](https://docs.victoriametrics.com/vmoperator/resources/vmrule.html)
-- [VMServiceScrape](https://docs.victoriametrics.com/vmoperator/resources/vmservicescrape.html)
-- [VMStaticScrape](https://docs.victoriametrics.com/vmoperator/resources/vmstaticscrape.html)
-- [VMSingle](https://docs.victoriametrics.com/vmoperator/resources/vmsingle.html)
-- [VMUser](https://docs.victoriametrics.com/vmoperator/resources/vmuser.html)
+- [VMAgent](https://docs.victoriametrics.com/operator/resources/vmagent.html)
+- [VMAlert](https://docs.victoriametrics.com/operator/resources/vmalert.html)
+- [VMAlertManager](https://docs.victoriametrics.com/operator/resources/vmalertmanager.html)
+- [VMAlertManagerConfig](https://docs.victoriametrics.com/operator/resources/vmalertmanagerconfig.html)
+- [VMAuth](https://docs.victoriametrics.com/operator/resources/vmauth.html)
+- [VMCluster](https://docs.victoriametrics.com/operator/resources/vmcluster.html)
+- [VMNodeScrape](https://docs.victoriametrics.com/operator/resources/vmnodescrape.html)
+- [VMPodScrape](https://docs.victoriametrics.com/operator/resources/vmpodscrape.html)
+- [VMProbe](https://docs.victoriametrics.com/operator/resources/vmprobe.html)
+- [VMRule](https://docs.victoriametrics.com/operator/resources/vmrule.html)
+- [VMServiceScrape](https://docs.victoriametrics.com/operator/resources/vmservicescrape.html)
+- [VMStaticScrape](https://docs.victoriametrics.com/operator/resources/vmstaticscrape.html)
+- [VMSingle](https://docs.victoriametrics.com/operator/resources/vmsingle.html)
+- [VMUser](https://docs.victoriametrics.com/operator/resources/vmuser.html)
Here is the scheme of relations between the custom resources:
diff --git a/docs/resources/vmagent.md b/docs/resources/vmagent.md
index f8c19c32..c30295a7 100644
--- a/docs/resources/vmagent.md
+++ b/docs/resources/vmagent.md
@@ -20,7 +20,7 @@ so user can set custom configuration while still benefiting from the Operator's
## Specification
-You can see the full actual specification of the `VMAgent` resource in the [API docs -> VMAgent](https://docs.victoriametrics.com/vmoperator/api.html#vmagent).
+You can see the full actual specification of the `VMAgent` resource in the [API docs -> VMAgent](https://docs.victoriametrics.com/operator/api.html#vmagent).
## High availability
@@ -28,7 +28,7 @@ To run VMAgent in a highly available manner at first you have to configure dedup
according [this doc for VMSingle](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#deduplication)
or [this doc for VMCluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#deduplication).
-You can do it with `extraArgs` on [`VMSingle`](https://docs.victoriametrics.com/vmoperator/resources/vmsingle.html):
+You can do it with `extraArgs` on [`VMSingle`](https://docs.victoriametrics.com/operator/resources/vmsingle.html):
```yaml
apiVersion: operator.victoriametrics.com/v1beta1
@@ -41,7 +41,7 @@ spec:
dedup.minScrapeInterval: 5s
```
-For [`VMCluster`](https://docs.victoriametrics.com/vmoperator/resources/vmcluster.html) you can do it with `vmstorage.extraArgs` and `vmselect.extraArgs`:
+For [`VMCluster`](https://docs.victoriametrics.com/operator/resources/vmcluster.html) you can do it with `vmstorage.extraArgs` and `vmselect.extraArgs`:
```yaml
apiVersion: operator.victoriametrics.com/v1beta1
diff --git a/docs/resources/vmalert.md b/docs/resources/vmalert.md
index f9a63979..bdd14a30 100644
--- a/docs/resources/vmalert.md
+++ b/docs/resources/vmalert.md
@@ -24,7 +24,7 @@ spec:
## Specification
-You can see the full actual specification of the `VMAlert` resource in the [API docs -> VMAlert](https://docs.victoriametrics.com/vmoperator/api.html#vmalert).
+You can see the full actual specification of the `VMAlert` resource in the [API docs -> VMAlert](https://docs.victoriametrics.com/operator/api.html#vmalert).
## High availability
diff --git a/docs/resources/vmalertmanager.md b/docs/resources/vmalertmanager.md
index 3ce64a42..23db95f5 100644
--- a/docs/resources/vmalertmanager.md
+++ b/docs/resources/vmalertmanager.md
@@ -11,7 +11,7 @@ When there are two or more configured replicas the Operator runs the Alertmanage
## Specification
-You can see the full actual specification of the `VMAlertmanager` resource in the [API docs -> VMAlert](https://docs.victoriametrics.com/vmoperator/api.html#vmalertmanager).
+You can see the full actual specification of the `VMAlertmanager` resource in the [API docs -> VMAlert](https://docs.victoriametrics.com/operator/api.html#vmalertmanager).
## High Availability
diff --git a/docs/resources/vmalertmanagerconfig.md b/docs/resources/vmalertmanagerconfig.md
index dad50cba..3fd18d8e 100644
--- a/docs/resources/vmalertmanagerconfig.md
+++ b/docs/resources/vmalertmanagerconfig.md
@@ -6,6 +6,6 @@ which will be merged by operator into config. It behaves like other config parts
## Specification
You can see the full actual specification of the `VMAlertmanagerConfig` resource in
-the [API docs -> VMAlertmanagerConfig](https://docs.victoriametrics.com/vmoperator/api.html#vmalertmanagerconfig).
+the [API docs -> VMAlertmanagerConfig](https://docs.victoriametrics.com/operator/api.html#vmalertmanagerconfig).
**TODO**
diff --git a/docs/resources/vmauth.md b/docs/resources/vmauth.md
index 8efa63b2..94377f9e 100644
--- a/docs/resources/vmauth.md
+++ b/docs/resources/vmauth.md
@@ -7,6 +7,6 @@ So it will be possible to access these credentials from any application by targe
## Specification
You can see the full actual specification of the `VMAuth` resource in
-the [API docs -> VMAuth](https://docs.victoriametrics.com/vmoperator/api.html#vmauth).
+the [API docs -> VMAuth](https://docs.victoriametrics.com/operator/api.html#vmauth).
**TODO**
diff --git a/docs/resources/vmcluster.md b/docs/resources/vmcluster.md
index 8e03ef33..689da79f 100644
--- a/docs/resources/vmcluster.md
+++ b/docs/resources/vmcluster.md
@@ -25,7 +25,7 @@ The most important is `VM_PODWAITREADYTIMEOUT=80s` - it controls how long to wai
## Specification
-You can see the full actual specification of the `VMCluster` resource in the [API docs -> VMCluster](https://docs.victoriametrics.com/vmoperator/api.html#vmcluster).
+You can see the full actual specification of the `VMCluster` resource in the [API docs -> VMCluster](https://docs.victoriametrics.com/operator/api.html#vmcluster).
## High availability
diff --git a/docs/resources/vmnodescrape.md b/docs/resources/vmnodescrape.md
index 7574739b..669b7e76 100644
--- a/docs/resources/vmnodescrape.md
+++ b/docs/resources/vmnodescrape.md
@@ -8,6 +8,6 @@ See more details about selectors [here](https://docs.victoriametrics.com/operato
## Specification
You can see the full actual specification of the `VMNodeScrape` resource in
-the [API docs -> VMNodeScrape](https://docs.victoriametrics.com/vmoperator/api.html#vmnodescrape).
+the [API docs -> VMNodeScrape](https://docs.victoriametrics.com/operator/api.html#vmnodescrape).
**TODO**
diff --git a/docs/resources/vmpodscrape.md b/docs/resources/vmpodscrape.md
index 8892aad2..ce030dbd 100644
--- a/docs/resources/vmpodscrape.md
+++ b/docs/resources/vmpodscrape.md
@@ -26,7 +26,7 @@ spec:
## Specification
You can see the full actual specification of the `VMPodScrape` resource in
-the [API docs -> VMPodScrape](https://docs.victoriametrics.com/vmoperator/api.html#vmpodscrape).
+the [API docs -> VMPodScrape](https://docs.victoriametrics.com/operator/api.html#vmpodscrape).
**TODO**
diff --git a/docs/resources/vmprobe.md b/docs/resources/vmprobe.md
index 4aa2d2e0..e5a57292 100644
--- a/docs/resources/vmprobe.md
+++ b/docs/resources/vmprobe.md
@@ -10,6 +10,6 @@ See more details about selectors [here](https://docs.victoriametrics.com/operato
## Specification
You can see the full actual specification of the `VMProbe` resource in
-the [API docs -> VMProbe](https://docs.victoriametrics.com/vmoperator/api.html#vmprobe).
+the [API docs -> VMProbe](https://docs.victoriametrics.com/operator/api.html#vmprobe).
**TODO**
diff --git a/docs/resources/vmrule.md b/docs/resources/vmrule.md
index 04b49e19..5318cefa 100644
--- a/docs/resources/vmrule.md
+++ b/docs/resources/vmrule.md
@@ -7,6 +7,6 @@ Alerts and recording rules can be saved and applied as YAML files, and dynamical
## Specification
You can see the full actual specification of the `VMRule` resource in
-the [API docs -> VMRule](https://docs.victoriametrics.com/vmoperator/api.html#vmrule).
+the [API docs -> VMRule](https://docs.victoriametrics.com/operator/api.html#vmrule).
**TODO**
diff --git a/docs/resources/vmservicescrape.md b/docs/resources/vmservicescrape.md
index a7676e8d..3b9e7843 100644
--- a/docs/resources/vmservicescrape.md
+++ b/docs/resources/vmservicescrape.md
@@ -37,6 +37,6 @@ spec:
## Specification
You can see the full actual specification of the `VMServiceScrape` resource in
-the [API docs -> VMServiceScrape](https://docs.victoriametrics.com/vmoperator/api.html#vmservicescrape).
+the [API docs -> VMServiceScrape](https://docs.victoriametrics.com/operator/api.html#vmservicescrape).
**TODO**
diff --git a/docs/resources/vmsingle.md b/docs/resources/vmsingle.md
index 1bd9dab3..bfb33649 100644
--- a/docs/resources/vmsingle.md
+++ b/docs/resources/vmsingle.md
@@ -12,12 +12,12 @@ For each `VMSingle` resource, the Operator adds `Service` and `VMServiceScrape`
## Specification
-You can see the full actual specification of the `VMSingle` resource in the [API docs -> VMSingle](https://docs.victoriametrics.com/vmoperator/api.html#vmsingle).
+You can see the full actual specification of the `VMSingle` resource in the [API docs -> VMSingle](https://docs.victoriametrics.com/operator/api.html#vmsingle).
## High availability
`VMSingle` doesn't support high availability by default, for such purpose
-use [`VMCluster`](https://docs.victoriametrics.com/vmoperator/resources/vmcluster.html) instead or duplicate the setup.
+use [`VMCluster`](https://docs.victoriametrics.com/operator/resources/vmcluster.html) instead or duplicate the setup.
## Version
diff --git a/docs/resources/vmstaticscrape.md b/docs/resources/vmstaticscrape.md
index f54f7c12..1a68cab2 100644
--- a/docs/resources/vmstaticscrape.md
+++ b/docs/resources/vmstaticscrape.md
@@ -8,6 +8,6 @@ See more details about selectors [here](https://docs.victoriametrics.com/operato
## Specification
You can see the full actual specification of the `VMStaticScrape` resource in
-the [API docs -> VMStaticScrape](https://docs.victoriametrics.com/vmoperator/api.html#vmstaticscrape).
+the [API docs -> VMStaticScrape](https://docs.victoriametrics.com/operator/api.html#vmstaticscrape).
**TODO**
diff --git a/docs/resources/vmuser.md b/docs/resources/vmuser.md
index 441cf25a..0987facb 100644
--- a/docs/resources/vmuser.md
+++ b/docs/resources/vmuser.md
@@ -9,7 +9,7 @@ operator queries kubernetes API, retrieves information about CRD and builds prop
## Specification
You can see the full actual specification of the `VMUser` resource in
-the [API docs -> VMUser](https://docs.victoriametrics.com/vmoperator/api.html#vmuser).
+the [API docs -> VMUser](https://docs.victoriametrics.com/operator/api.html#vmuser).
**TODO**
diff --git a/docs/security.md b/docs/security.md
index 94fd2926..8d7ad587 100644
--- a/docs/security.md
+++ b/docs/security.md
@@ -15,13 +15,13 @@ To run in a cluster the operator needs certain permissions, you can see them in
- [`role.yaml` file](https://github.com/VictoriaMetrics/operator/blob/master/config/rbac/role.yaml) - basic set of cluster roles for launching an operator.
- [`leader_election_role.yaml` file](https://github.com/VictoriaMetrics/operator/blob/master/config/rbac/leader_election_role.yaml) - set of roles with permissions to do leader election (is necessary to run the operator in several replicas for high availability).
-Also in [the same directory](https://github.com/VictoriaMetrics/operator/tree/master/config/rbac) are files with a set of separate permissions to view or edit [operator resources](https://docs.victoriametrics.com/vmoperator/resources/) to organize fine-grained access:
+Also in [the same directory](https://github.com/VictoriaMetrics/operator/tree/master/config/rbac) are files with a set of separate permissions to view or edit [operator resources](https://docs.victoriametrics.com/operator/resources/) to organize fine-grained access:
- file `_viewer_role.yaml` - permissions for viewing (`get`, `list` and `watch`) some resource of vmoperator.
- file `_editor_role.yaml` - permissions for editing (`create`, `delete`, `patch`, `update` and `deletecollection`) some resource of vmoperator (also includes viewing permissions).
For instance, [`vmalert_editor_role.yaml` file](https://github.com/VictoriaMetrics/operator/blob/master/config/rbac/vmalert_editor_role.yaml) contain permission
-for editing [`vmagent` custom resources](https://docs.victoriametrics.com/vmoperator/resources/vmagent.html).
+for editing [`vmagent` custom resources](https://docs.victoriametrics.com/operator/resources/vmagent.html).
**TODO**
diff --git a/docs/setup.md b/docs/setup.md
index fe754c9e..69c9dc81 100644
--- a/docs/setup.md
+++ b/docs/setup.md
@@ -111,4 +111,4 @@ There is no need in an additional configuration for ARM. Operator and VictoriaMe
## Configuring
-You can read detailed instructions about operator configuring in [this document](http://docs.victoriametrics.com/vmoperator/configuration.html).
+You can read detailed instructions about operator configuring in [this document](http://docs.victoriametrics.com/operator/configuration.html).