Skip to content

Commit 92d324c

Browse files
committed
docs: update sysdig integration instruction
1 parent 63cc41f commit 92d324c

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

snyk-monitor/README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# snyk/kubernetes-monitor-chart #
1+
# snyk/kubernetes-monitor-private-fork-chart #
22

33
## Summary ##
44

@@ -25,13 +25,13 @@ abcd1234-abcd-1234-abcd-1234abcd1234
2525
```
2626
The Snyk Integration ID is used in the `--from-literal=integrationId=` parameter in the next step.
2727

28-
2. If you are not using any private registries, create a Kubernetes secret called `snyk-monitor` containing the Snyk Integration ID from the previous step running the following command:
28+
2. (Optional) If you are not using any private registries, create a Kubernetes secret called `snyk-monitor` containing the Snyk Integration ID from the previous step running the following command:
2929
```shell
3030
kubectl create secret generic snyk-monitor -n snyk-monitor --from-literal=dockercfg.json={} --from-literal=integrationId=abcd1234-abcd-1234-abcd-1234abcd1234
3131
```
3232
Continue to Helm installation instructions below.
3333

34-
3. If you're using a private registry, you should create a `dockercfg.json` file. The `dockercfg` file is necessary to allow the monitor to look up images in private registries. Usually your credentials can be found in `$HOME/.docker/config.json`. These must also be added to the `dockercfg.json` file.
34+
3. (Optional) If you're using a private registry, you should create a `dockercfg.json` file. The `dockercfg` file is necessary to allow the monitor to look up images in private registries. Usually your credentials can be found in `$HOME/.docker/config.json`. These must also be added to the `dockercfg.json` file.
3535

3636
Create a file named `dockercfg.json`. Store your credentials in there; it should look like this:
3737

@@ -77,12 +77,12 @@ Finally, create the secret in Kubernetes by running the following command:
7777
kubectl create secret generic snyk-monitor -n snyk-monitor --from-file=./dockercfg.json --from-literal=integrationId=abcd1234-abcd-1234-abcd-1234abcd1234
7878
```
7979

80-
4. If your private registry requires installing certificates (*.crt, *.cert, *.key only) please put them in a folder and create the following ConfigMap:
80+
4. (Optional) If your private registry requires installing certificates (*.crt, *.cert, *.key only) please put them in a folder and create the following ConfigMap:
8181
```shell
8282
kubectl create configmap snyk-monitor-certs -n snyk-monitor --from-file=<path_to_certs_folder>
8383
```
8484

85-
5. If you are using an insecure registry or your registry is using unqualified images, you can provide a `registries.conf` file. See [the documentation](https://github.com/containers/image/blob/master/docs/containers-registries.conf.5.md) for information on the format and examples.
85+
5. (Optional) If you are using an insecure registry or your registry is using unqualified images, you can provide a `registries.conf` file. See [the documentation](https://github.com/containers/image/blob/master/docs/containers-registries.conf.5.md) for information on the format and examples.
8686

8787
Create a file named `registries.conf`, see example adding an insecure registry:
8888

@@ -128,6 +128,31 @@ If '--reset-values' is specified, this is ignored.
128128

129129
If running with Operator Lifecycle Manager (OLM) then OLM will handle upgrades for you when you request to install the latest version. This applies to OpenShift (OCP) and regular installations of OLM.
130130

131+
## Sysdig Integration ##
132+
133+
We have partnered with Sysdig to enrich the issues detected by Snyk for workloads with runtime data provided by Sysdig.
134+
135+
In order for the integration with Sysdig to work, the Snyk monitor requires an extra Secret in the `snyk-monitor` namespace. The Secret name is `sysdig-eve-secret`.
136+
137+
Please refer to the [Sysdig Secret installation guide](https://docs.sysdig.com/en/docs/sysdig-secure/integrate-effective-vulnerability-exposure-with-snyk/#copy-the-sysdig-secret) to install the Secret. Once the Sysdig Secret is installed, you need to copy it over to the snyk-monitor namespace:
138+
139+
```bash
140+
kubectl get secret sysdig-eve-secret -n sysdig-agent -o yaml | grep -v '^\s*namespace:\s' | kubectl apply -n snyk-monitor -f -
141+
```
142+
143+
To enable Snyk to integrate with Sysdig and collect information about packages executed at runtime, use `--set sysdig.enabled=true` when installing the snyk-monitor:
144+
145+
```bash
146+
helm upgrade --install snyk-monitor snyk-charts/snyk-monitor \
147+
--namespace snyk-monitor \
148+
--set clusterName="Production cluster" \
149+
--set sysdig.enabled=true
150+
```
151+
152+
> NOTE: The above command should be executed right after installing Sysdig. This will upgrade or install the snyk monitor, to allow the detection of Sysdig in the cluster.
153+
154+
The snyk-monitor will now collect data from Sysdig every 4 hours.
155+
131156
## Setting up proxying ##
132157

133158
Proxying traffic through a forwarding proxy can be achieved by setting the following values in the Helm chart:

0 commit comments

Comments
 (0)