Automatic update operator docs from VictoriaMetrics/operator@9fb79f4 (#5124)

This commit is contained in:
Github Actions 2023-10-04 23:03:50 +08:00 committed by Aliaksandr Valialkin
parent e275be05b0
commit e20f969ed3
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1
29 changed files with 28 additions and 203 deletions

View File

@ -2,11 +2,6 @@
sort: 10
weight: 10
title: CHANGELOG
menu:
docs:
parent: "operator"
weight: 10
identifier: "operator-changelog"
---
# CHANGELOG
@ -16,12 +11,17 @@ menu:
### Features
- [vmoperator](./README.md): upgrade vmagent/vmauth's default config-reloader image.
- [vmuser](./api.md#vmuser): adds `retry_status_codes` , `max_concurrent_requests` and `response_headers` settings. It's supported since `v1.94.0` release of [vmauth](https://docs.victoriametrics.com/vmauth.html)
- [vmoperator](./README.md): adds `useStrictSecurity` for all components. It allows to migrate from insecure to strictly secured deployments per component without breaking changes. See [this issue](https://github.com/VictoriaMetrics/operator/issues/762#issuecomment-1735061532) for details.
### Fixes
- [vmcluster](./api.html#vmcluster): remove redundant annotation `operator.victoriametrics/last-applied-spec` from created workloads like vmstorage statefulset.
- [vmoperator](./README.md): properly resize statefulset's multiple pvc when needed and allowable, before they could be updated with wrong size.
- [vmoperator](./README.md): fix wrong api group of endpointsices, before vmagent won't able to access endpointsices resources with default rbac rule.
- [vmauth/vmagent](./README.md): adds default resources for init container with configuration download. See [this issue](https://github.com/VictoriaMetrics/operator/issues/767) for details.
- [vmauth/vmagent](./README.md): correctly set flag for custom config reloader image during config initialisation. See [this issue](https://github.com/VictoriaMetrics/operator/issues/770) for details.
- [vmauth](./api.md#vmauth): correctly set config reloader image for init container.
<a name="v0.38.0"></a>
## [v0.38.0](https://github.com/VictoriaMetrics/operator/releases/tag/v0.38.0) - 11 Sep 2023

View File

@ -2,11 +2,6 @@
sort: 9
weight: 9
title: FAQ
menu:
docs:
parent: "operator"
weight: 9
identifier: "operator-faq"
---
# FAQ (Frequency Asked Questions)

View File

@ -2,10 +2,6 @@
sort: 0
weight: 0
title: VictoriaMetrics Operator
menu:
docs:
parent: "operator"
weight: 0
---
# VictoriaMetrics Operator

View File

@ -2,10 +2,6 @@
sort: 12
weight: 12
title: API Docs
menu:
docs:
parent: "operator"
weight: 12
---
<!-- this doc autogenerated - don't edit it manually -->
@ -227,6 +223,7 @@ VMAlertmanagerSpec is a specification of the desired behavior of the VMAlertmana
| terminationGracePeriodSeconds | TerminationGracePeriodSeconds period for container graceful termination | *int64 | false |
| readinessGates | ReadinessGates defines pod readiness gates | []v1.PodReadinessGate | false |
| claimTemplates | ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet | [][v1.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#persistentvolumeclaim-v1-core) | 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)
@ -805,6 +802,7 @@ VMAgentSpec defines the desired state of VMAgent
| statefulRollingUpdateStrategy | StatefulRollingUpdateStrategy allows configuration for strategyType set it to RollingUpdate for disabling operator statefulSet rollingUpdate | [appsv1.StatefulSetUpdateStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#statefulsetupdatestrategy-v1-apps) | false |
| readinessGates | ReadinessGates defines pod readiness gates | []v1.PodReadinessGate | false |
| claimTemplates | ClaimTemplates allows adding additional VolumeClaimTemplates for VMAgent in StatefulMode | [][v1.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#persistentvolumeclaim-v1-core) | 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)
@ -1158,6 +1156,7 @@ VMAlertSpec defines the desired state of VMAlert
| terminationGracePeriodSeconds | TerminationGracePeriodSeconds period for container graceful termination | *int64 | false |
| dnsConfig | Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. | *v1.PodDNSConfig | false |
| 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 |
[Back to TOC](#table-of-contents)
@ -1248,6 +1247,7 @@ VMSingleSpec defines the desired state of VMSingle
| terminationGracePeriodSeconds | TerminationGracePeriodSeconds period for container graceful termination | *int64 | false |
| 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 |
[Back to TOC](#table-of-contents)
@ -1728,6 +1728,7 @@ VMClusterSpec defines the desired state of VMCluster
| vmselect | | *[VMSelect](#vmselect) | false |
| vminsert | | *[VMInsert](#vminsert) | false |
| vmstorage | | *[VMStorage](#vmstorage) | 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)
@ -2007,6 +2008,8 @@ TargetRef describes target for user traffic forwarding. one of target types can
| paths | Paths - matched path to route. | []string | false |
| target_path_suffix | QueryParams []string `json:\&#34;queryParams,omitempty\&#34;` TargetPathSuffix allows to add some suffix to the target path It allows to hide tenant configuration from user with crd as ref. it also may contain any url encoded params. | string | false |
| headers | Headers represent additional http headers, that vmauth uses in form of [\&#34;header_key: header_value\&#34;] multiple values for header key: [\&#34;header_key: value1,value2\&#34;] it&#39;s available since 1.68.0 version of vmauth | []string | false |
| response_headers | ResponseHeaders represent additional http headers, that vmauth adds for request response in form of [\&#34;header_key: header_value\&#34;] multiple values for header key: [\&#34;header_key: value1,value2\&#34;] it&#39;s available since 1.93.0 version of vmauth | []string | false |
| retry_status_codes | RetryStatusCodes defines http status codes in numeric format for request retries Can be defined per target or at VMUser.spec level e.g. [429,503] | []int | false |
[Back to TOC](#table-of-contents)
@ -2060,6 +2063,11 @@ VMUserSpec defines the desired state of VMUser
| targetRefs | TargetRefs - reference to endpoints, which user may access. | [][TargetRef](#targetref) | true |
| default_url | DefaultURLs backend url for non-matching paths filter usually used for default backend with error message | []string | false |
| ip_filters | IPFilters defines per target src ip filters supported only with enterprise version of vmauth https://docs.victoriametrics.com/vmauth.html#ip-filters | [VMUserIPFilters](#vmuseripfilters) | false |
| headers | Headers represent additional http headers, that vmauth uses in form of [\&#34;header_key: header_value\&#34;] multiple values for header key: [\&#34;header_key: value1,value2\&#34;] it&#39;s available since 1.68.0 version of vmauth | []string | false |
| response_headers | ResponseHeaders represent additional http headers, that vmauth adds for request response in form of [\&#34;header_key: header_value\&#34;] multiple values for header key: [\&#34;header_key: value1,value2\&#34;] it&#39;s available since 1.93.0 version of vmauth | []string | false |
| retry_status_codes | RetryStatusCodes defines http status codes in numeric format for request retries e.g. [429,503] | []int | false |
| max_concurrent_requests | MaxConcurrentRequests defines max concurrent requests per user 300 is default value for vmauth | *int | false |
| disable_secret_creation | DisableSecretCreation skips related secret creation for vmuser | bool | false |
[Back to TOC](#table-of-contents)
@ -2153,6 +2161,7 @@ VMAuthSpec defines the desired state of VMAuth
| terminationGracePeriodSeconds | TerminationGracePeriodSeconds period for container graceful termination | *int64 | false |
| readinessGates | ReadinessGates defines pod readiness gates | []v1.PodReadinessGate | false |
| unauthorizedAccessConfig | UnauthorizedAccessConfig configures access for un authorized users | [][VMAuthUnauthorizedPath](#vmauthunauthorizedpath) | 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)

View File

@ -2,10 +2,6 @@
sort: 7
weight: 7
title: Authorization and exposing components
menu:
docs:
parent: "operator"
weight: 7
---
# Authorization and exposing components

View File

@ -2,10 +2,6 @@
sort: 4
weight: 4
title: Configuration
menu:
docs:
parent: "operator"
weight: 4
---
# Configuration

View File

@ -2,10 +2,6 @@
sort: 13
weight: 13
title: Enterprise features
menu:
docs:
parent: "operator"
weight: 13
---
# Using operator with enterprise features

View File

@ -2,10 +2,6 @@
sort: 8
weight: 8
title: High Availability
menu:
docs:
parent: "operator"
weight: 8
---
# High Availability

View File

@ -2,10 +2,6 @@
sort: 5
weight: 5
title: Migration from Prometheus
menu:
docs:
parent: "operator"
weight: 5
---
# Migration from prometheus-operator

View File

@ -2,10 +2,6 @@
sort: 6
weight: 6
title: Monitoring
menu:
docs:
parent: "operator"
weight: 6
---
# Monitoring of VictoriaMetrics Operator

View File

@ -2,10 +2,6 @@
sort: 1
weight: 1
title: QuickStart
menu:
docs:
parent: "operator"
weight: 1
---
# VictoriaMetrics Operator QuickStart

View File

@ -2,11 +2,6 @@
sort: 14
weight: 14
title: Custom resources
menu:
docs:
identifier: operator-custom-resources
parent: "operator"
weight: 14
---
# Custom resource kinds

View File

@ -1,13 +1,3 @@
---
sort: 1
weight: 1
title: VMAgent
menu:
docs:
parent: "operator-custom-resources"
weight: 1
---
# VMAgent
`VMAgent` represents agent, which helps you collect metrics from various sources and stores them in VictoriaMetrics.

View File

@ -1,12 +1,3 @@
---
sort: 2
weight: 2
title: VMAlert
menu:
docs:
parent: "operator-custom-resources"
weight: 2
---
# VMAlert
`VMAlert` - executes a list of given [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/)

View File

@ -1,13 +1,3 @@
---
sort: 3
weight: 3
title: VMAlertmanager
menu:
docs:
parent: "operator-custom-resources"
weight: 3
---
# VMAlertmanager
`VMAlertmanager` - represents [alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) configuration.

View File

@ -1,12 +1,3 @@
---
sort: 4
weight: 4
title: VMAlertmanagerConfig
menu:
docs:
parent: "operator-custom-resources"
weight: 4
---
# VMAlertmanagerConfig
The `VMAlertmanagerConfig` provides way to configure [VMAlertmanager](./vmalertmanager.md)

View File

@ -1,12 +1,3 @@
---
sort: 5
weight: 5
title: VMAuth
menu:
docs:
parent: "operator-custom-resources"
weight: 5
---
# VMAuth
The `VMAuth` CRD provides mechanism for exposing application with authorization to outside world or to other applications inside kubernetes cluster.

View File

@ -1,12 +1,3 @@
---
sort: 6
weight: 6
title: VMCluster
menu:
docs:
parent: "operator-custom-resources"
weight: 6
---
# VMCluster
`VMCluster` represents a high-available and fault-tolerant version of VictoriaMetrics database.

View File

@ -1,12 +1,3 @@
---
sort: 7
weight: 7
title: VMNodeScrape
menu:
docs:
parent: "operator-custom-resources"
weight: 7
---
# VMNodeScrape
The `VMNodeScrape` CRD provides discovery mechanism for scraping metrics kubernetes nodes,

View File

@ -1,12 +1,3 @@
---
sort: 8
weight: 8
title: VMPodScrape
menu:
docs:
parent: "operator-custom-resources"
weight: 8
---
# VMPodScrape
The `VMPodScrape` CRD allows to declaratively define how a dynamic set of pods should be monitored.

View File

@ -1,12 +1,3 @@
---
sort: 9
weight: 9
title: VMProbe
menu:
docs:
parent: "operator-custom-resources"
weight: 9
---
# VMProbe
The `VMProbe` CRD provides probing target ability with some external prober.

View File

@ -1,12 +1,3 @@
---
sort: 10
weight: 10
title: VMRule
menu:
docs:
parent: "operator-custom-resources"
weight: 10
---
# VMRule
`VMRule` represents [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/)

View File

@ -1,12 +1,3 @@
---
sort: 11
weight: 11
title: VMServiceScrape
menu:
docs:
parent: "operator-custom-resources"
weight: 11
---
# VMServiceScrape
The `VMServiceScrape` CRD allows to define a dynamic set of services for monitoring. Services

View File

@ -1,13 +1,3 @@
---
sort: 12
weight: 12
title: VMSingle
menu:
docs:
parent: "operator-custom-resources"
weight: 12
---
# VMSingle
`VMSingle` represents database for storing metrics.

View File

@ -1,13 +1,3 @@
---
sort: 13
weight: 13
title: VMStaticScrape
menu:
docs:
parent: "operator-custom-resources"
weight: 13
---
# VMStaticScrape
The `VMStaticScrape` CRD provides mechanism for scraping metrics from static targets, configured by CRD targets.

View File

@ -1,12 +1,3 @@
---
sort: 14
weight: 14
title: VMUser
menu:
docs:
parent: "operator-custom-resources"
weight: 14
---
# VMUser
The `VMUser` CRD describes user configuration, its authentication methods `basic auth` or `Authorization` header.

View File

@ -2,10 +2,6 @@
sort: 3
weight: 3
title: Security
menu:
docs:
parent: "operator"
weight: 3
---
# Security

View File

@ -2,10 +2,6 @@
sort: 2
weight: 2
title: Setup
menu:
docs:
parent: "operator"
weight: 2
---
# VictoriaMetrics Operator Setup

View File

@ -2,25 +2,21 @@
sort: 11
weight: 11
title: Variables
menu:
docs:
parent: "operator"
weight: 11
---
<!-- this doc autogenerated - don't edit it manually -->
# Auto Generated vars for package config
updated at Mon Oct 2 13:49:40 UTC 2023
updated at Wed Oct 4 14:41:00 UTC 2023
| 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 |
| VM_CUSTOMCONFIGRELOADERIMAGE | victoriametrics/operator:config-reloader-v0.32.0 | false | - |
| VM_CUSTOMCONFIGRELOADERIMAGE | victoriametrics/operator:config-reloader-v0.38.0 | false | - |
| VM_PSPAUTOCREATEENABLED | false | false | - |
| VM_VMALERTDEFAULT_IMAGE | victoriametrics/vmalert | false | - |
| VM_VMALERTDEFAULT_VERSION | v1.93.5 | false | - |
| VM_VMALERTDEFAULT_VERSION | v1.94.0 | false | - |
| VM_VMALERTDEFAULT_PORT | 8080 | false | - |
| VM_VMALERTDEFAULT_USEDEFAULTRESOURCES | true | false | - |
| VM_VMALERTDEFAULT_RESOURCE_LIMIT_MEM | 500Mi | false | - |
@ -31,7 +27,7 @@ menu:
| VM_VMALERTDEFAULT_CONFIGRELOADERMEMORY | 25Mi | false | - |
| VM_VMALERTDEFAULT_CONFIGRELOADIMAGE | jimmidyson/configmap-reload:v0.3.0 | false | - |
| VM_VMAGENTDEFAULT_IMAGE | victoriametrics/vmagent | false | - |
| VM_VMAGENTDEFAULT_VERSION | v1.93.5 | false | - |
| VM_VMAGENTDEFAULT_VERSION | v1.94.0 | false | - |
| VM_VMAGENTDEFAULT_CONFIGRELOADIMAGE | quay.io/prometheus-operator/prometheus-config-reloader:v0.68.0 | false | - |
| VM_VMAGENTDEFAULT_PORT | 8429 | false | - |
| VM_VMAGENTDEFAULT_USEDEFAULTRESOURCES | true | false | - |
@ -42,7 +38,7 @@ menu:
| VM_VMAGENTDEFAULT_CONFIGRELOADERCPU | 100m | false | - |
| VM_VMAGENTDEFAULT_CONFIGRELOADERMEMORY | 25Mi | false | - |
| VM_VMSINGLEDEFAULT_IMAGE | victoriametrics/victoria-metrics | false | - |
| VM_VMSINGLEDEFAULT_VERSION | v1.93.5 | false | - |
| VM_VMSINGLEDEFAULT_VERSION | v1.94.0 | false | - |
| VM_VMSINGLEDEFAULT_PORT | 8429 | false | - |
| VM_VMSINGLEDEFAULT_USEDEFAULTRESOURCES | true | false | - |
| VM_VMSINGLEDEFAULT_RESOURCE_LIMIT_MEM | 1500Mi | false | - |
@ -53,14 +49,14 @@ menu:
| VM_VMSINGLEDEFAULT_CONFIGRELOADERMEMORY | 25Mi | false | - |
| VM_VMCLUSTERDEFAULT_USEDEFAULTRESOURCES | true | false | - |
| VM_VMCLUSTERDEFAULT_VMSELECTDEFAULT_IMAGE | victoriametrics/vmselect | false | - |
| VM_VMCLUSTERDEFAULT_VMSELECTDEFAULT_VERSION | v1.93.5-cluster | false | - |
| VM_VMCLUSTERDEFAULT_VMSELECTDEFAULT_VERSION | v1.94.0-cluster | false | - |
| VM_VMCLUSTERDEFAULT_VMSELECTDEFAULT_PORT | 8481 | false | - |
| VM_VMCLUSTERDEFAULT_VMSELECTDEFAULT_RESOURCE_LIMIT_MEM | 1000Mi | false | - |
| VM_VMCLUSTERDEFAULT_VMSELECTDEFAULT_RESOURCE_LIMIT_CPU | 500m | false | - |
| VM_VMCLUSTERDEFAULT_VMSELECTDEFAULT_RESOURCE_REQUEST_MEM | 500Mi | false | - |
| VM_VMCLUSTERDEFAULT_VMSELECTDEFAULT_RESOURCE_REQUEST_CPU | 100m | false | - |
| VM_VMCLUSTERDEFAULT_VMSTORAGEDEFAULT_IMAGE | victoriametrics/vmstorage | false | - |
| VM_VMCLUSTERDEFAULT_VMSTORAGEDEFAULT_VERSION | v1.93.5-cluster | false | - |
| VM_VMCLUSTERDEFAULT_VMSTORAGEDEFAULT_VERSION | v1.94.0-cluster | false | - |
| VM_VMCLUSTERDEFAULT_VMSTORAGEDEFAULT_VMINSERTPORT | 8400 | false | - |
| VM_VMCLUSTERDEFAULT_VMSTORAGEDEFAULT_VMSELECTPORT | 8401 | false | - |
| VM_VMCLUSTERDEFAULT_VMSTORAGEDEFAULT_PORT | 8482 | false | - |
@ -69,7 +65,7 @@ menu:
| VM_VMCLUSTERDEFAULT_VMSTORAGEDEFAULT_RESOURCE_REQUEST_MEM | 500Mi | false | - |
| VM_VMCLUSTERDEFAULT_VMSTORAGEDEFAULT_RESOURCE_REQUEST_CPU | 250m | false | - |
| VM_VMCLUSTERDEFAULT_VMINSERTDEFAULT_IMAGE | victoriametrics/vminsert | false | - |
| VM_VMCLUSTERDEFAULT_VMINSERTDEFAULT_VERSION | v1.93.5-cluster | false | - |
| VM_VMCLUSTERDEFAULT_VMINSERTDEFAULT_VERSION | v1.94.0-cluster | false | - |
| VM_VMCLUSTERDEFAULT_VMINSERTDEFAULT_PORT | 8480 | false | - |
| VM_VMCLUSTERDEFAULT_VMINSERTDEFAULT_RESOURCE_LIMIT_MEM | 500Mi | false | - |
| VM_VMCLUSTERDEFAULT_VMINSERTDEFAULT_RESOURCE_LIMIT_CPU | 500m | false | - |
@ -88,7 +84,7 @@ menu:
| VM_VMALERTMANAGER_RESOURCE_REQUEST_CPU | 30m | false | - |
| VM_DISABLESELFSERVICESCRAPECREATION | false | false | - |
| VM_VMBACKUP_IMAGE | victoriametrics/vmbackupmanager | false | - |
| VM_VMBACKUP_VERSION | v1.93.5-enterprise | false | - |
| VM_VMBACKUP_VERSION | v1.94.0-enterprise | false | - |
| VM_VMBACKUP_PORT | 8300 | false | - |
| VM_VMBACKUP_USEDEFAULTRESOURCES | true | false | - |
| VM_VMBACKUP_RESOURCE_LIMIT_MEM | 500Mi | false | - |
@ -97,7 +93,7 @@ menu:
| VM_VMBACKUP_RESOURCE_REQUEST_CPU | 150m | false | - |
| VM_VMBACKUP_LOGLEVEL | INFO | false | - |
| VM_VMAUTHDEFAULT_IMAGE | victoriametrics/vmauth | false | - |
| VM_VMAUTHDEFAULT_VERSION | v1.93.5 | false | - |
| VM_VMAUTHDEFAULT_VERSION | v1.94.0 | false | - |
| VM_VMAUTHDEFAULT_CONFIGRELOADIMAGE | quay.io/prometheus-operator/prometheus-config-reloader:v0.68.0 | false | - |
| VM_VMAUTHDEFAULT_PORT | 8427 | false | - |
| VM_VMAUTHDEFAULT_USEDEFAULTRESOURCES | true | false | - |