From ff513b40c0366a365f78bb36f15d18a9cd780cde Mon Sep 17 00:00:00 2001 From: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com> Date: Thu, 6 Jun 2024 10:20:11 +0800 Subject: [PATCH] Automatic update operator docs from VictoriaMetrics/operator@32f7674 (#6414) --- docs/operator/CHANGELOG.md | 28 ++++++++++++++-------------- docs/operator/api.md | 14 +++++++------- docs/operator/enterprise.md | 4 ++-- docs/operator/resources/README.md | 4 ++-- docs/operator/vars.md | 4 ++-- 5 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/operator/CHANGELOG.md b/docs/operator/CHANGELOG.md index 278347742..b8b554b63 100644 --- a/docs/operator/CHANGELOG.md +++ b/docs/operator/CHANGELOG.md @@ -130,7 +130,7 @@ aliases: - [operator](./README.md): adds new `status.updateStatus` field to the all objects with pods. It helps to track rollout updates properly. - [operator](./README.md): adds annotation `operator.victoriametrics/last-applied-spec` to all objects with pods. It helps to track changes and implements proper resource deletion later as part of [issue](https://github.com/VictoriaMetrics/operator/issues/758). - [vmagent](./api.md#vmagent): adds `flush_on_shutdown` to the streamAggrConfig. See this [issue](https://github.com/VictoriaMetrics/operator/issues/860) for details. -- [vmagent](./api.md#vmagent): adds `spec.ingestOnlyMode` experimental field. It switches vmagent into special mode without scrape configuration and config-reloaders. Currently it also disables tls and auth options for remoteWrites, it must be addressed at the next release. +- [vmagent](./api.md#vmagent): adds `spec.ingestOnlyMode` experimental field. It switches vmagent into special mode without scrape configuration and config-reloaders. Currently it also disables tls and auth options for remoteWrites, it must be addressed at the next releaes. - [vmalertmanager](./api.html#vmalertmanager): use `blackhole` as default router if not configuration provided instead of dummy webhook. 9ee567ff9bc93f43dfedcf9361be1be54a5e7597 - [vmalertmanager](./api.html#vmalertmanager): properly assign path for templates, if it's configured at config file and defined via `spec.templates`. 1128fa9e152a52c7a566fe7ac1375fefbfc6b276 - [vmauth](./api.html#vmauth): adds new field `spec.configSecret`, which allows to use vmauth with external configuration stored at secret under `config.yaml` key. Configuration changes can be tracked with extraArgs: `configCheckInterval: 10s` or manually defined config-reloader container. @@ -442,7 +442,7 @@ aliases: ### Fixes - vmalertmanagerconfig: properly build `name` setting for `mute_time_intervals`. It must be uniq https://github.com/VictoriaMetrics/operator/commit/4db1c89abd5360a119e68874d51c27872265acb6 -- vmcluster: add `dedupMinScrape` only if replicationFactor > 1. It must improve overall cluster performance. Thanks [@hagen1778](https://github.com/hagen1778) https://github.com/VictoriaMetrics/operator/commit/837d6e71c6298e5a44c3f73f85235560aec4ee60 +- vmcluster: add `dedupMinScrape` only if replicationFactor > 1. It must improve overall cluster perfomance. Thanks [@hagen1778](https://github.com/hagen1778) https://github.com/VictoriaMetrics/operator/commit/837d6e71c6298e5a44c3f73f85235560aec4ee60 - controllers/vmalert: do not delete annotations from created secret. Thanks [@zoetrope](https://github.com/zoetrope) https://github.com/VictoriaMetrics/operator/pull/588 ### Features @@ -486,12 +486,12 @@ aliases: - dependency: upgrade deps for fs-notify https://github.com/VictoriaMetrics/operator/pull/576 Thanks [@yanggangtony](https://github.com/yanggangtony) - controllers/options: fixes incorrectly used flags at options https://github.com/VictoriaMetrics/operator/commit/eac040c947ab4821bf6eb0eeae22b9b2d02b938c - controllers/self-serviceScrape: prevents matching for auto-created serviceScrapes https://github.com/VictoriaMetrics/operator/issues/578 -- controllers/vmauth: fixes missing owns for serviceScrape https://github.com/VictoriaMetrics/operator/issues/579 +- controllers/vmauth: fixes missing ows for serviceScrape https://github.com/VictoriaMetrics/operator/issues/579 ### Features - adds `/ready` and `/health` api endpoints for probes https://github.com/VictoriaMetrics/operator/commit/b74d103998547fae5e69966bb68eddd08ae1ac00 -- controllers/concurrency: introduce new setting for reconciliation concurrency `controller.maxConcurrentReconciles` https://github.com/VictoriaMetrics/operator/commit/e8bbf9159cd61257d11e515fa77510ab2444a557 https://github.com/VictoriaMetrics/operator/issues/575 +- controllers/concurrency: introduce new setting for reconcilation concurrency `controller.maxConcurrentReconciles` https://github.com/VictoriaMetrics/operator/commit/e8bbf9159cd61257d11e515fa77510ab2444a557 https://github.com/VictoriaMetrics/operator/issues/575 - api/relabelConfig: adds missing `if`, `labels` and `match` actions https://github.com/VictoriaMetrics/operator/commit/93c9e780981ceb6869ee2953056a9bd3b6e6eae7 [Changes][v0.30.1] @@ -564,7 +564,7 @@ aliases: ### Features -* PodDisruptionBudget: adds configurable selectors https://github.com/VictoriaMetrics/operator/commit/4f3f5eaf29ad85c6e9b142be5b05ef57b962fcb6 +* podDistruptionBudget: adds configurable selectors https://github.com/VictoriaMetrics/operator/commit/4f3f5eaf29ad85c6e9b142be5b05ef57b962fcb6 ### New Contributors @@ -730,7 +730,7 @@ aliases: * security: new alpine image with security fixes https://github.com/VictoriaMetrics/operator/commit/c991b5f315ebb3176b98f5cb00c64430efa0d9c1 * alertmanager: metrics endpoint when routePrefix is configured https://github.com/VictoriaMetrics/operator/pull/488 Thanks [@blesswinsamuel](https://github.com/blesswinsamuel) -* alertmanager: Automatically disable high availability mode for 1 replica in https://github.com/VictoriaMetrics/operator/pull/495. Thanks [@hadesy](https://github.com/hadesy) +* alertmanager: Automaticly disable high availability mode for 1 replica in https://github.com/VictoriaMetrics/operator/pull/495. Thanks [@hadesy](https://github.com/hadesy) * vmalertmanager: fix extraArgs, add two dashes https://github.com/VictoriaMetrics/operator/pull/503 Thanks [@flokli](https://github.com/flokli) * vmcluster: disables selectNode arg passing to vmselect with enabled `HPA`. It should prevent vmselect cascade restarts https://github.com/VictoriaMetrics/operator/issues/499 * controllers: changes default rate limiter max delay from 16minutes to 2 minutes. https://github.com/VictoriaMetrics/operator/issues/500 @@ -786,7 +786,7 @@ aliases: - Added `StatefulMode` for `VMAgent` it allows to use `Statefulset` instead of `Deployment` https://github.com/VictoriaMetrics/operator/issues/219 - Added `Validation Webhook` for `VMRule`, it allows check errors at rules https://github.com/VictoriaMetrics/operator/issues/471 - Added additional metrics for operator `operator_log_messages_total`, `operator_controller_objects_count`, `operator_reconcile_throttled_events_total`, `vm_app_version`, `vm_app_uptime_seconds`, `vm_app_start_timestamp` https://github.com/VictoriaMetrics/operator/commit/b941a42fb6fdfd8ea99ff190e822cb9314efb9d0 https://github.com/VictoriaMetrics/operator/commit/b3c7286e7dc737c46c4d33aa203c0b598a5ef187 -- Adds rate limiting for `VMAgent` and `VMAlert` reconciliation https://github.com/VictoriaMetrics/operator/commit/dfb6a14e1193089ba5ab112e0acf4e459aba68b4 +- Adds rate limiting for `VMAgent` and `VMAlert` reconcilation https://github.com/VictoriaMetrics/operator/commit/dfb6a14e1193089ba5ab112e0acf4e459aba68b4 ### New Contributors * [@pavan541cs](https://github.com/pavan541cs) made their first contribution in https://github.com/VictoriaMetrics/operator/pull/473 @@ -803,7 +803,7 @@ aliases: - Finalizers at UrlRelabelConfig and additionalScrapeConfigs https://github.com/VictoriaMetrics/operator/issues/442 - vmagent config update after scrape objects secret data changes https://github.com/VictoriaMetrics/operator/issues/443 - Log typos https://github.com/VictoriaMetrics/operator/issues/459 -- Correctly renders `opsgenie_config` for `VMAlertmanagerConfig` https://github.com/VictoriaMetrics/operator/commit/9128b7f24d5d6d98dcf7abc6f212d57cd39b0e7d thanks [@iyuroch](https://github.com/iyuroch) +- Correctly renders `opsgenia_config` for `VMAlertmanagerConfig` https://github.com/VictoriaMetrics/operator/commit/9128b7f24d5d6d98dcf7abc6f212d57cd39b0e7d thanks [@iyuroch](https://github.com/iyuroch) - Updates basic image with CVE fix https://github.com/VictoriaMetrics/operator/commit/f4a9e530be6d5ebd6e450085ec807117b05e80a8 - Adds missing finalizer for `VMSingle` deployment https://github.com/VictoriaMetrics/operator/commit/06dada488d629d4d321985e80d14ee04e099bdfd thanks [@lujiajing1126](https://github.com/lujiajing1126) - `pager_duty` generation for `VMAlertmanagerConfig` https://github.com/VictoriaMetrics/operator/pull/439/files thanks [@okzheng](https://github.com/okzheng) @@ -890,7 +890,7 @@ aliases: ### Features -- bumps VictoriaMetrics applications versions to the v1.72.0 https://github.com/VictoriaMetrics/operator/commit/de289af8af8472e5299fc6ff6e99749b58012edd +- bumps VictoriaMetrics appllications versions to the v1.72.0 https://github.com/VictoriaMetrics/operator/commit/de289af8af8472e5299fc6ff6e99749b58012edd [Changes][v0.22.1] @@ -1001,7 +1001,7 @@ aliases: ### Fixes - Regression at `VMStaticScrape` - basic auth was incorrectly handled https://github.com/VictoriaMetrics/operator/issues/337 -- Conversion from `PodMonitor` to `VMPodScrape` https://github.com/VictoriaMetrics/operator/issues/335 +- Convesion from `PodMonitor` to `VMPodScrape` https://github.com/VictoriaMetrics/operator/issues/335 [Changes][v0.19.1] @@ -1290,7 +1290,7 @@ aliases: ### Fixes -- Fixes `VMAlert` `rule` arg - it was improperly escaped https://github.com/VictoriaMetrics/operator/commit/870f258b324dbaec1e3d0d8739ff2feffc27bf0a +- Fixes `VMAlert` `rule` arg - it was unproperly escaped https://github.com/VictoriaMetrics/operator/commit/870f258b324dbaec1e3d0d8739ff2feffc27bf0a - Fixes `VMProbes`, now it supports relabeling for static targets https://github.com/VictoriaMetrics/operator/commit/b4db7d5128a22d4979d7284e15576322acbc9b4c - Fixes `VMStaticScrape` - adds `honorLabels` and `honorTimestamps` setting to CRD @@ -1322,7 +1322,7 @@ aliases: ### Features - Added finalizers to objects created by operator. It must fix an issue with resource deletion by controller manager. Note, it requires additional rbac access. https://github.com/VictoriaMetrics/operator/issues/159 https://github.com/VictoriaMetrics/operator/pull/189 -- Added new resource for static targets scrapping - `VMStaticScrape` https://github.com/VictoriaMetrics/operator/issues/155 +- Added new resouce for static targets scrapping - `VMStaticScrape` https://github.com/VictoriaMetrics/operator/issues/155 - Added `unlimited` param for default resources - https://github.com/VictoriaMetrics/operator/issues/181 - Added clusterVersion spec to `VMCluster` it should simplify management https://github.com/VictoriaMetrics/operator/issues/176 @@ -1407,7 +1407,7 @@ aliases: ### Fixes - serverName for tlsConfig https://github.com/VictoriaMetrics/operator/issues/144 -- minScrapeInterval for vmstorage https://github.com/VictoriaMetrics/operator/pull/143 Thanks [@umezawatakeshi](https://github.com/umezawatakeshi) +- minScrapeInterval for vmstorage https://github.com/VictoriaMetrics/operator/pull/143 Thansk [@umezawatakeshi](https://github.com/umezawatakeshi) [Changes][v0.7.2] @@ -1490,7 +1490,7 @@ aliases: - PodSecurityPolicy automatically created for each object, with own ServiceAccount, ClusterRole and ClusterRoleBinding. Its possible to use custom PSP. https://github.com/VictoriaMetrics/operator/issues/109 - Adds `VMAgent` rbac auto-creation. -- Adds ServiceAccount auto-creation. Its possible to use custom ServiceAccount instead of default. +- Adds ServiceAccount auto-creation. Its possible to use custome ServiceAccount instead of default. - Adds `ownerReferences` for converted resources from `Prometheus-operator` CRDs, https://github.com/VictoriaMetrics/operator/pull/105 thanks [@teqwve](https://github.com/teqwve) . - Adds `runtimeClassName`, `schedulerName` for all VictoriaMetrics applications. - Adds `topologySpreadConstraints` for all VictoriaMetrics applications. https://github.com/VictoriaMetrics/operator/issues/107. diff --git a/docs/operator/api.md b/docs/operator/api.md index 2acee2d51..74e43b91c 100644 --- a/docs/operator/api.md +++ b/docs/operator/api.md @@ -220,7 +220,7 @@ VMAlertmanagerSpec is a specification of the desired behavior of the VMAlertmana | volumeMounts | VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the alertmanager container, that are generated as a result of StorageSpec objects. | [][v1.VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#volumemount-v1-core) | false | | externalURL | ExternalURL the VMAlertmanager instances will be available under. This is necessary to generate correct URLs. This is necessary if VMAlertmanager is not served from root of a DNS name. | string | false | | routePrefix | RoutePrefix VMAlertmanager registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with `kubectl proxy`. | 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 | +| paused | Paused If set to true all actions on the underlying managed objects are not going to be performed, except for delete actions. | bool | false | | nodeSelector | NodeSelector Define which Nodes the Pods are scheduled on. | map[string]string | false | | resources | Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | [v1.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core) | false | | affinity | Affinity If specified, the pod's scheduling constraints. | *[v1.Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#affinity-v1-core) | false | @@ -927,7 +927,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 | +| paused | Paused If set to true all actions on the underlying managed objects are not going to be performed, except for delete actions. | bool | false | [Back to TOC](#table-of-contents) @@ -954,7 +954,7 @@ ServiceSpec defines additional service for CRD with user-defined params. by defa | Field | Description | Scheme | Required | | ----- | ----------- | ------ | -------- | -| useAsDefault | UseAsDefault applies changes from given service definition to the main object Service Changing from headless service to clusterIP or load balancer may break cross-component communication | bool | false | +| useAsDefault | UseAsDefault applies changes from given service definition to the main object Service Changing 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 | @@ -1305,7 +1305,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 | +| paused | Paused If set to true all actions on the underlying managed objects are not going to be performed, except for delete actions. | bool | false | [Back to TOC](#table-of-contents) @@ -1400,7 +1400,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 | +| paused | Paused If set to true all actions on the underlying managed objects are not going to be performed, except for delete actions. | bool | false | [Back to TOC](#table-of-contents) @@ -1887,7 +1887,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 | +| paused | Paused If set to true all actions on the underlying 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) @@ -2405,7 +2405,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 | +| paused | Paused If set to true all actions on the underlying 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/enterprise.md b/docs/operator/enterprise.md index 3bcf4e2c0..6875cf4c9 100644 --- a/docs/operator/enterprise.md +++ b/docs/operator/enterprise.md @@ -28,13 +28,13 @@ Operator doesn't have enterprise version for itself, but it supports - [Multiple retentions / Retention filters](./resources/vmcluster.md#retention-filters) - [Advanced per-tenant statistic](./resources/vmcluster.md#advanced-per-tenant-statistic) - [mTLS protection](./resources/vmcluster.md#mtls-protection) - - [Backup automation](./resources/vmcluster.md#backup-automation) + - [Backup atomation](./resources/vmcluster.md#backup-atomation) - [VMRule Enterprise features](./resources/vmrule.md#enterprise-features) - [Multitenancy](./resources/vmrule.md#multitenancy) - [VMSingle Enterprise features](./resources/vmsingle.md#enterprise-features) - [Downsampling](./resources/vmsingle.md#downsampling) - [Retention filters](./resources/vmsingle.md#retention-filters) - - [Backup automation](./resources/vmsingle.md#backup-automation) + - [Backup atomation](./resources/vmsingle.md#backup-atomation) - [VMUser Enterprise features](./resources/vmuser.md#enterprise-features) - [IP Filters](./resources/vmuser.md#ip-filters) diff --git a/docs/operator/resources/README.md b/docs/operator/resources/README.md index ffcf4d554..98e723592 100644 --- a/docs/operator/resources/README.md +++ b/docs/operator/resources/README.md @@ -183,13 +183,13 @@ Operator supports following [Enterprise features for VictoriaMetrics components] - [Multiple retentions / Retention filters](./vmcluster.md#retention-filters) - [Advanced per-tenant statistic](./vmcluster.md#advanced-per-tenant-statistic) - [mTLS protection](./vmcluster.md#mtls-protection) - - [Backup automation](./vmcluster.md#backup-automation) + - [Backup atomation](./vmcluster.md#backup-atomation) - [VMRule Enterprise features](./vmrule.md#enterprise-features) - [Multitenancy](./vmrule.md#multitenancy) - [VMSingle Enterprise features](./vmsingle.md#enterprise-features) - [Downsampling](./vmsingle.md#downsampling) - [Retention filters](./vmsingle.md#retention-filters) - - [Backup automation](./vmsingle.md#backup-automation) + - [Backup atomation](./vmsingle.md#backup-atomation) - [VMUser Enterprise features](./vmuser.md#enterprise-features) - [IP Filters](./vmuser.md#ip-filters) diff --git a/docs/operator/vars.md b/docs/operator/vars.md index 935016d16..205fdf192 100644 --- a/docs/operator/vars.md +++ b/docs/operator/vars.md @@ -10,10 +10,10 @@ menu: # Auto Generated vars for package config - updated at Thu May 30 08:56:34 UTC 2024 + updated at Wed Jun 5 06:58:55 UTC 2024 -| variable name | variable default value | variable required | variable description | +| varible name | variable default value | variable required | variable description | | --- | --- | --- | --- | | VM_USECUSTOMCONFIGRELOADER | false | false | enables custom config reloader for vmauth and vmagent,it should speed-up config reloading process. | | VM_CONTAINERREGISTRY | - | false | container registry name prefix, e.g. docker.io |