From 380a5d2c9fc500610a35d82818d51def893ab85a Mon Sep 17 00:00:00 2001 From: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com> Date: Thu, 5 Oct 2023 00:51:53 +0800 Subject: [PATCH] Automatic update operator docs from VictoriaMetrics/operator@5da4bf6 (#5127) --- docs/operator/CHANGELOG.md | 6 ++++++ docs/operator/api.md | 17 +++++++++++++++++ docs/operator/vars.md | 2 +- 3 files changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/operator/CHANGELOG.md b/docs/operator/CHANGELOG.md index 40e1031273..43bb648bf8 100644 --- a/docs/operator/CHANGELOG.md +++ b/docs/operator/CHANGELOG.md @@ -8,11 +8,17 @@ title: CHANGELOG ## Next release +- TODO + + +## [v0.39.0](https://github.com/VictoriaMetrics/operator/releases/tag/v0.39.0) - 4 Oct 2023 + ### 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. +- [vmoperator](./README.md): add ability to provide license key for VictoriaMetrics enterprise components. See [this doc](https://docs.victoriametrics.com/enterprise.html) for the details. ### Fixes diff --git a/docs/operator/api.md b/docs/operator/api.md index 2f1373b88b..77c77e00b5 100644 --- a/docs/operator/api.md +++ b/docs/operator/api.md @@ -60,6 +60,7 @@ This Document documents the types introduced by the VictoriaMetrics to be consum * [EmbeddedProbes](#embeddedprobes) * [HTTPAuth](#httpauth) * [KeyValue](#keyvalue) +* [License](#license) * [ServiceSpec](#servicespec) * [StorageSpec](#storagespec) * [StreamAggrConfig](#streamaggrconfig) @@ -803,6 +804,7 @@ VMAgentSpec defines the desired state of VMAgent | 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 | +| 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 | [Back to TOC](#table-of-contents) @@ -952,6 +954,17 @@ KeyValue defines a (key, value) tuple. [Back to TOC](#table-of-contents) +## License + +License holds license key for enterprise features. Using license key is supported starting from VictoriaMetrics v1.94.0 See: https://docs.victoriametrics.com/enterprise.html + +| Field | Description | Scheme | Required | +| ----- | ----------- | ------ | -------- | +| key | Enterprise license key. This flag is available only in VictoriaMetrics enterprise. Documentation - https://docs.victoriametrics.com/enterprise.html for more information, visit https://victoriametrics.com/products/enterprise/ . To request a trial license, go to https://victoriametrics.com/products/enterprise/trial/ | *string | false | +| keyRef | KeyRef is reference to secret with license key for enterprise features. | *[v1.SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#secretkeyselector-v1-core) | false | + +[Back to TOC](#table-of-contents) + ## ServiceSpec 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. @@ -1157,6 +1170,7 @@ VMAlertSpec defines the desired state of VMAlert | 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 | +| 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 | [Back to TOC](#table-of-contents) @@ -1236,6 +1250,7 @@ VMSingleSpec defines the desired state of VMSingle | removePvcAfterDelete | RemovePvcAfterDelete - if true, controller adds ownership to pvc and after VMSingle objest deletion - pvc will be garbage collected by controller manager | bool | false | | retentionPeriod | RetentionPeriod for the stored metrics Note VictoriaMetrics has data/ and indexdb/ folders metrics from data/ removed eventually as soon as partition leaves retention period reverse index data at indexdb rotates once at the half of configured retention period https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#retention | string | true | | vmBackup | VMBackup configuration for backup | *[VMBackup](#vmbackup) | 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 | | extraArgs | ExtraArgs that will be passed to VMSingle pod for example remoteWrite.tmpDataPath: /tmp | map[string]string | false | | extraEnvs | ExtraEnvs that will be added to VMSingle pod | [][v1.EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#envvar-v1-core) | false | | serviceSpec | ServiceSpec that will be added to vmsingle service spec | *[ServiceSpec](#servicespec) | false | @@ -1725,6 +1740,7 @@ VMClusterSpec defines the desired state of VMCluster | serviceAccountName | ServiceAccountName is the name of the ServiceAccount to use to run the VMSelect, VMStorage and VMInsert Pods. | string | false | | clusterVersion | ClusterVersion defines default images tag for all components. it can be overwritten with component specific image.tag value. | string | false | | imagePullSecrets | ImagePullSecrets An optional list of references to secrets in the same namespace to use for pulling images from registries see https://kubernetes.io/docs/concepts/containers/images/#referring-to-an-imagepullsecrets-on-a-pod | [][v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#localobjectreference-v1-core) | 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 | | vmselect | | *[VMSelect](#vmselect) | false | | vminsert | | *[VMInsert](#vminsert) | false | | vmstorage | | *[VMStorage](#vmstorage) | false | @@ -2162,6 +2178,7 @@ VMAuthSpec defines the desired state of VMAuth | 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 | +| 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 | [Back to TOC](#table-of-contents) diff --git a/docs/operator/vars.md b/docs/operator/vars.md index b60170e2d4..5ad684b2f1 100644 --- a/docs/operator/vars.md +++ b/docs/operator/vars.md @@ -6,7 +6,7 @@ title: Variables # Auto Generated vars for package config - updated at Wed Oct 4 14:41:00 UTC 2023 + updated at Wed Oct 4 16:46:39 UTC 2023 | varible name | variable default value | variable required | variable description |