diff --git a/.github/workflows/_release-pr.yml b/.github/workflows/_release-pr.yml index d5c50bf87e..bccae0d526 100644 --- a/.github/workflows/_release-pr.yml +++ b/.github/workflows/_release-pr.yml @@ -83,6 +83,7 @@ jobs: make helm/docs/vald make helm/docs/vald-helm-operator make helm/docs/vald-readreplica + make helm/docs/vald-benchmark-operator BODY="" if [ ! -z "${PR_NUM}" ]; then diff --git a/.github/workflows/helm.yml b/.github/workflows/helm.yml index 98702699f3..36c80a4553 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 - name: Push to gh-pages run: | git checkout . diff --git a/Makefile.d/helm.mk b/Makefile.d/helm.mk index 300892c466..9c6ec19795 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/repo/add ## add Helm chart repository helm/repo/add: @@ -80,6 +88,15 @@ charts/vald-readreplica/README.md: \ charts/vald-readreplica/values.yaml helm-docs +.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 + .PHONY: helm/schema/all helm/schema/all: \ helm/schema/vald \ @@ -142,8 +159,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/README.md b/charts/vald-benchmark-operator/README.md index 4513b4fa05..b08be4f74e 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.5` -**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 | | ----------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | @@ -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" . }}