From 28df725a378560f83162322906f4922451dd3f35 Mon Sep 17 00:00:00 2001 From: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com> Date: Thu, 23 Nov 2023 02:24:50 +0800 Subject: [PATCH] Automatic update operator docs from VictoriaMetrics/operator@45bfa36 (#5373) --- docs/operator/quick-start.md | 2 ++ docs/operator/resources/vmalert.md | 2 ++ docs/operator/resources/vmalertmanager.md | 2 ++ docs/operator/resources/vmrule.md | 4 ++++ docs/operator/vars.md | 2 +- 5 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/operator/quick-start.md b/docs/operator/quick-start.md index f50dc96bc8..9c2b653433 100644 --- a/docs/operator/quick-start.md +++ b/docs/operator/quick-start.md @@ -582,6 +582,7 @@ code vmrule.yaml with the following content: +{% raw %} ```yaml apiVersion: operator.victoriametrics.com/v1beta1 kind: VMRule @@ -601,6 +602,7 @@ spec: value: "{{ $value }}" description: 'error reloading vmalert config, reload count for 5 min {{ $value }}' ``` +{% endraw %} After that you can deploy `vmrule` resource to the kubernetes cluster: diff --git a/docs/operator/resources/vmalert.md b/docs/operator/resources/vmalert.md index 88224d8aff..bc9120cff1 100644 --- a/docs/operator/resources/vmalert.md +++ b/docs/operator/resources/vmalert.md @@ -310,6 +310,7 @@ with [extraArgs](./README.md#extra-arguments) and specify `tenant` field for groups in [VMRule](./vmrule.md#enterprise-features): +{% raw %} ```yaml apiVersion: operator.victoriametrics.com/v1beta1 kind: VMAlert @@ -355,6 +356,7 @@ spec: value: "{{ $value }}" description: 'error reloading vmalert config, reload count for 5 min {{ $value }}' ``` +{% endraw %} ## Examples diff --git a/docs/operator/resources/vmalertmanager.md b/docs/operator/resources/vmalertmanager.md index d325c927d4..c3805c1680 100644 --- a/docs/operator/resources/vmalertmanager.md +++ b/docs/operator/resources/vmalertmanager.md @@ -180,6 +180,7 @@ spec: - `spec.templates` - list of keys in `ConfigMaps`, that contains template files for `alertmanager`, e.g.: + {% raw %} ```yaml apiVersion: operator.victoriametrics.com/v1beta1 kind: VMAlertmanager @@ -204,6 +205,7 @@ spec: {{- end }} my-template-2.tmpl: """ ``` + {% endraw %} 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` diff --git a/docs/operator/resources/vmrule.md b/docs/operator/resources/vmrule.md index 2eff1cb1dd..1dd121bb10 100644 --- a/docs/operator/resources/vmrule.md +++ b/docs/operator/resources/vmrule.md @@ -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`: +{% raw %} ```yaml apiVersion: operator.victoriametrics.com/v1beta1 kind: VMRule @@ -66,11 +67,13 @@ spec: value: "{{ $value }}" description: 'error reloading vmalert config, reload count for 5 min {{ $value }}' ``` +{% endraw %} ## Examples ### Alerting rule +{% raw %} ```yaml apiVersion: operator.victoriametrics.com/v1beta1 kind: VMRule @@ -90,6 +93,7 @@ spec: value: "{{ $value }}" description: 'error reloading vmalert config, reload count for 5 min {{ $value }}' ``` +{% endraw %} ### Recording rule diff --git a/docs/operator/vars.md b/docs/operator/vars.md index 2ef33e0de9..f7acfba491 100644 --- a/docs/operator/vars.md +++ b/docs/operator/vars.md @@ -10,7 +10,7 @@ menu: # 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 |