update readme

splunk · Oct 7, 2024 · d04c5a1 · d04c5a1
1 parent 6bfd21d
commit d04c5a1
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 4 deletions.
diff --git a/charts/splunk-synthetics-runner/README.md b/charts/splunk-synthetics-runner/README.md
@@ -9,8 +9,28 @@ Helm chart to deploy [private location runners](https://docs.splunk.com/observab
 To install the chart with the release name `my-splunk-synthetics-runner`:
 
 ```console
-$ helm repo add synthetics-helm-charts https://splunk.github.io/synthetics-helm-charts/
-$ helm install my-splunk-synthetics-runner release synthetics-helm-charts/splunk-synthetics-runner
+helm repo add synthetics-helm-charts https://splunk.github.io/synthetics-helm-charts/
+helm install my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.runnerToken=<runner>
+```
+
+### Updating the Chart
+
+Get the latest version of the chart by running the following command:
+
+```console
+helm repo update synthetics-helm-charts
+```
+
+Users can also check the available versions of the chart by running the following command:
+
+```console
+helm search repo synthetics-helm-charts/splunk-synthetics-runner --versions
+```
+
+To upgrade an installed release of the Splunk Synthetics runner with the  name `my-splunk-synthetics-runner`, run the following command:
+
+```console
+helm upgrade my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.runnerToken=<runner>
 ```
 
 ## Values

diff --git a/charts/splunk-synthetics-runner/README.md.gotmpl b/charts/splunk-synthetics-runner/README.md.gotmpl
@@ -9,8 +9,28 @@ Helm chart to deploy [private location runners](https://docs.splunk.com/observab
 To install the chart with the release name `my-splunk-synthetics-runner`:
 
 ```console
-$ helm repo add synthetics-helm-charts https://splunk.github.io/synthetics-helm-charts/
-$ helm install my-splunk-synthetics-runner release synthetics-helm-charts/splunk-synthetics-runner
+helm repo add synthetics-helm-charts https://splunk.github.io/synthetics-helm-charts/
+helm install my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.runnerToken=<runner>
+```
+
+### Updating the Chart
+
+Get the latest version of the chart by running the following command:
+
+```console
+helm repo update synthetics-helm-charts
+```
+
+Users can also check the available versions of the chart by running the following command:
+
+```console
+helm search repo synthetics-helm-charts/splunk-synthetics-runner --versions
+```
+
+To upgrade an installed release of the Splunk Synthetics runner with the  name `my-splunk-synthetics-runner`, run the following command:
+
+```console
+helm upgrade my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.runnerToken=<runner>
 ```
 
 {{ template "chart.requirementsSection" . }}