Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-15 08:23:34 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Automatic update operator docs from VictoriaMetrics/operator@45bfa36 (#5373)

Browse Source
This commit is contained in:
Github Actions 2023-11-23 02:24:50 +08:00 committed by Aliaksandr Valialkin
parent 10b4dfbbf9
commit 28df725a37
No known key found for this signature in database
GPG Key ID: 52C003EE2BCDB9EB
5 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/operator/quick-start.md
View File

@ -582,6 +582,7 @@ code vmrule.yaml
with the following content: with the following content:
{% raw %}
```yaml ```yaml
apiVersion: operator.victoriametrics.com/v1beta1 apiVersion: operator.victoriametrics.com/v1beta1
kind: VMRule kind: VMRule
@ -601,6 +602,7 @@ spec:
value: "{{ $value }}" value: "{{ $value }}"
description: 'error reloading vmalert config, reload count for 5 min {{ $value }}' description: 'error reloading vmalert config, reload count for 5 min {{ $value }}'
``` ```
{% endraw %}
After that you can deploy `vmrule` resource to the kubernetes cluster: After that you can deploy `vmrule` resource to the kubernetes cluster:

2
docs/operator/resources/vmalert.md
View File

@ -310,6 +310,7 @@ with [extraArgs](./README.md#extra-arguments)
and specify `tenant` field for groups and specify `tenant` field for groups
in [VMRule](./vmrule.md#enterprise-features): in [VMRule](./vmrule.md#enterprise-features):
{% raw %}
```yaml ```yaml
apiVersion: operator.victoriametrics.com/v1beta1 apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAlert kind: VMAlert
@ -355,6 +356,7 @@ spec:
value: "{{ $value }}" value: "{{ $value }}"
description: 'error reloading vmalert config, reload count for 5 min {{ $value }}' description: 'error reloading vmalert config, reload count for 5 min {{ $value }}'
``` ```
{% endraw %}
## Examples ## Examples

2
docs/operator/resources/vmalertmanager.md
View File

@ -180,6 +180,7 @@ spec:
- `spec.templates` - list of keys in `ConfigMaps`, that contains template files for `alertmanager`, e.g.: - `spec.templates` - list of keys in `ConfigMaps`, that contains template files for `alertmanager`, e.g.:
{% raw %}
```yaml ```yaml
apiVersion: operator.victoriametrics.com/v1beta1 apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAlertmanager kind: VMAlertmanager
@ -204,6 +205,7 @@ spec:
{{- end }} {{- end }}
my-template-2.tmpl: """ my-template-2.tmpl: """
``` ```
{% endraw %}
These templates will be automatically added to `VMAlertmanager` configuration and will be automatically reloaded on changes in source `ConfigMap`. These templates will be automatically added to `VMAlertmanager` configuration and will be automatically reloaded on changes in source `ConfigMap`.
- `spec.configMaps` - list of `ConfigMap` names (in the same namespace) that will be mounted at `VMAlertmanager` - `spec.configMaps` - list of `ConfigMap` names (in the same namespace) that will be mounted at `VMAlertmanager`

4
docs/operator/resources/vmrule.md
View File

@ -44,6 +44,7 @@ you need to **[enable VMAlert Enterprise](./vmalert.md#enterprise-features)**.
After that you can add `tenant` field for groups in `VMRule`: After that you can add `tenant` field for groups in `VMRule`:
{% raw %}
```yaml ```yaml
apiVersion: operator.victoriametrics.com/v1beta1 apiVersion: operator.victoriametrics.com/v1beta1
kind: VMRule kind: VMRule
@ -66,11 +67,13 @@ spec:
value: "{{ $value }}" value: "{{ $value }}"
description: 'error reloading vmalert config, reload count for 5 min {{ $value }}' description: 'error reloading vmalert config, reload count for 5 min {{ $value }}'
``` ```
{% endraw %}
## Examples ## Examples
### Alerting rule ### Alerting rule
{% raw %}
```yaml ```yaml
apiVersion: operator.victoriametrics.com/v1beta1 apiVersion: operator.victoriametrics.com/v1beta1
kind: VMRule kind: VMRule
@ -90,6 +93,7 @@ spec:
value: "{{ $value }}" value: "{{ $value }}"
description: 'error reloading vmalert config, reload count for 5 min {{ $value }}' description: 'error reloading vmalert config, reload count for 5 min {{ $value }}'
``` ```
{% endraw %}
### Recording rule ### Recording rule

2
docs/operator/vars.md
View File

@ -10,7 +10,7 @@ menu:
<!-- this doc autogenerated - don't edit it manually --> <!-- this doc autogenerated - don't edit it manually -->
# Auto Generated vars for package config # Auto Generated vars for package config
updated at Wed Nov 22 11:56:55 UTC 2023 updated at Wed Nov 22 17:02:40 UTC 2023
| varible name | variable default value | variable required | variable description | | varible name | variable default value | variable required | variable description |