From 7cd671ed81cb3e24693178b4da59c50f34ba6e32 Mon Sep 17 00:00:00 2001 From: Jina Jain Date: Mon, 14 Oct 2024 14:22:18 -0700 Subject: [PATCH] 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 | 6 +++-- README.md | 16 +++++++++++++ charts/splunk-synthetics-runner/README.md | 24 +++++++++++++++++-- .../splunk-synthetics-runner/README.md.gotmpl | 24 +++++++++++++++++-- ct.yaml | 2 +- 5 files changed, 65 insertions(+), 7 deletions(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 07d7d5d..805edf2 100644 --- a/.github/workflows/test.yaml +++ b/.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 diff --git a/README.md b/README.md index 737570c..0f4bb30 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ +--- + +

+ + Build Status + + + GitHub release (latest by date including pre-releases) + +

+ +--- # 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). diff --git a/charts/splunk-synthetics-runner/README.md b/charts/splunk-synthetics-runner/README.md index 2e94928..5d74f96 100644 --- a/charts/splunk-synthetics-runner/README.md +++ b/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= +helm install my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.create=true,synthetics.secret.runnerToken= ``` ### 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= +helm upgrade my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.create=true,synthetics.secret.runnerToken= +``` + +### 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= | kubectl apply -f - ``` ## Values diff --git a/charts/splunk-synthetics-runner/README.md.gotmpl b/charts/splunk-synthetics-runner/README.md.gotmpl index ef34b22..71b09ed 100644 --- a/charts/splunk-synthetics-runner/README.md.gotmpl +++ b/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= +helm install my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.create=true,synthetics.secret.runnerToken= ``` ### 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= +helm upgrade my-splunk-synthetics-runner synthetics-helm-charts/splunk-synthetics-runner --set=synthetics.secret.create=true,synthetics.secret.runnerToken= +``` + +### 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= | kubectl apply -f - ``` {{ template "chart.requirementsSection" . }} diff --git a/ct.yaml b/ct.yaml index 369c67c..867b781 100644 --- a/ct.yaml +++ b/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