Skip to content

Commit

Permalink
doc(cloud-scanning): Edit for Consistency (#1224)
Browse files Browse the repository at this point in the history
Co-authored-by: Alberto Barba <[email protected]>
  • Loading branch information
radhikapc and AlbertoBarba authored Jul 12, 2023
1 parent caab5c3 commit 2df07ab
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 22 deletions.
2 changes: 1 addition & 1 deletion charts/cloud-scanning/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: cloud-scanning
description: Sysdig Cloud Scanning

type: application
version: 0.4.0
version: 0.4.1
appVersion: 0.11.3
home: https://sysdiglabs.github.io/cloud-connector

Expand Down
52 changes: 31 additions & 21 deletions charts/cloud-scanning/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Cloud Scanning

This chart deploys the Sysdig Cloud scanning on your Kubernetes cluster.
This chart deploys the Sysdig Cloud scanning on your Kubernetes cluster. See Cloud Scanning configuration on [Cloud Scanning documentation](https://sysdiglabs.github.io/cloud-connector/scanning.html) for more information.

> ⚠️ **Deprecated Module**
> <br>Use [Cloud-Connector `scanning`](https://charts.sysdig.com/charts/cloud-connector/#scanners) configuration instead of this module
## Installing the Chart

Add Sysdig Helm charts repository and deploy the chart:
Add the Sysdig Helm charts repository and deploy the chart:

```
$ helm repo add sysdig https://charts.sysdig.com
Expand All @@ -25,12 +25,39 @@ $ 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, append the `--verify` flag to the `install`, `upgrade`, and `pull` helm commands.

## Configuration

You can use the Helm chart to update the default Cloud Scanning 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 my-release \
--set sysdig.secureAPIToken=YOUR-KEY-HERE \
sysdig/cloud-scanning
```

### Using values.yaml

The `values.yaml` file specifies the values for the Cloud Scanning configuration parameters. You can add the configuration to the `values.yaml` file, then use it in the `helm install` command.

```bash
$ helm install my-release -f values.yaml sysdig/cloud-scanning
```

## Configuration Parameters

The following table lists the configurable parameters of the Sysdig Cloud Scanning
chart and their default values:

Expand Down Expand Up @@ -72,20 +99,3 @@ chart and their default values:
| `codeBuildProject` | Name of the CodeBuild exeuting the scanner | ` ` |
| `sqsQueueUrl` | URL of the SQS queue for CloudTrail events | ` ` |
| `secureAPITokenSecret` | Secret name that contains the API Token for Secure (required to inline-scan without leaking the secret) | ` ` |


Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

```bash
$ helm install my-release \
--set sysdig.secureAPIToken=YOUR-KEY-HERE \
sysdig/cloud-scanning
```

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

```bash
$ helm install my-release -f values.yaml sysdig/cloud-scanning
```

You have more details about Cloud Scanning configuration on [Cloud Scanning documentation](https://sysdiglabs.github.io/cloud-connector/scanning.html)

0 comments on commit 2df07ab

Please sign in to comment.