From 276d3b9a3eead986da32e885199e3853f2137972 Mon Sep 17 00:00:00 2001 From: Radhika Puthiyetath Date: Tue, 18 Jul 2023 19:53:16 +0000 Subject: [PATCH 1/3] feat(doc): Edit for clarity (DOC-3292) DOC-3292 --- charts/sysdig-stackdriver-bridge/README.md | 99 ++++++++++++---------- 1 file changed, 54 insertions(+), 45 deletions(-) diff --git a/charts/sysdig-stackdriver-bridge/README.md b/charts/sysdig-stackdriver-bridge/README.md index 2a0103b8c..f14874318 100644 --- a/charts/sysdig-stackdriver-bridge/README.md +++ b/charts/sysdig-stackdriver-bridge/README.md @@ -2,61 +2,81 @@ [Sysdig Stackdriver Bridge](https://docs.sysdig.com/en/kubernetes-audit-logging.html#UUID-f62c275e-389a-317f-2079-2c61d1f282a7_UUID-ded20060-405c-1f5f-4b3f-c18d20b5668d) is an extension of the Sysdig tool that reads audit logs from Stackdriver, reformats them to match the Kubernetes-native format, and sends the logs to a configurable webhook and to the Sysdig agent service. -## Introduction This chart adds the Sysdig Stackdriver Bridge application into a cluster using a simple `Deployment` with a `ConfigMap`. ## Prerequisites -- Sysdig should be deployed in the target Kubernetes cluster. -- You will need to create a secret that matches the value `secret.name` (`stackdriver-webhook-bridge` by default) that contains the key `key.json` with the value of the created GCP IAM Service Account for Sysdig to access Stackbridge. -- It is recommended to create this `Secret` in an out-of-band fashion in CI/CD, etc. - - Optionally, you can enable creation of the `Secret` via the chart by setting `secret.create=true` and providing the JSON data directly via `secret.data`. **This is not an advisable approach for production systems.** +- Sysdig is deployed in the target Kubernetes cluster. +- A secret that matches the value `secret.name` (`stackdriver-webhook-bridge` by default) is created. It should contain the `key.json` key with the value of the created GCP IAM Service Account for Sysdig to access Stackbridge. + - It is recommended to create this `Secret` in an out-of-band fashion in CI/CD, etc. + - Optionally, you can enable the creation of the `Secret` via the chart by setting `secret.create=true` and providing the JSON data directly via `secret.data`. **This is not an advisable approach for production systems.** -## Installing the Chart +## Install the Chart -To install the chart with the release name `my-release`, run: +To install the chart with the release name `my-release`: -```bash -$ helm repo add sysdiglabs https://sysdiglabs.github.io/charts/ -``` +1. Add the `sysdiglabs` Helm chart repository. -to add the `sysdiglabs` Helm chart repository. Then run: + ```bash + $ helm repo add sysdiglabs https://sysdiglabs.github.io/charts/ + ``` -```bash -$ helm install --name my-release sysdiglabs/sysdig-stackdriver-bridge -``` +2. Install `sysdig-stackdriver-bridge`: + + ```bash + $ helm install --name my-release sysdiglabs/sysdig-stackdriver-bridge + ``` When done, the application should be running within your cluster if properly configured. -> **Tip**: List all releases using `helm list` +> **Tip**: List all the releases using the `helm list` command. -## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +## Verify the Integrity and Origin -```bash -$ helm delete my-release -``` +Sysdig Helm Charts are signed so you can verify the integrity and origin of each chart. To verify the chart: -The command removes all the Kubernetes components associated with the chart and deletes the release. - -### Verify the integrity and origin -Sysdig Helm Charts are signed so users can verify the integrity and origin of each chart, the steps are as follows: - -#### Import the Public Key +### Import the Public Key ```console $ curl -o "/tmp/sysdig_public.gpg" "https://charts.sysdig.com/public.gpg" $ gpg --import /tmp/sysdig_public.gpg ``` -#### Verify the chart +### Verify the Chart -To check the integrity and the origin of the charts you can now append the `--verify` flag to the `install`, `upgrade` and `pull` helm commands. +To check the integrity and the origin of the charts you can now append the `--verify` flag to the `install`, `upgrade`, and `pull` helm commands. ## Configuration +You can use the Helm chart to update the default Sysdig Stackdriver Bridge configurations by using either of the following: + +- Using the key-value pair: `--set sysdig.settings.key = value` +- `values.yaml` file + +### Using the Key-Value Pair + +Specify each parameter using the `--set key=value[,key=value]` argument to the `helm install` command. + +For example: + +```bash +$ helm install --name my-release \ + --set bridge.forwardURL=FOO,bridge.pollInterval=60s \ + sysdiglabs/sysdig-stackdriver-bridge +``` + +### Using values.yaml + +The `values.yaml` file specifies the values for the Sysdig Stackdriver Bridge configuration parameters. You can add the configuration to the `values.yaml` file, then use it in the `helm install` command. + +```bash +$ helm install --name my-release -f values.yaml sysdiglabs/sysdig-stackdriver-bridge +``` + +## Configuration Parameters + The following table lists the configurable parameters of the Sysdig Stackdriver Bridge chart and their default values. | Parameter | Description | Default | @@ -80,31 +100,20 @@ The following table lists the configurable parameters of the Sysdig Stackdriver | `annotations` | Pod annotations | `{}` | | `tolerations` | Toleration labels for pod assignment | `[]` | -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```bash -$ helm install --name my-release \ - --set bridge.forwardURL=FOO,bridge.pollInterval=60s \ - sysdiglabs/sysdig-stackdriver-bridge -``` +## Uninstalling the Chart -Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example: +To uninstall/delete the `my-release` deployment: ```bash -$ helm install --name my-release -f values.yaml sysdiglabs/sysdig-stackdriver-bridge +$ helm delete my-release ``` -> **Tip**: You can use the default [values.yaml](values.yaml) +The command removes all the Kubernetes components associated with the chart and deletes the release. + ## Support -For getting support from the Sysdig team, you should refer to the official [Sysdig Support page](https://sysdig.com/support). +For getting support from the Sysdig team, see [Sysdig Support page](https://sysdig.com/support). -In addition to this, you can browse the documentation for the different -components of the Sysdig Platform: -* [Sysdig Monitor](https://app.sysdigcloud.com) -* [Sysdig Secure](https://secure.sysdig.com) -* [Platform Documentation](https://docs.sysdig.com/en/sysdig-platform.html) -* [Monitor Documentation](https://docs.sysdig.com/en/sysdig-monitor.html) -* [Secure Documentation](https://docs.sysdig.com/en/sysdig-secure.html) From f8eb9e92a80215c613f7481f09e518d675af7991 Mon Sep 17 00:00:00 2001 From: Radhika Puthiyetath Date: Tue, 18 Jul 2023 13:25:44 -0700 Subject: [PATCH 2/3] Update README.md --- charts/sysdig-stackdriver-bridge/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/sysdig-stackdriver-bridge/README.md b/charts/sysdig-stackdriver-bridge/README.md index f14874318..81cb8461c 100644 --- a/charts/sysdig-stackdriver-bridge/README.md +++ b/charts/sysdig-stackdriver-bridge/README.md @@ -16,7 +16,7 @@ This chart adds the Sysdig Stackdriver Bridge application into a cluster using a To install the chart with the release name `my-release`: -1. Add the `sysdiglabs` Helm chart repository. +1. Add the `sysdiglabs` Helm chart repository. ```bash $ helm repo add sysdiglabs https://sysdiglabs.github.io/charts/ From d5daaf81c0d6f265e9a21f52a943bb10c87647fd Mon Sep 17 00:00:00 2001 From: Alberto Barba Date: Wed, 19 Jul 2023 10:19:28 +0200 Subject: [PATCH 3/3] chore(sysdig-stackdriver-bridge): remove extra new line at the end of README.md and bump chart version --- charts/sysdig-stackdriver-bridge/Chart.yaml | 2 +- charts/sysdig-stackdriver-bridge/README.md | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/charts/sysdig-stackdriver-bridge/Chart.yaml b/charts/sysdig-stackdriver-bridge/Chart.yaml index 77ca825d4..cbe0f6f33 100644 --- a/charts/sysdig-stackdriver-bridge/Chart.yaml +++ b/charts/sysdig-stackdriver-bridge/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v1 name: sysdig-stackdriver-bridge -version: 1.2.0 +version: 1.2.1 appVersion: 0.0.7 description: Sysdig Monitor and Secure agent keywords: diff --git a/charts/sysdig-stackdriver-bridge/README.md b/charts/sysdig-stackdriver-bridge/README.md index 81cb8461c..600c1bf8d 100644 --- a/charts/sysdig-stackdriver-bridge/README.md +++ b/charts/sysdig-stackdriver-bridge/README.md @@ -115,5 +115,3 @@ The command removes all the Kubernetes components associated with the chart and ## Support For getting support from the Sysdig team, see [Sysdig Support page](https://sysdig.com/support). - -