chore: Update chart readme with futher instructions (#10)

* chore: Update chart readme with futher instructions

* chore: update tests

* chore: update readme

* chore: update repo readme with build/release badges

.github/workflows/test.yaml

@@ -61,6 +61,8 @@ jobs:
         # Only build a kind cluster if there are chart changes to test.
         if: steps.list-changed.outputs.changed == 'true'
 
-      # pod will error due to invalid token for now
       - name: Run chart-testing (install)
-        run: ct install --config=ct.yaml
+        run: ct install --config=ct.yaml --helm-extra-set-args='--set=synthetics.secret.create=true,synthetics.secret.runnerToken=${{ secrets.RUNNER_TOKEN }}'
+
+      - name: Run chart-testing (upgrade)
+        run: ct install --config=ct.yaml --helm-extra-set-args='--set=synthetics.secret.create=true,synthetics.secret.runnerToken=${{ secrets.RUNNER_TOKEN }}' --upgrade

README.md

@@ -1,3 +1,19 @@
+---
+
+<p align="center">
+  <a href="https://github.com/splunk/synthetics-helm-charts/actions/workflows/test.yaml?query=branch%3Amain">
+    <img alt="Build Status" src="https://github.com/splunk/synthetics-helm-charts/actions/workflows/test.yaml?branch=main&style=for-the-badge">
+  </a>
+  <a href="https://github.com/splunk/synthetics-helm-charts/releases">
+    <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/splunk/synthetics-helm-charts?include_prereleases&style=for-the-badge">
+  </a>
+</p>
+
+---
 # Splunk Synthetic's Private Location Runner
 
 This repository hosts helm chart to deploy Splunk Synthetic's private location runner in Kubernetes clusters.
+
+## Getting Started
+
+To deploy a private location runner to kubernetes, please see the instructions available in the helm chart's [README](charts/splunk-synthetics-runner/README.md). Further details on the private location runner can be found in the [Splunk Observability documentation](https://docs.splunk.com/observability/en/synthetics/test-config/private-locations.html).

charts/splunk-synthetics-runner/README.md

@@ -10,7 +10,7 @@ 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 synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.runnerToken=<runner>
+helm install my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.create=true,synthetics.secret.runnerToken=<TOKEN>
 ```
 
 ### Updating the Chart
@@ -30,7 +30,27 @@ 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>
+helm upgrade my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.create=true,synthetics.secret.runnerToken=<TOKEN>
+```
+
+### 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.create=true,synthetics.secret.runnerToken=<TOKEN> | kubectl apply -f -
 ```
 
 ## Values

charts/splunk-synthetics-runner/README.md.gotmpl

@@ -10,7 +10,7 @@ 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 synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.runnerToken=<runner>
+helm install my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.create=true,synthetics.secret.runnerToken=<TOKEN>
 ```
 
 ### Updating the Chart
@@ -30,7 +30,27 @@ 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>
+helm upgrade my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.create=true,synthetics.secret.runnerToken=<TOKEN>
+```
+
+### 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.create=true,synthetics.secret.runnerToken=<TOKEN> | kubectl apply -f -
 ```
 
 {{ template "chart.requirementsSection" . }}

ct.yaml

@@ -3,6 +3,6 @@ remote: origin
 target-branch: main
 chart-dirs:
   - charts
-helm-extra-args: '--values=tests/ci_values.yaml --timeout=600s'
+helm-extra-args: '--timeout=600s'
 helm-lint-extra-args: '--values=tests/ci_values.yaml'
 check-version-increment: false