mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00

Automatic update operator docs from VictoriaMetrics/operator@4774786 (#6617 )

Automated changes by
[create-pull-request](https://github.com/peter-evans/create-pull-request)
GitHub action

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
(cherry picked from commit c688b53f56)

2024-07-10 17:11:15 +02:00

106 KiB

Raw Blame History

sort

weight

title

aliases

CHANGELOG

docs

parent	weight	identifier
operator	10	operator-changelog

/operator/CHANGELOG.html

/operator/changelog.html

CHANGELOG

v0.46.4 - 9 Jul 2024

Breaking changes

Update note 1: for operatorhub based VMAgent deployment serviceAccount vmagent must be removed. It's no longer shipped with bundle. After deletion operator will create new account with needed permissions.
[manifests]: properly add webhook.enable for operatorhub deployments. See this commit 7a460b090dec018ea23ab8d9de414e2f7da1c513 for details.
[manifests]: removes exact user from runAsUser setting. It must be defined at docker image or security profile level. See this commit 1cc4a0e5334f254a771fa06e9c07dfa93fbb734a for details.
operator: switches from distroless to scratch base image. See this commit 768bf76bdd1ce2080c214cf164f95711d836b960 for details.
config-reloader: do not specify command for container. command configured at docker image level. See this commit 2192115488e6f2be16bde7ddd71426e305a16144 for details.

v0.46.3 - 5 Jul 2024

operator: fixes config-reloader image tag name after 0.46.0 release. See this issue for details.
prometheus-converter: fixes panic at PodMonitor convertion with configured tlsConfig. See this issue for details.
api: return back targetPort for VMPodScrape definition. See this issue for details.

v0.46.0 - 3 Jul 2024

Breaking changes

Update note 1: the --metrics-addr command-line flag at operator was deprecated. Use --metrics-bind-address instead.
Update note 2: the --enable-leader-election command-line flag at operator was deprecated. Use --leader-elect instead.
Update note 3: the --http.readyListenAddr command-line flag at operator was deprecated. Use --health-probe-bind-address instead.
Update note 4: multitenant endpoints suffix /insert/multitenant/<suffix> needs to be added in remoteWrite.url if storage supports multitenancy when using remoteWriteSettings.useMultiTenantMode, as upstream vmagent has deprecated -remoteWrite.multitenantURL command-line flag since v1.102.0.

Updates

operator: adds tls flag check for AsURL method. It must allow to use https configuration for VMUser service discovery. See this issue for details.
operator: kubebuilder v2 -> v4 upgrade
operator: operator docker images are now distroless based
operator: upgraded certificates.cert-manager.io/v1alpha2 to certificates.cert-manager.io/v1
operator: code-generator v0.27.11 -> v0.30.0 upgrade
vmalertmanagerconfig: adds missing handleReconcileErr callback to the reconcile loop. It must properly handle errors and deregister objects.
vmrule: sync group attributes eval_offset, eval_delay and eval_alignment from upstream.
operator: fix VM CRs' xxNamespaceSelector and xxSelector options, previously they are inverted. See this issue for details.
vmnodescrape: remove duplicated series_limit and sample_limit fields in generated scrape_config. See this issue.

v0.45.0 - 10 Jun 2024

operator: expose only command-line flags related to the operator. Remove all transitive dependency flags. See this issue for details.
vmalertmanager: ignores content of cr.spec.configSecret if it's name clashes with secret used by operator for storing alertmanager config. See this issue for details.
operator: remove finalizer for child objects with non-empty DeletetionTimestamp. See this issue for details.
operator: skip storageClass check if there is no PVC size change. See this issue for details.
vmauth: fix url when default http port is changed in targetRef. See this issue for details.
vmauth: fix deployment when custom reloader is used. See this pull request.
prometheus-converter: removed dependence on getting the list of API resources for all API groups in the cluster (including those that are not used by the operator). Now API resources are requested only for the required groups (monitoring.coreos.com/*).
alertmanagerconfig-converter: fix alertmanagerconfig converting with receiver opsgenie_configs. See this issue.

v0.44.0 - 9 May 2024

vmagent: adds new fields into streamAggrConfig: dedup_interval, ignore_old_samples, keep_metric_names, no_align_flush_to_interval. It's only possible to use it with v1.100+ version of vmagent. See this issue for details.
operator: use Patch for finalizers set/unset operations. It must fix possible issues with CRD objects mutations. See this issue for details.
operator: adds spec.pause field to VMAgent, VMAlert, VMAuth, VMCluster, VMAlertmanager and VMSingle. It allows to suspend object reconcile by operator. See this issue for details. Thanks @just1900
vmagent: set status.selector field. It allows correctly use VPA with vmagent. See this issue for details.
prometheus-converter: fixes bug with prometheus-operator ScrapeConfig converter. Only copy spec field for it. See this issue for details.
vmscrapeconfig: authorization section in sd configs works properly with empty type field (default value for this field is Bearer).
prometheus-converter: fixes owner reference type on VMScrapeConfig objects
vmauth&vmuser: sync config fields from upstream, e.g., src_query_args, discover_backend_ips.

v0.43.5 - 26 Apr 2024

Update VictoriaMetrics image tags to v1.101.0.

v0.43.4 - 25 Apr 2024

operator: properly set status to expanding for VMCluster during initial creation. Previously, it was always operational.
operator: adds more context to Deployment and Statefulset watch ready functions. Now, it reports state of unhealthy pod. It allows to find issue with it faster.

v0.43.3 - 23 Apr 2024

operator: fix conversion from ServiceMonitor to VMServiceScrape, bearerTokenSecret is dropped mistakenly since v0.43.0. See this issue.
operator: fix selector match for config resources like VMUser, VMRule... , before it could be ignored when update resource labels.

v0.43.2 - 22 Apr 2024

vmagent: fixes bug with ServiceAccount not found with ingestOnlyMode.
vmagent: fixes unknown long flag '--rules-dir' for prometheus-config-reloader.

v0.43.1 - 18 Apr 2024

operator: properly add liveness and readiness probes to config-reloader, if VM_USECUSTOMCONFIGRELOADER=false.

v0.43.0 - 18 Apr 2024

Update note: 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. Update note: PodSecurityPolicy supports was deleted. Operator no long creates PSP related objects since it's no longer supported by Kubernetes actual versions. See this doc for details. Update note: PodDisruptionBudget at betav1 API is no longer supported. Operator uses v1 stable version. See this doc for details. Update note: Alertmanager versions below v0.22.0 are no longer supported. Version must upgraded - manually for resources or use default version bundled with operator config.

operator: properly reconcile ServiceAccount specified for CRDs. Previously operator didn't perform a check for actual owner of ServiceAccount. Now it creates and updates ServiceAccount only if this field is omitted at CRD definition. It fixes possible ownership race conditions.
Update VictoriaMetrics image tags to v1.100.1.
operator: reduce number of watched resources owned by CRDs. Operator no longer watches for Service, Secret, Configmap changes owned by CRD object. It must reduce logging output, CPU and memory usage for operator.
operator: exposes config-reloader-http port with 8435 number for the customer config-reloader containers. Operator may use own config-reloader implementation for VMAuth, VMAlertmanager and VMAgent.
operator: adds new field configReloaderExtraArgs for VMAgent, VMAlert, VMAuth and VMAlertmanager CRDs. It allows to configure config-reloader container.
config-reloader: adds error metrics to the config-reloader container - configreloader_last_reload_successful, configreloader_last_reload_errors_total, configreloader_config_last_reload_total, configreloader_k8s_watch_errors_total, configreloader_secret_content_update_errors_total, configreloader_last_reload_success_timestamp_seconds. See this issue for details.
operator: Changes error handling for reconcile. Operator sends Events into kubernetes API, if any error happened during object reconcile. See this issue for details.
operator: updates base Docker image and prometheus_client to versions with with CVE fixes
operator: adds reconcile retries on conflicts. See this issue for details.
operator: allows adjust Service generated by operator with useAsDefault option set to true for serviceSpec field. See this issue for details.
vmagent: allows to modify serviceName field for vmagent at statefulMode with custom service. See this issue for details. Thanks @yilmazo
vmagent: change service for statefulMode to the headless instead of clusterIP. See this issue for details.
vmservicescrape&vmpodscrape: add attach_metadata option under VMServiceScrapeSpec&VMPodScrapeSpec, the same way like prometheus serviceMonitor&podMonitor do. See this issue for details.
vmagent: allows multi-line regex at relabelConfig. See this docs and this issue for details.
vmalertmanagerconfig: fix struct field tags under Sigv4Config.
vmalertmanagerconfig: adds own config-reloader container. It must improve speed of config updates. See this issue for details.
vmalertmanager: bump default alertmanager version to v0.27.0, which supports new receivers like msteams_configs.
vmalertmanager: supports alertmanager version v0.22.0 or higher. Previous versions are no longer supported and must be upgraded before using new operator release.
vmscrapeconfig: add crd VMScrapeConfig, which can define a scrape config using any of the service discovery options supported in victoriametrics.
vmuser: adds targetRefBasicAuth field targetRef, which allow to configure basic authorization for target_url. See this issue for details. Thanks @mohammadkhavari
vmprobe: add field proxy_url, see this issue for details.
scrape CRDs: add field series_limit, which can be used to limit the number of unique time series a single scrape target can expose.
scrape CRDs: fix scrape_config filed disable_keep_alive, before it's misconfigured as disable_keepalive and won't work.
scrape CRDs: deprecated option relabel_debug and metric_relabel_debug, they were deprecated since v1.85.0.

v0.43. - 12 Mar 2024

vmalert: do not add notifiers.* flags in case notifier.blackhole is provided via spec.extraArgs. See this issue for details.
operator: properly build liveness probe scheme with enabled tls. Previously it has hard-coded HTTP scheme. See this issue for details.
operator: do not perform a PVC size check on StatefulSet with 0 replicas. It allows to creates CRDs with 0 replicas for later conditional resizing.
vmalertmanager: properly print columns at CRD replicaCount and version status fields.

v0.42. - 6 Mar 2024

operator: fixes alertmanager args typo.
prometheus-converter: adds new flag controller.prometheusCRD.resyncPeriod which allows to configure resync period of prometheus CRD objects. See this issue for details.

v0.42. - 5 Mar 2024

operator: properly watch for prometheus CRD objects. See this issue for details.

v0.42.0 - 4 Mar 2024

operator: adds more context to the log messages. It must greatly improve debugging process and log quality.
Update VictoriaMetrics image tags to v1.99.0.
operator: allow multiple comma separated values for WATCH_NAMESPACE param. It adds multiple watch namespace mode without cluster-wide permission. See this issue for details. Need namspace RBAC permissions located at config/examples/operator_rbac_for_single_namespace.yaml
operator: updates runtime dependencies (controller-runtime, controller-gen). See this issue for details.
operator: updates runtime dependencies (controller-runtime, controller-gen). See this issue for details.
operator: adds new status.updateStatus field to the all objects with pods. It helps to track rollout updates properly.
operator: 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.
vmagent: adds flush_on_shutdown to the streamAggrConfig. See this issue for details.
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: use blackhole as default router if not configuration provided instead of dummy webhook. 9ee567ff9bc93f43dfedcf9361be1be54a5e7597
vmalertmanager: properly assign path for templates, if it's configured at config file and defined via spec.templates. 1128fa9e152a52c7a566fe7ac1375fefbfc6b276
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.
vmstorage: properly disable pvc resizing with annotation operator.victoriametrics.com/pvc-allow-volume-expansion. Previously it was checked per pvc, now it's checked at statefulset storage spec. It also, allows to add pvc autoscaler. Related issues https://github.com/VictoriaMetrics/operator/issues/821, https://github.com/VictoriaMetrics/operator/issues/867.

v0.41.2 - 21 Feb 2024

Remove deprecated autoscaling/v2beta1 HPA objects, previously operator still use it for k8s 1.25. See this issue for details.
Update VictoriaMetrics image tags to v1.98.0.

v0.41.1 - 1 Feb 2024

update VictoriaMetrics image tags to v1.97.1.

v0.41.0 - 31 Jan 2024

update VictoriaMetrics image tags to v1.97.0.
vmauth: add new fields for unauthorized_user like src_hosts, headers, retry_status_codes and load_balancing_policy. See vmauth docs for more details.

v0.40.0 - 23 Jan 2024

vmalertmanager: fix VMAlertmanagerConfig discovery according to the docs.
vmoperator: add alerting rules for operator itself. See this issue for details.
vmoperator: add revisionHistoryLimitCount field for victoriametrics workload CRDs. See this issue for details. Thanks @gidesh
vmuser: add new fields to VMUser: drop_src_path_prefix_parts, tls_insecure_skip_verify, metric_labels and load_balancing_policy. See specifications and vmauth docs for more details. Field metric_labels will work only with VMAuth version >= v1.97.0!
vmoperator: add CRD support for discord_configs, msteams_configs, sns_configs and webex_configs receiver types in VMAlertmanagerConfig. See this issue
vmoperator: add MinReadySeconds param for all CRDs. See this issue and this PR.

v0.39.4 - 13 Dec 2023

update VictoriaMetrics image tags to v1.96.0.
vmalertmanagerconfig: add fields entity, actions and update_alerts for opsgenie_configs according to https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config.
vmoperator: remove vmalert notifier null check, since -notifier.url is optional and is needed only if there are alerting rules.

v0.39.3 - 16 Nov 2023

update VictoriaMetrics image tags to v1.95.1.

v0.39.2 - 15 Nov 2023

Features

vmoperator: properly compare difference for statefulSet claimTemplate metadata. See this commit for details.
vmoperator: sort statefulSet pods by id for rolling update order. See this commit for details.
vmoperator: optimize statefulset update logic, that should reduce some unneeded operations. See this PR for details.

v0.39.1 - 1 Nov 2023

vmuser: adds new paths for vminsert/vmselect routing with enabled dynamic discovery feature for VMUser. See this PR for details.
vmcluster: from now on operator passes -replicationFactor (if it set in vmcluster) for vmselect. See this issue.
vmagent: updated dependency for properly parsing chained if expressions in validation webhook.

v0.39.0 - 4 Oct 2023

Features

vmoperator: upgrade vmagent/vmauth's default config-reloader image.
vmuser: adds retry_status_codes , max_concurrent_requests and response_headers settings. It's supported since v1.94.0 release of vmauth
vmoperator: adds useStrictSecurity for all components. It allows to migrate from insecure to strictly secured deployments per component without breaking changes. See this issue for details.
vmoperator: add ability to provide license key for VictoriaMetrics enterprise components. See this doc for the details.

Fixes

vmcluster: remove redundant annotation operator.victoriametrics/last-applied-spec from created workloads like vmstorage statefulset.
vmoperator: properly resize statefulset's multiple pvc when needed and allowable, before they could be updated with wrong size.
vmoperator: fix wrong api group of endpointsices, before vmagent won't able to access endpointsices resources with default rbac rule.
vmauth/vmagent: adds default resources for init container with configuration download. See this issue for details.
vmauth/vmagent: correctly set flag for custom config reloader image during config initialisation. See this issue for details.
vmauth: correctly set config reloader image for init container.

v0.38.0 - 11 Sep 2023

Default version of VictoriaMetrics components: v1.93.4

Fixes

vmuser: [Enterprise] fixes ip_filters indent for url_prefix. Previously it wasn't possible to use ip_filters with multiple target refs
vmoperator: turn off EnableStrictSecurity by default. Before, upgrade operator to v0.36.0+ could fail components with volume attached, see this issue for details.
vmoperator: bump default version of VictoriaMetrics components to 1.93.4.

Features

vmoperator add ability to print default values for all operator variables. See this issue for details.

v0.37.1 - 02 Sep 2023

Default version of VictoriaMetrics components: v1.93.3

Updates

bump default version of Victoria Metrics components to v1.93.3

v0.37.0 - 30 Aug 2023

Fixes

vmagent: fix unmarshalling for streaming aggregation match field.

Features

vmagent: support multiple if conditions for relabeling. See this issue for details.

v0.36.1 - 25 Aug 2023

Fixes

vmselect: fix cache directory when cacheDataPath not specified, before it will use /tmp which is protect by default strict securityContext.

Features

v0.36.0 - 23 Aug 2023

Breaking changes

vmalert: Field OAuth2 was renamed to oauth2 due to compatibility issue. If you defined OAuth2 with below fields in vmalert objects using operator before v0.36.0, these fields must be reapplied with new tag oauth2 after upgrading. See this issue and this PR for details.
- Affected fields:
  - VMAlert.spec.datasource.OAuth2 -> VMAlert.spec.datasource.oauth2,
  - VMAlert.spec.notifier.OAuth2 -> VMAlert.spec.notifier.oauth2,
  - VMAlert.spec.notifiers[].OAuth2 -> VMAlert.spec.notifiers[].oauth2,
  - VMAlert.spec.remoteRead.OAuth2 -> VMAlert.spec.remoteRead.oauth2,
  - VMAlert.spec.remoteWrite.OAuth2 -> VMAlert.spec.remoteWrite.oauth2,
vmalert: Field bearerTokenFilePath was renamed to bearerTokenFile due to compatibility issue. If you defined bearerTokenFilePath with below fields in vmalert objects using operator before v0.36.0, these fields must be reapplied with new tag bearerTokenFile after upgrading. See this issue and this PR for details.
- Affected fields:
  - VMAlert.spec.datasource.bearerTokenFilePath --> VMAlert.spec.datasource.bearerTokenFile,
  - VMAlert.spec.notifier.bearerTokenFilePath --> VMAlert.spec.notifier.bearerTokenFile,
  - VMAlert.spec.notifiers[].bearerTokenFile --> VMAlert.spec.notifiers[].bearerTokenFile,
  - VMAlert.spec.remoteRead.bearerTokenFilePath --> VMAlert.spec.remoteRead.bearerTokenFile,
  - VMAlert.spec.remoteWrite.bearerTokenFilePath --> VMAlert.spec.remoteWrite.bearerTokenFile.

Fixes

operator set resource requests for config-reloader container by default. See this PR for details.
fix attachMetadata value miscovert for scrape objects. See this issue and this PR for details.
fix volumeClaimTemplates change check for objects that generate statefulset, like vmstorage, vmselect. Before, the statefulset won't be recreated if additional claimTemplates object changed. See this issue and this PR for details.
vmalert: fix tlsCAFile argument value generation when using secret or configMap. See this issue and this PR for details.
vmalertmanager: fix default request memory and apply default resources if not set. See this issue and this PR for details.
vmagent: fix missing additional VolumeClaimTemplates when using ClaimTemplates under StatefulMode.

Features

vmagent: add example config for vmagent statefulmode.
vmagent/vmsingle: adapt new features in streaming aggregation:
- support streamAggr.dropInput, see this issue for details;
- support list for match parameter, see this issue for details;
- support staleness_interval, see this issue for details.
vmcluster: add example config for cluster with custom storage claims.
vmrule: support update_entries_limit field in rules, refer to alerting rules. See this PR for details.
vmrule: support keep_firing_for field in rules, refer to alerting rules. See this PR for details.
vmoperator parameters: Add option VM_ENABLESTRICTSECURITY and enable strict security context by default. See this issue, this and this PR for details.
vmoperator parameters: change option VM_PSPAUTOCREATEENABLED default value from true to false cause PodSecurityPolicy already got deprecated since kubernetes v1.25. See this pr for details.

[Changes][v0.36.0]

v0.35.1 - 12 Jul 2023

Fixes

vmagent: fixes regression with remoteWrite authorization (basicAuth/token). When UseCustomConfigReloader option was set, operator incorrectly rendered mounts for vmagent container. https://github.com/VictoriaMetrics/operator/commit/f2b8cf701a33f91cef19848c857fd6efb7db59dd

106 KiB Raw Blame History

CHANGELOG

v0.46.4 - 9 Jul 2024

Breaking changes

v0.46.3 - 5 Jul 2024

v0.46.0 - 3 Jul 2024

Breaking changes

Updates

v0.45.0 - 10 Jun 2024

v0.44.0 - 9 May 2024

v0.43.5 - 26 Apr 2024

v0.43.4 - 25 Apr 2024

v0.43.3 - 23 Apr 2024

v0.43.2 - 22 Apr 2024

v0.43.1 - 18 Apr 2024

v0.43.0 - 18 Apr 2024

v0.43. - 12 Mar 2024

v0.42. - 6 Mar 2024

v0.42. - 5 Mar 2024

v0.42.0 - 4 Mar 2024

v0.41.2 - 21 Feb 2024

v0.41.1 - 1 Feb 2024

v0.41.0 - 31 Jan 2024

v0.40.0 - 23 Jan 2024

v0.39.4 - 13 Dec 2023

v0.39.3 - 16 Nov 2023

v0.39.2 - 15 Nov 2023

Features

v0.39.1 - 1 Nov 2023

v0.39.0 - 4 Oct 2023

Features

Fixes

v0.38.0 - 11 Sep 2023

Fixes

Features

v0.37.1 - 02 Sep 2023

Updates

v0.37.0 - 30 Aug 2023

Fixes

Features

v0.36.1 - 25 Aug 2023

Fixes

Features

v0.36.0 - 23 Aug 2023

Breaking changes

Fixes

Features

v0.35.1 - 12 Jul 2023

Fixes

v0.35.0 - 03 Jul 2023

Fixes

Features

v0.34.1 - 29 May 2023

Fixes

v0.34.0 - 24 May 2023

Breaking changes

Fixes

Features

v0.33.0 - 19 Apr 2023

Fixes

Features

v0.32.1 - 16 Mar 2023

Fixes

v0.32.0 - 15 Mar 2023

Fixes

Features

v0.31.0 - 02 Mar 2023

Fixes

Features

v0.30.4 - 27 Jan 2023

Fixes

Features

v0.30.3 - 16 Jan 2023

Fixes

v0.30.2 - 12 Jan 2023

Upgrade notes

Fixes

v0.30.1 - 09 Jan 2023

Fixes

Features

106 KiB

Raw Blame History