From 9f5953bcef4fb9f9138f2bf7494e642d8def4d19 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Thu, 22 Jun 2023 16:48:39 +0200 Subject: [PATCH] chore: Add re-generation of Helm docs to release (#477) --- CONTRIBUTING.md | 17 +++++++++-------- http-add-on/README.md.gotmpl | 11 ++++++++++- keda/README.md | 3 +++ keda/README.md.gotmpl | 1 - 4 files changed, 22 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43a5d7c9..ff5a2631 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,8 @@ Thanks for helping making KEDA better! You can easily release a new Helm chart version: 1. Update the version of the Helm chart in `Chart.yaml`. -2. Package the Helm chart +2. Re-generate the Helm chart docs ([learn more](#documentation)) +3. Package the Helm chart - For KEDA: ```shell $ helm package keda --destination docs @@ -23,19 +24,19 @@ You can easily release a new Helm chart version: $ helm package external-scaler-azure-cosmos-db --destination docs Successfully packaged chart and saved it to: docs/external-scaler-azure-cosmos-db-0.1.0.tgz ``` -3. Re-index the Helm repo to add our new version: +4. Re-index the Helm repo to add our new version: ```shell $ helm repo index docs --url https://kedacore.github.io/charts ``` -4. Update the version in the "Browse all our Helm charts" section of our README.md -5. Commit changes: +5. Update the version in the "Browse all our Helm charts" section of our README.md +6. Commit changes: ```shell git add . git commit -sm "Packaged new Helm chart version" git push origin chart-release ``` -6. Create a pull request with our new Helm index. -7. Create a GitHub release for your new Helm chart version by using the following template. +7. Create a pull request with our new Helm index. +8. Create a GitHub release for your new Helm chart version by using the following template. - Make sure to list the changes to our Helm chart which are tracked in the [KEDA Core vNext](https://github.com/kedacore/charts/milestone/10) milestone - Instead of listing all KEDA core changes, simply refer to our release notes on the other repo (see template) @@ -69,8 +70,8 @@ You can easily release a new Helm chart version: > > - {{List removed features}} -8. Create a new milestone called `KEDA Core v{version}` -9. Move the closed items from `KEDA Core vNext` to the new milestone and close it +9. Create a new milestone called `KEDA Core v{version}` +10. Move the closed items from `KEDA Core vNext` to the new milestone and close it ## Developer Certificate of Origin: Signing your work diff --git a/http-add-on/README.md.gotmpl b/http-add-on/README.md.gotmpl index 4e3e5b71..a7f5ae05 100644 --- a/http-add-on/README.md.gotmpl +++ b/http-add-on/README.md.gotmpl @@ -90,7 +90,6 @@ their default values. {{- end }} {{- end }} - ### Operator | Parameter | Type | Default | Description | @@ -121,6 +120,16 @@ their default values. {{- end }} {{- end }} +### Webhooks + +| Parameter | Type | Default | Description | +|-----------|------|---------|-------------| +{{- range .Values }} + {{- if hasPrefix "webhooks" .Key }} +| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} | + {{- end }} +{{- end }} + Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example: diff --git a/keda/README.md b/keda/README.md index bb32b66b..2e8f03ee 100644 --- a/keda/README.md +++ b/keda/README.md @@ -239,8 +239,11 @@ their default values. | `webhooks.affinity` | object | `{}` | [Affinity] for pod scheduling for KEDA admission webhooks. Takes precedence over the `affinity` field | | `webhooks.enabled` | bool | `true` | Enable admission webhooks (this feature option will be removed in v2.12) | | `webhooks.failurePolicy` | string | `"Ignore"` | [Failure policy](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#failure-policy) to use with KEDA admission webhooks | +| `webhooks.healthProbePort` | int | `8081` | Port number to use for KEDA admission webhooks health probe | | `webhooks.name` | string | `"keda-admission-webhooks"` | Name of the KEDA admission webhooks | +| `webhooks.port` | string | `""` | Port number to use for KEDA admission webhooks. Default is 9443. | | `webhooks.replicaCount` | int | `1` | Capability to configure the number of replicas for KEDA admission webhooks | +| `webhooks.useHostNetwork` | bool | `false` | Enable webhook to use host network, this is required on EKS with custom CNI | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example: diff --git a/keda/README.md.gotmpl b/keda/README.md.gotmpl index 08a7866e..1d58c942 100644 --- a/keda/README.md.gotmpl +++ b/keda/README.md.gotmpl @@ -64,7 +64,6 @@ their default values. {{- end }} {{- end }} - ### Operator | Parameter | Type | Default | Description |