Update template instructions with correct helm syntax (#616)

* Update template instructions with correct helm syntax * update all the READMEs --------- Co-authored-by: Max Williams <max-rocket-internet@users.noreply.github.com>
deliveryhero · Oct 10, 2024 · b422462 · b422462
1 parent 8dc27a5
commit b422462
Show file tree

Hide file tree

Showing 54 changed files with 162 additions and 162 deletions.
diff --git a/ci/README.md.gotmpl b/ci/README.md.gotmpl
@@ -9,16 +9,16 @@
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/{{ template "chart.name" . }}
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/{{ template "chart.name" . }}
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/{{ template "chart.name" . }} --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/{{ template "chart.name" . }} --version {{ template "chart.version" . }}
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/aws-ebs-csi-driver/README.md b/stable/aws-ebs-csi-driver/README.md
@@ -8,16 +8,16 @@ A Helm chart for AWS EBS CSI Driver
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/aws-ebs-csi-driver
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/aws-ebs-csi-driver
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/aws-ebs-csi-driver --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/aws-ebs-csi-driver --version 2.17.1
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/aws-s3-proxy/README.md b/stable/aws-s3-proxy/README.md
@@ -10,16 +10,16 @@ See here for configuration via environment variables: https://github.com/pottava
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/aws-s3-proxy
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/aws-s3-proxy
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/aws-s3-proxy --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/aws-s3-proxy --version 0.1.5
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/aws-service-events-exporter/README.md b/stable/aws-service-events-exporter/README.md
@@ -11,16 +11,16 @@ This helm chart exports aws service events to prometheus via aws SQS queue, this
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/aws-service-events-exporter
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/aws-service-events-exporter
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/aws-service-events-exporter --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/aws-service-events-exporter --version 1.0.5
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/aws-service-quotas-exporter/README.md b/stable/aws-service-quotas-exporter/README.md
@@ -8,16 +8,16 @@ This exporter exports AWS service quotas and usage as Prometheus metrics
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/aws-service-quotas-exporter
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/aws-service-quotas-exporter
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/aws-service-quotas-exporter --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/aws-service-quotas-exporter --version 0.1.2
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/aws-storage-class/README.md b/stable/aws-storage-class/README.md
@@ -8,16 +8,16 @@ Creates a StorageClass. From here: https://github.com/kubernetes/kubernetes/blob
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/aws-storage-class
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/aws-storage-class
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/aws-storage-class --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/aws-storage-class --version 0.1.7
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/backstage-mono/README.md b/stable/backstage-mono/README.md
@@ -8,16 +8,16 @@ A Helm chart for simple backstage deployment. This chart deploys a single pod fo
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/backstage-mono
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/backstage-mono
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/backstage-mono --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/backstage-mono --version 0.1.1
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/backstage/README.md b/stable/backstage/README.md
@@ -8,16 +8,16 @@ A Helm chart for Backstage
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/backstage
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/backstage
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/backstage --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/backstage --version 0.1.13
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/cachet/README.md b/stable/cachet/README.md
@@ -8,16 +8,16 @@ The open source status page system
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/cachet
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/cachet
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/cachet --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/cachet --version 1.3.4
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/cloudhealth-collector/README.md b/stable/cloudhealth-collector/README.md
@@ -14,16 +14,16 @@ To install the chart a valid api token should be generated from adding a new clu
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/cloudhealth-collector
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/cloudhealth-collector
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/cloudhealth-collector --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/cloudhealth-collector --version 0.1.6
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/cluster-overprovisioner/README.md b/stable/cluster-overprovisioner/README.md
@@ -12,16 +12,16 @@ This approach is the [current recommended method to achieve overprovisioning](ht
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/cluster-overprovisioner
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/cluster-overprovisioner
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/cluster-overprovisioner --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/cluster-overprovisioner --version 0.7.11
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/cortex-gateway/README.md b/stable/cortex-gateway/README.md
@@ -8,16 +8,16 @@ A Helm chart for cortex-gateway
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/cortex-gateway
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/cortex-gateway
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/cortex-gateway --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/cortex-gateway --version 0.1.8
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/datadog-controller/README.md b/stable/datadog-controller/README.md
@@ -24,16 +24,16 @@ spec:
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/datadog-controller
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/datadog-controller
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/datadog-controller --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/datadog-controller --version 1.1
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/dregsy/README.md b/stable/dregsy/README.md
@@ -8,16 +8,16 @@ Dregsy lets you sync Docker images between registries, public or private through
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/dregsy
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/dregsy
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/dregsy --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/dregsy --version 0.1.4
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/field-exporter/README.md b/stable/field-exporter/README.md
@@ -8,16 +8,16 @@ A chart to install [field-exporter](https://github.com/deliveryhero/field-export
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/field-exporter
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/field-exporter
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/field-exporter --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/field-exporter --version 1.3.1
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/gripmock/README.md b/stable/gripmock/README.md
@@ -12,16 +12,16 @@ A chart to install [gripmock](https://github.com/tokopedia/gripmock). A mock ser
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/gripmock
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/gripmock
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/gripmock --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/gripmock --version 1.1.2
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/hoppscotch/README.md b/stable/hoppscotch/README.md
@@ -8,16 +8,16 @@ A free, fast and beautiful API request builder
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/hoppscotch
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/hoppscotch
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/hoppscotch --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/hoppscotch --version 0.3.0
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/k8s-cloudwatch-adapter/README.md b/stable/k8s-cloudwatch-adapter/README.md
@@ -8,16 +8,16 @@ An implementation of the Kubernetes Custom Metrics API and External Metrics API
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/k8s-cloudwatch-adapter
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/k8s-cloudwatch-adapter
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/k8s-cloudwatch-adapter --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/k8s-cloudwatch-adapter --version 0.2.1
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/k8s-event-logger/README.md b/stable/k8s-event-logger/README.md
@@ -19,16 +19,16 @@ The problem is that these events are simply API objects in Kubernetes and are on
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/k8s-event-logger
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/k8s-event-logger
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/k8s-event-logger --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/k8s-event-logger --version 1.1.8
 ```
 
 To install the chart with the release name `my-release`:

diff --git a/stable/k8s-resources/README.md b/stable/k8s-resources/README.md
@@ -23,16 +23,16 @@ Every resource type can have custom labels, annotations or a `fullnameOverride`
 
 ## How to install this chart
 
-A simple install with default values:
+A simple install with default values, latest chart version and generated name:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/k8s-resources
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/k8s-resources
 ```
 
 To install a specific version of this chart:
 
 ```console
-helm install oci://ghcr.io/deliveryhero/helm-charts/k8s-resources --version <version>
+helm install --generate-name oci://ghcr.io/deliveryhero/helm-charts/k8s-resources --version 0.6.6
 ```
 
 To install the chart with the release name `my-release`: