chore: Update chart readme with futher instructions

splunk · Oct 14, 2024 · a0aa5fc · a0aa5fc
1 parent 0e53a66
commit a0aa5fc
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/charts/splunk-synthetics-runner/README.md b/charts/splunk-synthetics-runner/README.md
@@ -33,6 +33,26 @@ To upgrade an installed release of the Splunk Synthetics runner with the  name `
 helm upgrade my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.runnerToken=<runner>
 ```
 
+### Uninstalling the Chart
+
+To unistall a release of the Splunk Synthetics runner with the name `my-splunk-synthetics-runner`, run the following command:
+
+```console
+helm uninstall my-splunk-synthetics-runner
+```
+
+### Configuration
+
+Refer to the [values.yaml](values.yaml) file or the Values section below for the full run-down on configuration options and default values available.
+
+### Alternatives to Helm
+
+If you are not using Helm, you can generate the Kubernetes manifests from the helm chart and deploy with `kubectl`. To generate the Kubernetes manifests, run the following command:
+
+```console
+helm template my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.runnerToken=<runner> | kubectl apply -f -
+```
+
 ## Values
 
 | Key | Type | Default | Description |

diff --git a/charts/splunk-synthetics-runner/README.md.gotmpl b/charts/splunk-synthetics-runner/README.md.gotmpl
@@ -33,6 +33,26 @@ To upgrade an installed release of the Splunk Synthetics runner with the  name `
 helm upgrade my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.runnerToken=<runner>
 ```
 
+### Uninstalling the Chart
+
+To unistall a release of the Splunk Synthetics runner with the name `my-splunk-synthetics-runner`, run the following command:
+
+```console
+helm uninstall my-splunk-synthetics-runner
+```
+
+### Configuration
+
+Refer to the [values.yaml](values.yaml) file or the Values section below for the full run-down on configuration options and default values available.
+
+### Alternatives to Helm
+
+If you are not using Helm, you can generate the Kubernetes manifests from the helm chart and deploy with `kubectl`. To generate the Kubernetes manifests, run the following command:
+
+```console
+helm template my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.runnerToken=<runner> | kubectl apply -f -
+```
+
 {{ template "chart.requirementsSection" . }}
 
 {{ template "chart.valuesSection" . }}