VictoriaMetrics Operator CRDs #

Victoria Metrics Operator CRDs

Chart Details #

This chart will do the following:

• Rollout victoria metrics operator CRDs

How to install #

Access a Kubernetes cluster.

Setup chart repository (can be omitted for OCI repositories) #

Add a chart helm repository with follow commands:

helm repo add vm https://victoriametrics.github.io/helm-charts/

helm repo update

List versions of vm/victoria-metrics-operator-crds chart available to installation:

helm search repo vm/victoria-metrics-operator-crds -l

Install victoria-metrics-operator-crds chart #

Export default values of victoria-metrics-operator-crds chart to file values.yaml:

• For HTTPS repository

  helm show values vm/victoria-metrics-operator-crds > values.yaml
  

• For OCI repository

  helm show values oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-operator-crds > values.yaml
  

Change the values according to the need of the environment in values.yaml file.

Test the installation with command:

• For HTTPS repository

  helm install vmoc vm/victoria-metrics-operator-crds -f values.yaml -n NAMESPACE --debug --dry-run
  

• For OCI repository

  helm install vmoc oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-operator-crds -f values.yaml -n NAMESPACE --debug --dry-run
  

Install chart with command:

• For HTTPS repository

  helm install vmoc vm/victoria-metrics-operator-crds -f values.yaml -n NAMESPACE
  

• For OCI repository

  helm install vmoc oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-operator-crds -f values.yaml -n NAMESPACE
  

Get the pods lists by running this commands:

kubectl get pods -A | grep 'vmoc'

Get the application by running this command:

helm list -f vmoc -n NAMESPACE

See the history of versions of vmoc application with command.

helm history vmoc -n NAMESPACE

How to uninstall #

Remove application with command.

helm uninstall vmoc -n NAMESPACE

Documentation of Helm Chart #

Install helm-docs following the instructions on this tutorial.

Generate docs with helm-docs command.

cd charts/victoria-metrics-operator-crds

helm-docs

The markdown generation is entirely go template driven. The tool parses metadata from charts and generates a number of sub-templates that can be referenced in a template file (by default README.md.gotmpl). If no template file is provided, the tool has a default internal template that will generate a reasonably formatted README.

Parameters #

The following tables lists the configurable parameters of the chart and their default values.

Change the values according to the need of the environment in victoria-metrics-operator/values.yaml file.

{}