Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions packs/victoria-metrics-operator-0.66.2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Victoria Metrics Operator

The [VictoriaMetrics Operator](https://docs.victoriametrics.com/operator/) is a Kubernetes operator that manages VictoriaMetrics monitoring and observability components through Custom Resources (CRs). Instead of hand-writing Deployments and StatefulSets, you declare objects such as `VMSingle`, `VMCluster`, `VMAgent`, `VMAlert`, `VMAuth`, and `VMAlertmanager`, and the operator reconciles them into running workloads. It also converts existing Prometheus Operator objects (`ServiceMonitor`, `PodMonitor`, `PrometheusRule`, and others) into their VictoriaMetrics equivalents, easing migration from a Prometheus-based stack.

This pack installs the operator (app version `v0.73.1`) and its Custom Resource Definitions. It does not deploy any monitoring workloads on its own — you create the VictoriaMetrics CRs after the operator is running.


## Prerequisites

- A running Kubernetes cluster on version `1.25.0` or later.
- Helm-based add-on support in Palette (this is a Helm chart-based pack).
- Sufficient cluster resources for the operator and any VictoriaMetrics components you later create.
- For air-gapped or offline environments, mirror the operator image and every managed-component image the operator may pull. See the [References](#references) for the image list.


## Parameters

The pack is configured under the `charts.victoria-metrics-operator` key. The most commonly adjusted parameters are listed below.

| **Parameter** | **Description** | **Type** | **Default Value** | **Required** |
|---|---|---|---|---|
| `image.repository` | Operator image repository. | String | `victoriametrics/operator` | No |
| `image.tag` | Operator image tag. Overrides `Chart.AppVersion` when set. | String | `""` (uses `v0.73.1`) | No |
| `global.image.registry` | Registry prefix shared across the operator and all managed components. Set this to point every image at a private/mirror registry. | String | `""` | No |
| `replicaCount` | Number of operator replicas. | Int | `1` | No |
| `watchNamespaces` | Namespaces the operator watches. Empty means all namespaces. | Array | `[]` | No |
| `operator.disable_prometheus_converter` | Disables conversion of Prometheus Operator objects into VictoriaMetrics objects. | Bool | `false` | No |
| `admissionWebhooks.enabled` | Enables the validating admission webhook for VictoriaMetrics CRs. | Bool | `true` | No |
| `crds.enabled` | Manages CRD creation through the operator chart. | Bool | `true` | No |
| `env` | Extra operator environment variables, including `VM_*DEFAULT_VERSION` / `VM_*DEFAULT_IMAGE` overrides for managed components. | Array | `[]` | No |

The full parameter reference is available in the [VictoriaMetrics Operator Helm chart documentation](https://docs.victoriametrics.com/helm/victoria-metrics-operator/) and the [operator configuration variables](https://docs.victoriametrics.com/operator/configuration/#environment-variables).


## Upgrade

- CRDs are **not** upgraded automatically by a standard Helm upgrade. This chart provides an optional CRD upgrade job (`crds.upgrade.enabled`) and cleanup job (`crds.cleanup.enabled`); review the [changelog](https://docs.victoriametrics.com/helm/victoria-metrics-operator/changelog/) before upgrading across minor versions.
- Default versions for managed components (for example `VMSingle`, `VMAgent`, `VMCluster`) are compiled into the operator and change with each operator release. After upgrading, newly reconciled or newly created CRs adopt the new defaults unless you pin versions explicitly on the CR or via the operator `env` (for example `VM_VMSINGLEDEFAULT_VERSION`).
- Pin the operator image tag with `image.tag` if you need reproducible, offline-cacheable deployments rather than tracking `Chart.AppVersion`.

> [!CAUTION]
> Upgrades from a manifest-based pack to a Helm chart-based pack might not be compatible.


## Usage

Create a new [add-on cluster profile](https://docs.spectrocloud.com/profiles/cluster-profiles/create-cluster-profiles/create-addon-profile/) and add the **Victoria Metrics Operator** pack. The operator and its CRDs deploy into the `victoria-metrics` namespace.

The operator only manages CRs — it does not stand up a monitoring stack by itself. Add a manifest layer with the VictoriaMetrics objects you want. The example below deploys a single-node VictoriaMetrics instance and a `VMAgent` that scrapes targets and remote-writes to it.

```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMSingle
metadata:
name: example
namespace: victoria-metrics
spec:
retentionPeriod: "1"
removePvcAfterDelete: true
---
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAgent
metadata:
name: example
namespace: victoria-metrics
spec:
selectAllByDefault: true
remoteWrite:
- url: "http://vmsingle-example.victoria-metrics.svc:8429/api/v1/write"
```

To point every image at a private or mirror registry (for example in an air-gapped install), set the shared registry override in the pack YAML:

```yaml
charts:
victoria-metrics-operator:
global:
image:
registry: my-registry.example.com
```

By default the operator converts existing Prometheus Operator objects into VictoriaMetrics objects. Set `operator.disable_prometheus_converter` to `true` if you run Prometheus Operator alongside this pack and do not want that conversion.

> [!CAUTION]
> Deleting a VictoriaMetrics CR removes its managed workloads. Set `removePvcAfterDelete` deliberately — persistent volumes for storage components are retained unless you opt in to their removal.


## References

- [VictoriaMetrics Operator documentation](https://docs.victoriametrics.com/operator/)
- [Operator configuration and environment variables](https://docs.victoriametrics.com/operator/configuration/)
- [VictoriaMetrics Operator Helm chart](https://docs.victoriametrics.com/helm/victoria-metrics-operator/)
- [VictoriaMetrics Operator on GitHub](https://github.com/VictoriaMetrics/operator)
- [Custom Resource API reference](https://docs.victoriametrics.com/operator/api/)
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
*.md.gotmpl
CHANGELOG.md
_changelog.md
_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
dependencies:
- name: crds
repository: ""
version: 0.0.*
digest: sha256:ef27af8da8866ab58edb12bfc594c06908a130d9ea985e42103f9ed7964705ac
generated: "2025-09-27T10:11:08.309685+03:00"
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
annotations:
artifacthub.io/category: monitoring-logging
artifacthub.io/changes: |
- Release CRDs for operator [v0.73.1](https://github.com/VictoriaMetrics/operator/releases/tag/v0.73.1)
artifacthub.io/license: Apache-2.0
artifacthub.io/links: |
- name: Sources
url: https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-operator
- name: Charts repo
url: https://victoriametrics.github.io/helm-charts/
- name: Docs
url: https://docs.victoriametrics.com/operator/
- name: Changelog
url: https://docs.victoriametrics.com/helm/victoria-metrics-operator-crds/changelog/
- name: App Changelog
url: https://docs.victoriametrics.com/operator/changelog/
artifacthub.io/operator: "true"
artifacthub.io/readme: |
# VictoriaMetrics Operator CRDs Helm chart

Chart documentation is available [here](https://docs.victoriametrics.com/helm/victoria-metrics-operator-crds/).
Changelog is [here](https://docs.victoriametrics.com/helm/victoria-metrics-operator-crds/changelog/).
apiVersion: v2
appVersion: v0.73.1
dependencies:
- name: crds
repository: ""
version: 0.0.*
description: VictoriaMetrics Operator CRDs
home: https://github.com/VictoriaMetrics/operator
icon: https://avatars.githubusercontent.com/u/43720803?s=200&v=4
keywords:
- victoriametrics
- operator
- monitoring
- kubernetes
- observability
- tsdb
- metrics
- metricsql
- timeseries
kubeVersion: '>=1.25.0-0'
name: victoria-metrics-operator-crds
sources:
- https://github.com/VictoriaMetrics/helm-charts
- https://github.com/VictoriaMetrics/operator
type: application
version: 0.13.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# VictoriaMetrics Operator CRDs Helm chart

Chart documentation is available [here](https://docs.victoriametrics.com/helm/victoria-metrics-operator-crds/).
Changelog is [here](https://docs.victoriametrics.com/helm/victoria-metrics-operator-crds/changelog/).
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Release notes for version 0.13.1

**Release date:** 08 Jul 2026

![Helm: v3](https://img.shields.io/badge/Helm-v3.14%2B-informational?color=informational&logo=helm&link=https%3A%2F%2Fgithub.com%2Fhelm%2Fhelm%2Freleases%2Ftag%2Fv3.14.0) ![AppVersion: v0.73.1](https://img.shields.io/badge/v0.73.1-success?logo=VictoriaMetrics&labelColor=gray&link=https%3A%2F%2Fdocs.victoriametrics.com%2Foperator%2Fchangelog%2F%23v0731)

- Release CRDs for operator [v0.73.1](https://github.com/VictoriaMetrics/operator/releases/tag/v0.73.1)
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
apiVersion: v2
appVersion: 0.0.0
description: A subchart stores victoriametrics operator CRDs.
name: crds
type: application
version: 0.0.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
build:
list: never
publishResources: false
render: never
sitemap:
disable: true
---
# Subchart for VictoriaMetrics Operator CRDs
Loading
Loading