From a4945c0bf015d73fcf231661738ca5420e83b0d8 Mon Sep 17 00:00:00 2001 From: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com> Date: Thu, 11 Apr 2024 15:15:04 +0800 Subject: [PATCH] Automatic update operator docs from VictoriaMetrics/operator@17082f0 (#6090) --- docs/operator/CHANGELOG.md | 6 ++++-- docs/operator/api.md | 3 ++- docs/operator/resources/vmalert.md | 2 +- docs/operator/vars.md | 2 +- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/operator/CHANGELOG.md b/docs/operator/CHANGELOG.md index 384d28225..422c67d28 100644 --- a/docs/operator/CHANGELOG.md +++ b/docs/operator/CHANGELOG.md @@ -15,10 +15,12 @@ aliases: # CHANGELOG ## Next release -- [operator](./README.md): updates base Docker image and prometheus_client to versions with with CVE fixes - **Update note: [vmcluster](./api.md#vmcluster): remove fields `VMClusterSpec.VMInsert.Name`, `VMClusterSpec.VMStorage.Name`, `VMClusterSpec.VMSelect.Name`, they're marked as deprecated since v0.21.0. See [this pull request](https://github.com/VictoriaMetrics/operator/pull/907).** +- [operator](./README.md): updates base Docker image and prometheus_client to versions with with CVE fixes +- [operator](./README.md): adds reconcile retries on conflict for `Service` reconcilation. See this [issue](https://github.com/VictoriaMetrics/operator/issues/901) for details. +- [operator](./README.md): allows adjust `Service` generated by operator with `useAsDefault` option set to `true` for `serviceSpec` field. See this [issue](https://github.com/VictoriaMetrics/operator/issues/904) for details. +- [vmagent](./api.md#vmagent): change service for `statefulMode` to the `headless` instead of `clusterIP`. See this [issue](https://github.com/VictoriaMetrics/operator/issues/917) for details. - [vmservicescrape&vmpodscrape](./api.md#vmservicescrape): add `attach_metadata` option under VMServiceScrapeSpec&VMPodScrapeSpec, the same way like prometheus serviceMonitor&podMonitor do. See [this issue](https://github.com/VictoriaMetrics/operator/issues/893) for details. - [vmalertmanagerconfig](./api.md#vmalertmanagerconfig): fix struct field tags under `Sigv4Config`. - [vmalertmanager](./api.md#vmalertmanager): bump default alertmanager version to [v0.27.0](https://github.com/prometheus/alertmanager/releases/tag/v0.27.0), which supports new receivers like `msteams_configs`. diff --git a/docs/operator/api.md b/docs/operator/api.md index 4fd1f7c70..36cc7e3ac 100644 --- a/docs/operator/api.md +++ b/docs/operator/api.md @@ -926,10 +926,11 @@ VMAgentStatus defines the observed state of VMAgent ## AdditionalServiceSpec -ServiceSpec defines additional service for CRD with user-defined params. by default, some of fields can be inherited from default service definition for the CRD: labels,selector, ports. if metadata.name is not defined, service will have format {{CRD_TYPE}}-{{CRD_NAME}}-additional-service. +ServiceSpec defines additional service for CRD with user-defined params. by default, some of fields can be inherited from default service definition for the CRD: labels,selector, ports. if metadata.name is not defined, service will have format {{CRD_TYPE}}-{{CRD_NAME}}-additional-service. if UseAsDefault is set to true, changes applied to the main service without additional service creation | Field | Description | Scheme | Required | | ----- | ----------- | ------ | -------- | +| useAsDefault | UseAsDefault applies changes from given service definition to the main object Service Chaning from headless service to clusterIP or loadbalancer may break cross-component communication | bool | false | | metadata | EmbeddedObjectMetadata defines objectMeta for additional service. | [EmbeddedObjectMetadata](#embeddedobjectmetadata) | false | | spec | ServiceSpec describes the attributes that a user creates on a service. More info: https://kubernetes.io/docs/concepts/services-networking/service/ | v1.ServiceSpec | true | diff --git a/docs/operator/resources/vmalert.md b/docs/operator/resources/vmalert.md index 0e43ff494..74ee3320a 100644 --- a/docs/operator/resources/vmalert.md +++ b/docs/operator/resources/vmalert.md @@ -51,7 +51,7 @@ spec: ruleNamespaceSelector: {} ``` -[VMRule](./vmrule.md) objects generate part of `VMAlert` configuration. +[VMRUle](./vmrule.md) objects generate part of `VMAlert` configuration. For filtering rules `VMAlert` uses selectors `ruleNamespaceSelector` and `ruleSelector`. It allows configuring rules access control across namespaces and different environments. diff --git a/docs/operator/vars.md b/docs/operator/vars.md index c491c9145..2b3d56172 100644 --- a/docs/operator/vars.md +++ b/docs/operator/vars.md @@ -10,7 +10,7 @@ menu: # Auto Generated vars for package config - updated at Tue Apr 2 18:31:57 UTC 2024 + updated at Wed Apr 10 20:35:21 UTC 2024 | varible name | variable default value | variable required | variable description |