Skip to content

Commit

Permalink
prepare release for operator chart with version 0.41.2 (#872)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Amper
Amper authored Feb 21, 2024
1 parent bf5a80e commit f06828b
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 33 deletions.
24 changes: 21 additions & 3 deletions charts/victoria-metrics-k8s-stack/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Kubernetes monitoring on VictoriaMetrics stack. Includes VictoriaMetrics Operato
* [Values](#Parameters)

## Overview

This chart is an All-in-one solution to start monitoring kubernetes cluster.
It installs multiple dependency charts like [grafana](https://github.com/grafana/helm-charts/tree/main/charts/grafana), [node-exporter](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-node-exporter), [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics/tree/master/charts/kube-state-metrics) and [victoria-metrics-operator](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-operator).
Also it installs Custom Resources like [VMSingle](https://docs.victoriametrics.com/operator/quick-start.html#vmsingle), [VMCluster](https://docs.victoriametrics.com/operator/quick-start.html#vmcluster), [VMAgent](https://docs.victoriametrics.com/operator/quick-start.html#vmagent), [VMAlert](https://docs.victoriametrics.com/operator/quick-start.html#vmalert).
Expand All @@ -37,6 +38,7 @@ Configuration of this chart is done through helm values.
Dependencies can be enabled or disabled by setting `enabled` to `true` or `false` in `values.yaml` file.

**!Important:** for dependency charts anything that you can find in values.yaml of dependency chart can be configured in this chart under key for that dependency. For example if you want to configure `grafana` you can find all possible configuration options in [values.yaml](https://github.com/grafana/helm-charts/blob/main/charts/grafana/values.yaml) and you should set them in values for this chart under grafana: key. For example if you want to configure `grafana.persistence.enabled` you should set it in values.yaml like this:

```yaml
#################################################
### dependencies #####
Expand All @@ -53,6 +55,7 @@ grafana:
This chart installs multiple VictoriaMetrics components using Custom Resources that are managed by [victoria-metrics-operator](https://docs.victoriametrics.com/operator/design.html)
Each resource can be configured using `spec` of that resource from API docs of [victoria-metrics-operator](https://docs.victoriametrics.com/operator/api.html). For example if you want to configure `VMAgent` you can find all possible configuration options in [API docs](https://docs.victoriametrics.com/operator/api.html#vmagent) and you should set them in values for this chart under `vmagent.spec` key. For example if you want to configure `remoteWrite.url` you should set it in values.yaml like this:

```yaml
vmagent:
spec:
Expand All @@ -67,7 +70,9 @@ you can disable dashboards with `defaultDashboardsEnabled: false` and `experimen
and rules can be configured under `defaultRules`

### Prometheus scrape configs

This chart installs multiple scrape configurations for kubernetes monitoring. They are configured under `#ServiceMonitors` section in `values.yaml` file. For example if you want to configure scrape config for `kubelet` you should set it in values.yaml like this:

```yaml
kubelet:
enabled: true
Expand Down Expand Up @@ -147,6 +152,7 @@ Remove application with command.
```console
helm uninstall [RELEASE_NAME] -n NAMESPACE
```

This removes all the Kubernetes components associated with the chart and deletes the release.

_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
Expand All @@ -173,12 +179,24 @@ helm upgrade -i some-very-long-name vm/victoria-metrics-k8s-stack --set fullname

## Upgrade guide

Usually, helm upgrade doesn't requires manual actions. But release with CRD update must be patched manually with kubectl.
Just execute command:
Usually, helm upgrade doesn't requires manual actions. Just execute command:

```console
$ helm upgrade [RELEASE_NAME] vm/victoria-metrics-k8s-stack
```
All CRD manual actions upgrades listed below:

But release with CRD update can only be patched manually with kubectl.
Since helm does not perform a CRD update, we recommend that you always perform this when updating the helm-charts version:

```console
# 1. check the changes in CRD
$ helm show crds vm/victoria-metrics-k8s-stack --version [YOUR_CHART_VERSION] | kubectl diff -f -
# 2. apply the changes (update CRD)
$ helm show crds vm/victoria-metrics-k8s-stack --version [YOUR_CHART_VERSION] | kubectl apply -f - --server-side
```

All other manual actions upgrades listed below:

### Upgrade to 0.13.0

Expand Down
2 changes: 1 addition & 1 deletion charts/victoria-metrics-operator/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Next release

- TODO
- bump version of VM operator to [0.41.2](https://github.com/VictoriaMetrics/operator/releases/tag/v0.41.2)

## 0.28.0

Expand Down
4 changes: 2 additions & 2 deletions charts/victoria-metrics-operator/Chart.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
apiVersion: v1
appVersion: 0.41.1
appVersion: 0.41.2
description: Victoria Metrics Operator
name: victoria-metrics-operator
home: https://github.com/VictoriaMetrics/operator
sources:
- https://github.com/VictoriaMetrics/helm-charts
- https://github.com/VictoriaMetrics/operator
version: 0.28.0
version: 0.28.1
icon: https://avatars.githubusercontent.com/u/43720803?s=200&v=4
kubeVersion: ">=1.23.0-0"
keywords:
Expand Down
52 changes: 26 additions & 26 deletions charts/victoria-metrics-operator/crd.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,8 @@ spec:
description: Specifies the DNS parameters of a pod. Parameters specified
here will be merged to the generated DNS configuration based on
DNSPolicy.
items:
x-kubernetes-preserve-unknown-fields: true
properties:
nameservers:
description: A list of DNS name server IP addresses. This will
Expand Down Expand Up @@ -654,8 +656,6 @@ spec:
type: string
type: array
type: object
items:
x-kubernetes-preserve-unknown-fields: true
dnsPolicy:
description: DNSPolicy set DNS policy for the pod
type: string
Expand Down Expand Up @@ -6617,6 +6617,8 @@ spec:
description: Specifies the DNS parameters of a pod. Parameters specified
here will be merged to the generated DNS configuration based on
DNSPolicy.
items:
x-kubernetes-preserve-unknown-fields: true
properties:
nameservers:
description: A list of DNS name server IP addresses. This will
Expand Down Expand Up @@ -6649,8 +6651,6 @@ spec:
type: string
type: array
type: object
items:
x-kubernetes-preserve-unknown-fields: true
dnsPolicy:
description: DNSPolicy sets DNS policy for the pod
type: string
Expand Down Expand Up @@ -7592,6 +7592,8 @@ spec:
description: Datasource Victoria Metrics or VMSelect url. Required
parameter. e.g. http://127.0.0.1:8428
properties:
OAuth2:
x-kubernetes-preserve-unknown-fields: true
basicAuth:
description: BasicAuth allow an endpoint to authenticate over
basic authentication
Expand Down Expand Up @@ -7769,15 +7771,15 @@ spec:
description: Victoria Metrics or VMSelect url. Required parameter.
E.g. http://127.0.0.1:8428
type: string
OAuth2:
x-kubernetes-preserve-unknown-fields: true
required:
- url
type: object
dnsConfig:
description: Specifies the DNS parameters of a pod. Parameters specified
here will be merged to the generated DNS configuration based on
DNSPolicy.
items:
x-kubernetes-preserve-unknown-fields: true
properties:
nameservers:
description: A list of DNS name server IP addresses. This will
Expand Down Expand Up @@ -7810,8 +7812,6 @@ spec:
type: string
type: array
type: object
items:
x-kubernetes-preserve-unknown-fields: true
dnsPolicy:
description: DNSPolicy sets DNS policy for the pod
type: string
Expand Down Expand Up @@ -7985,6 +7985,8 @@ spec:
notifier options could be chosen: notifierConfigRef or notifiers
+ notifier'
properties:
OAuth2:
x-kubernetes-preserve-unknown-fields: true
basicAuth:
description: BasicAuth allow an endpoint to authenticate over
basic authentication
Expand Down Expand Up @@ -8230,8 +8232,6 @@ spec:
url:
description: AlertManager url. E.g. http://127.0.0.1:9093
type: string
OAuth2:
x-kubernetes-preserve-unknown-fields: true
type: object
notifierConfigRef:
description: 'NotifierConfigRef reference for secret with notifier
Expand Down Expand Up @@ -8264,6 +8264,8 @@ spec:
description: VMAlertNotifierSpec defines the notifier url for sending
information about alerts
properties:
OAuth2:
x-kubernetes-preserve-unknown-fields: true
basicAuth:
description: BasicAuth allow an endpoint to authenticate over
basic authentication
Expand Down Expand Up @@ -8509,8 +8511,6 @@ spec:
url:
description: AlertManager url. E.g. http://127.0.0.1:9093
type: string
OAuth2:
x-kubernetes-preserve-unknown-fields: true
type: object
type: array
podDisruptionBudget:
Expand Down Expand Up @@ -8604,6 +8604,8 @@ spec:
has been successfully persisted (via RemoteWrite) before. see -remoteRead.url
docs in vmalerts for details. E.g. http://127.0.0.1:8428
properties:
OAuth2:
x-kubernetes-preserve-unknown-fields: true
basicAuth:
description: BasicAuth allow an endpoint to authenticate over
basic authentication
Expand Down Expand Up @@ -8786,8 +8788,6 @@ spec:
url:
description: URL of the endpoint to send samples to.
type: string
OAuth2:
x-kubernetes-preserve-unknown-fields: true
required:
- url
type: object
Expand All @@ -8798,6 +8798,8 @@ spec:
in the form of time series named ALERTS and ALERTS_FOR_STATE see
-remoteWrite.url docs in vmalerts for details. E.g. http://127.0.0.1:8428
properties:
OAuth2:
x-kubernetes-preserve-unknown-fields: true
basicAuth:
description: BasicAuth allow an endpoint to authenticate over
basic authentication
Expand Down Expand Up @@ -8994,8 +8996,6 @@ spec:
url:
description: URL of the endpoint to send samples to.
type: string
OAuth2:
x-kubernetes-preserve-unknown-fields: true
required:
- url
type: object
Expand Down Expand Up @@ -9487,6 +9487,8 @@ spec:
description: Specifies the DNS parameters of a pod. Parameters specified
here will be merged to the generated DNS configuration based on
DNSPolicy.
items:
x-kubernetes-preserve-unknown-fields: true
properties:
nameservers:
description: A list of DNS name server IP addresses. This will
Expand Down Expand Up @@ -9519,8 +9521,6 @@ spec:
type: string
type: array
type: object
items:
x-kubernetes-preserve-unknown-fields: true
dnsPolicy:
description: DNSPolicy sets DNS policy for the pod
type: string
Expand Down Expand Up @@ -10587,6 +10587,8 @@ spec:
description: Specifies the DNS parameters of a pod. Parameters
specified here will be merged to the generated DNS configuration
based on DNSPolicy.
items:
x-kubernetes-preserve-unknown-fields: true
properties:
nameservers:
description: A list of DNS name server IP addresses. This
Expand Down Expand Up @@ -10619,8 +10621,6 @@ spec:
type: string
type: array
type: object
items:
x-kubernetes-preserve-unknown-fields: true
dnsPolicy:
description: DNSPolicy sets DNS policy for the pod
type: string
Expand Down Expand Up @@ -11440,6 +11440,8 @@ spec:
description: Specifies the DNS parameters of a pod. Parameters
specified here will be merged to the generated DNS configuration
based on DNSPolicy.
items:
x-kubernetes-preserve-unknown-fields: true
properties:
nameservers:
description: A list of DNS name server IP addresses. This
Expand Down Expand Up @@ -11472,8 +11474,6 @@ spec:
type: string
type: array
type: object
items:
x-kubernetes-preserve-unknown-fields: true
dnsPolicy:
description: DNSPolicy sets DNS policy for the pod
type: string
Expand Down Expand Up @@ -12638,6 +12638,8 @@ spec:
description: Specifies the DNS parameters of a pod. Parameters
specified here will be merged to the generated DNS configuration
based on DNSPolicy.
items:
x-kubernetes-preserve-unknown-fields: true
properties:
nameservers:
description: A list of DNS name server IP addresses. This
Expand Down Expand Up @@ -12670,8 +12672,6 @@ spec:
type: string
type: array
type: object
items:
x-kubernetes-preserve-unknown-fields: true
dnsPolicy:
description: DNSPolicy sets DNS policy for the pod
type: string
Expand Down Expand Up @@ -17375,6 +17375,8 @@ spec:
description: Specifies the DNS parameters of a pod. Parameters specified
here will be merged to the generated DNS configuration based on
DNSPolicy.
items:
x-kubernetes-preserve-unknown-fields: true
properties:
nameservers:
description: A list of DNS name server IP addresses. This will
Expand Down Expand Up @@ -17407,8 +17409,6 @@ spec:
type: string
type: array
type: object
items:
x-kubernetes-preserve-unknown-fields: true
dnsPolicy:
description: DNSPolicy sets DNS policy for the pod
type: string
Expand Down
2 changes: 1 addition & 1 deletion charts/victoria-metrics-operator/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ image:
# -- Image repository
repository: victoriametrics/operator
# -- Image tag
tag: v0.41.1
tag: v0.41.2
# -- Image pull policy
pullPolicy: IfNotPresent

Expand Down

0 comments on commit f06828b

Please sign in to comment.