From 134dcaef3305f7784292454c92ea707096e2322f Mon Sep 17 00:00:00 2001 From: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com> Date: Tue, 7 May 2024 22:51:39 +0800 Subject: [PATCH] Automatic update operator docs from VictoriaMetrics/operator@6271553 (#6233) --- docs/operator/CHANGELOG.md | 1 + docs/operator/api.md | 5 +++++ docs/operator/vars.md | 2 +- 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/operator/CHANGELOG.md b/docs/operator/CHANGELOG.md index 3766393fa..46413f4f6 100644 --- a/docs/operator/CHANGELOG.md +++ b/docs/operator/CHANGELOG.md @@ -16,6 +16,7 @@ aliases: ## Next release +- [operator](./README.md): adds `spec.pause` field to `VMAgent`, `VMAlert`, `VMAuth`, `VMCluster`, `VMAlertmanager` and `VMSingle`. It allows to suspend object reconcile by operator. See this [issue](https://github.com/VictoriaMetrics/operator/issues/943) for details. Thanks @just1900 - [vmagent](./api.md#vmagent): set `status.selector` field. It allows correctly use `VPA` with `vmagent`. See this [issue](https://github.com/VictoriaMetrics/operator/issues/693) for details. - [prometheus-converter](./README.md): fixes bug with prometheus-operator ScrapeConfig converter. Only copy `spec` field for it. See this [issue](https://github.com/VictoriaMetrics/operator/issues/942) for details. diff --git a/docs/operator/api.md b/docs/operator/api.md index c470b0c9d..89e31f57e 100644 --- a/docs/operator/api.md +++ b/docs/operator/api.md @@ -925,6 +925,7 @@ VMAgentSpec defines the desired state of VMAgent | useStrictSecurity | UseStrictSecurity enables strict security mode for component it restricts disk writes access uses non-root user out of the box drops not needed security permissions | *bool | false | | ingestOnlyMode | IngestOnlyMode switches vmagent into unmanaged mode it disables any config generation for scraping Currently it prevents vmagent from managing tls and auth options for remote write | bool | false | | license | License allows to configure license key to be used for enterprise features. Using license key is supported starting from VictoriaMetrics v1.94.0. See: https://docs.victoriametrics.com/enterprise.html | *[License](#license) | false | +| paused | Paused If set to true all actions on the underlaying managed objects are not going to be performed, except for delete actions. | bool | false | [Back to TOC](#table-of-contents) @@ -1297,6 +1298,7 @@ VMAlertSpec defines the desired state of VMAlert | readinessGates | ReadinessGates defines pod readiness gates | []v1.PodReadinessGate | false | | useStrictSecurity | UseStrictSecurity enables strict security mode for component it restricts disk writes access uses non-root user out of the box drops not needed security permissions | *bool | false | | license | License allows to configure license key to be used for enterprise features. Using license key is supported starting from VictoriaMetrics v1.94.0. See: https://docs.victoriametrics.com/enterprise.html | *[License](#license) | false | +| paused | Paused If set to true all actions on the underlaying managed objects are not going to be performed, except for delete actions. | bool | false | [Back to TOC](#table-of-contents) @@ -1391,6 +1393,7 @@ VMSingleSpec defines the desired state of VMSingle | readinessGates | ReadinessGates defines pod readiness gates | []v1.PodReadinessGate | false | | streamAggrConfig | StreamAggrConfig defines stream aggregation configuration for VMSingle | *[StreamAggrConfig](#streamaggrconfig) | false | | useStrictSecurity | UseStrictSecurity enables strict security mode for component it restricts disk writes access uses non-root user out of the box drops not needed security permissions | *bool | false | +| paused | Paused If set to true all actions on the underlaying managed objects are not going to be performed, except for delete actions. | bool | false | [Back to TOC](#table-of-contents) @@ -1877,6 +1880,7 @@ VMClusterSpec defines the desired state of VMCluster | vmselect | | *[VMSelect](#vmselect) | false | | vminsert | | *[VMInsert](#vminsert) | false | | vmstorage | | *[VMStorage](#vmstorage) | false | +| paused | Paused If set to true all actions on the underlaying managed objects are not going to be performed, except for delete actions. | bool | false | | useStrictSecurity | UseStrictSecurity enables strict security mode for component it restricts disk writes access uses non-root user out of the box drops not needed security permissions | *bool | false | [Back to TOC](#table-of-contents) @@ -2338,6 +2342,7 @@ VMAuthSpec defines the desired state of VMAuth | useStrictSecurity | UseStrictSecurity enables strict security mode for component it restricts disk writes access uses non-root user out of the box drops not needed security permissions | *bool | false | | license | License allows to configure license key to be used for enterprise features. Using license key is supported starting from VictoriaMetrics v1.94.0. See: https://docs.victoriametrics.com/enterprise.html | *[License](#license) | false | | configSecret | ConfigSecret is the name of a Kubernetes Secret in the same namespace as the VMAuth object, which contains auth configuration for vmauth, configuration must be inside secret key: config.yaml. It must be created and managed manually. If it's defined, configuration for vmauth becomes unmanaged and operator'll not create any related secrets/config-reloaders | string | false | +| paused | Paused If set to true all actions on the underlaying managed objects are not going to be performed, except for delete actions. | bool | false | [Back to TOC](#table-of-contents) diff --git a/docs/operator/vars.md b/docs/operator/vars.md index 8598de344..1098adccd 100644 --- a/docs/operator/vars.md +++ b/docs/operator/vars.md @@ -10,7 +10,7 @@ menu: # Auto Generated vars for package config - updated at Sat Apr 27 19:49:28 UTC 2024 + updated at Tue May 7 13:36:05 UTC 2024 | varible name | variable default value | variable required | variable description |