From 0ad913994a1db41af10ff6ba01f8be5560b6b4f0 Mon Sep 17 00:00:00 2001 From: Kiichiro YUKAWA Date: Tue, 20 Feb 2024 11:26:50 +0900 Subject: [PATCH] :green_heart: :recycle: Add Con-Bench helm chart to the Vald charts (#2388) Signed-off-by: vankichi --- .github/workflows/_release-pr.yml | 3 ++ .github/workflows/helm.yml | 1 + Makefile.d/helm.mk | 19 +++++++++- charts/vald-benchmark-operator/Chart.yaml | 2 +- charts/vald-benchmark-operator/README.md | 35 +++++++++---------- .../vald-benchmark-operator/README.md.gotmpl | 29 +++++++++++++++ charts/vald-benchmark-operator/values.yaml | 4 +-- k8s/tools/benchmark/operator/configmap.yaml | 6 ++-- k8s/tools/benchmark/operator/deployment.yaml | 6 ++-- k8s/tools/benchmark/operator/service.yaml | 4 +-- 10 files changed, 78 insertions(+), 31 deletions(-) create mode 100644 charts/vald-benchmark-operator/README.md.gotmpl diff --git a/.github/workflows/_release-pr.yml b/.github/workflows/_release-pr.yml index 215a1e43c6..1b8e2b9fc8 100644 --- a/.github/workflows/_release-pr.yml +++ b/.github/workflows/_release-pr.yml @@ -75,6 +75,8 @@ jobs: sed -i -e "s/^version: .*$/version: ${RELEASE_TAG}/" charts/vald-helm-operator/Chart.yaml sed -i -r "s/^(\s*)tag\s*:\s*v[0-9]+\.[0-9]+\.[0-9]+\s*$/\1tag: ${RELEASE_TAG}/" charts/vald-helm-operator/values.yaml sed -i -e "s/^version: .*$/version: ${RELEASE_TAG}/" charts/vald-readreplica/Chart.yaml + sed -i -e "s/^version: .*$/version: ${RELEASE_TAG}/" charts/vald-benchmark-operator/Chart.yaml + sed -i -r "s/^(\s*)tag\s*:\s*v[0-9]+\.[0-9]+\.[0-9]+\s*$/\1tag: ${RELEASE_TAG}/" charts/vald-benchmark-operator/values.yaml make helm/schema/all make helm/schema/crd/all @@ -84,6 +86,7 @@ jobs: make k8s/manifest/readreplica/update make helm/docs/vald make helm/docs/vald-helm-operator + make helm/docs/vald-benchmark-operator make helm/docs/vald-readreplica BODY="" diff --git a/.github/workflows/helm.yml b/.github/workflows/helm.yml index f8e5a48e83..b2f1b4bfc9 100644 --- a/.github/workflows/helm.yml +++ b/.github/workflows/helm.yml @@ -54,6 +54,7 @@ jobs: run: | make helm/package/vald make helm/package/vald-helm-operator + make helm/package/vald-benchmark-operator make helm/package/vald-readreplica - name: Push to gh-pages run: | diff --git a/Makefile.d/helm.mk b/Makefile.d/helm.mk index 2be3cddc32..73b555ab77 100644 --- a/Makefile.d/helm.mk +++ b/Makefile.d/helm.mk @@ -45,6 +45,14 @@ helm/package/vald-helm-operator: \ helm/schema/crd/vald-helm-operator helm package charts/vald-helm-operator +.PHONY: helm/package/vald-benchmark-operator +## packaging Helm chart for vald-helm-operator +helm/package/vald-benchmark-operator: \ + helm/schema/crd/vald-benchmark-job \ + helm/schema/crd/vald-benchmark-scenario \ + helm/schema/crd/vald-benchmark-operator + helm package charts/vald-benchmark-operator + .PHONY: helm/package/vald-readreplica helm/package/vald-readreplica: helm package charts/vald-readreplica @@ -77,6 +85,15 @@ charts/vald-helm-operator/README.md: \ .PHONY: helm/docs/vald-readreplica helm/docs/vald-readreplica: charts/vald-readreplica/README.md +.PHONY: helm/docs/vald-benchmark-operator +helm/docs/vald-benchmark-operator: charts/vald-benchmark-operator/README.md + +.PHONY: charts/vald-benchmark-operator/README.md +charts/vald-benchmark-operator/README.md: \ + charts/vald-benchmark-operator/README.md.gotmpl \ + charts/vald-benchmark-operator/values.yaml + helm-docs + # force to rebuild .PHONY: charts/vald-readreplica/README.md charts/vald-readreplica/README.md: \ @@ -146,8 +163,8 @@ $(BINDIR)/yq: helm/schema/crd/all: \ helm/schema/crd/vald \ helm/schema/crd/vald-helm-operator \ - helm/schema/crd/vald-benchmark-job \ helm/schema/crd/vald/mirror-target \ + helm/schema/crd/vald-benchmark-job \ helm/schema/crd/vald-benchmark-scenario \ helm/schema/crd/vald-benchmark-operator diff --git a/charts/vald-benchmark-operator/Chart.yaml b/charts/vald-benchmark-operator/Chart.yaml index aea5e8c563..d2b1cb2c76 100644 --- a/charts/vald-benchmark-operator/Chart.yaml +++ b/charts/vald-benchmark-operator/Chart.yaml @@ -32,7 +32,7 @@ appVersion: "1.16.0" apiVersion: v2 name: vald-benchmark-operator -version: v1.7.5 +version: v1.7.11 description: A benchmark operator for benchmarking the Vald cluster. type: application keywords: diff --git a/charts/vald-benchmark-operator/README.md b/charts/vald-benchmark-operator/README.md index 4513b4fa05..d3f279074d 100644 --- a/charts/vald-benchmark-operator/README.md +++ b/charts/vald-benchmark-operator/README.md @@ -1,24 +1,25 @@ -# vald-benchmark-operator +# Vald Benchmark Operator -![Version: v1.7.5](https://img.shields.io/badge/Version-v1.7.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square) +This is a Helm chart to install `vald-benchmark-operator`. -A benchmark operator for benchmarking the Vald cluster. +Current chart version is `v1.7.11` -**Homepage:** +## Table of Contents -## Maintainers +- [Install](#install) +- [Configuration](#configuration) -| Name | Email | Url | -| -------- | -------------------- | --- | -| kpango | | | -| vankichi | | | -| kmrmt | | | +## Install -## Source Code +Add Vald Helm repository -- + $ helm repo add vald https://vald.vdaas.org/charts -## Values +Run the following command to install the chart, + + $ helm install vald-benchmark-operator vald/vald-benchmark-operator + +## Configuration | Key | Type | Default | Description | | ----------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | @@ -26,10 +27,10 @@ A benchmark operator for benchmarking the Vald cluster. | annotations | object | `{}` | deployment annotations | | image.pullPolicy | string | `"Always"` | image pull policy | | image.repository | string | `"vdaas/vald-benchmark-operator"` | job image repository | -| image.tag | string | `"v1.7.5"` | image tag for job docker image | +| image.tag | string | `"v1.7.11"` | image tag for job docker image | | job_image.pullPolicy | string | `"Always"` | | | job_image.repository | string | `"vdaas/vald-benchmark-job"` | | -| job_image.tag | string | `"v1.7.5"` | | +| job_image.tag | string | `"v1.7.11"` | | | logging.format | string | `"raw"` | logging format. logging format must be `raw` or `json` | | logging.level | string | `"debug"` | logging level. logging level must be `debug`, `info`, `warn`, `error` or `fatal`. | | logging.logger | string | `"glg"` | logger name. currently logger must be `glg` or `zap`. | @@ -180,7 +181,3 @@ A benchmark operator for benchmarking the Vald cluster. | time_zone | string | `""` | time_zone | | tolerations | list | `[]` | tolerations | | version | string | `"v0.0.0"` | version of benchmark-operator config | - ---- - -Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0) diff --git a/charts/vald-benchmark-operator/README.md.gotmpl b/charts/vald-benchmark-operator/README.md.gotmpl new file mode 100644 index 0000000000..9738449417 --- /dev/null +++ b/charts/vald-benchmark-operator/README.md.gotmpl @@ -0,0 +1,29 @@ +Vald Benchmark Operator +=== + +This is a Helm chart to install `vald-benchmark-operator`. + + +Current chart version is `{{ template "chart.version" . }}` + +Table of Contents +--- + +- [Install](#install) +- [Configuration](#configuration) + +Install +--- + +Add Vald Helm repository + + $ helm repo add vald https://vald.vdaas.org/charts + +Run the following command to install the chart, + + $ helm install vald-benchmark-operator vald/vald-benchmark-operator + +Configuration +--- + +{{ template "chart.valuesTable" . }} diff --git a/charts/vald-benchmark-operator/values.yaml b/charts/vald-benchmark-operator/values.yaml index 155f13e655..f22f3ca3e7 100644 --- a/charts/vald-benchmark-operator/values.yaml +++ b/charts/vald-benchmark-operator/values.yaml @@ -33,7 +33,7 @@ image: repository: vdaas/vald-benchmark-operator # @schema {"name": "image.tag", "type": "string"} # image.tag -- image tag - tag: v1.7.5 + tag: v1.7.11 # @schema {"name": "image.pullPolicy", "type": "string", "enum": ["Always", "Never", "IfNotPresent"]} # image.pullPolicy -- image pull policy pullPolicy: Always @@ -44,7 +44,7 @@ job_image: repository: vdaas/vald-benchmark-job # @schema {"name": "job_image.tag", "type": "string"} # image.tag -- image tag for job docker image - tag: v1.7.5 + tag: v1.7.11 # @schema {"name": "job_image.pullPolicy", "type": "string", "enum": ["Always", "Never", "IfNotPresent"]} # image.pullPolicy -- image pull policy pullPolicy: Always diff --git a/k8s/tools/benchmark/operator/configmap.yaml b/k8s/tools/benchmark/operator/configmap.yaml index 6e292e19a1..12975b7c84 100644 --- a/k8s/tools/benchmark/operator/configmap.yaml +++ b/k8s/tools/benchmark/operator/configmap.yaml @@ -19,10 +19,10 @@ metadata: name: vald-benchmark-operator-config labels: app.kubernetes.io/name: vald-benchmark-operator - helm.sh/chart: vald-benchmark-operator-v1.7.5 + helm.sh/chart: vald-benchmark-operator-v1.7.11 app.kubernetes.io/managed-by: Helm app.kubernetes.io/instance: release-name - app.kubernetes.io/version: v1.7.5 + app.kubernetes.io/version: v1.7.11 app.kubernetes.io/component: benchmark-operator data: config.yaml: | @@ -138,5 +138,5 @@ data: enabled: false sampling_rate: 1 job_image: - image: "vdaas/vald-benchmark-job:v1.7.5" + image: "vdaas/vald-benchmark-job:v1.7.11" pullPolicy: Always diff --git a/k8s/tools/benchmark/operator/deployment.yaml b/k8s/tools/benchmark/operator/deployment.yaml index 11aa1bea00..f3c4bc23ce 100644 --- a/k8s/tools/benchmark/operator/deployment.yaml +++ b/k8s/tools/benchmark/operator/deployment.yaml @@ -21,10 +21,10 @@ metadata: labels: app: vald-benchmark-operator app.kubernetes.io/name: vald-benchmark-operator - helm.sh/chart: vald-benchmark-operator-v1.7.5 + helm.sh/chart: vald-benchmark-operator-v1.7.11 app.kubernetes.io/managed-by: Helm app.kubernetes.io/instance: release-name - app.kubernetes.io/version: v1.7.5 + app.kubernetes.io/version: v1.7.11 app.kubernetes.io/component: benchmark-operator spec: replicas: 1 @@ -42,7 +42,7 @@ spec: serviceAccountName: vald-benchmark-operator containers: - name: vald-benchmark-operator - image: "vdaas/vald-benchmark-operator:v1.7.5" + image: "vdaas/vald-benchmark-operator:v1.7.11" imagePullPolicy: Always livenessProbe: failureThreshold: 2 diff --git a/k8s/tools/benchmark/operator/service.yaml b/k8s/tools/benchmark/operator/service.yaml index 72c0c9f34a..e71f7e6b6b 100644 --- a/k8s/tools/benchmark/operator/service.yaml +++ b/k8s/tools/benchmark/operator/service.yaml @@ -19,10 +19,10 @@ metadata: name: vald-benchmark-operator labels: app.kubernetes.io/name: vald-benchmark-operator - helm.sh/chart: vald-benchmark-operator-v1.7.5 + helm.sh/chart: vald-benchmark-operator-v1.7.11 app.kubernetes.io/managed-by: Helm app.kubernetes.io/instance: release-name - app.kubernetes.io/version: v1.7.5 + app.kubernetes.io/version: v1.7.11 app.kubernetes.io/component: helm-operator spec: ports: