Skip to content

Commit e8310d1

Browse files
BorisShekJ12934
authored andcommitted
Update AutoDiscovery documentation
Add information indicating that the `trivy-image-autodiscovery` ScanType is required for Container AutoDiscovery to function. Make it clear that Container AutoDiscovery is disabled by default and must be enabled manually. Correct a minor grammar issue in the Service AutoDiscovery documentation. Signed-off-by: Boris Shek <boris.shek@iteratec.com>
1 parent 91dbf07 commit e8310d1

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

documentation/docs/auto-discovery/container-auto-discovery.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ path: "docs/auto-discovery/container-auto-discovery"
99
sidebar_position: 3
1010
---
1111

12-
The Container AutoDiscovery will create a scheduled scan with the given parameters (see [readme](https://github.com/secureCodeBox/secureCodeBox/blob/main/auto-discovery/kubernetes/README.md) for config options) for each unique container image in a Kubernetes namespace. Currently it is only possible to scan public container images.
12+
The Container AutoDiscovery will create a `ScheduledScan` with the given parameters (see [readme](https://github.com/secureCodeBox/secureCodeBox/blob/main/auto-discovery/kubernetes/README.md) for config options) for each unique container image in a Kubernetes namespace. Currently it is only possible to scan public container images.
1313
It is currently disabled by default and must be enabled manually.
1414

1515
Assume that a namespace contains two pods that run a `nginx v1.5` container. The Container AutoDiscovery will only create a single scheduled scan for the _nginx_ containers, as both are identical.
@@ -22,15 +22,15 @@ If a pod consists of multiple containers, the above described logic will be appl
2222

2323
### Setup
2424

25-
[Trivy](/docs/scanners/trivy) is a container image scanner that is used by the Container AutoDiscovery. It has to be installed in the same namespace as the containers that you wish to scan. The following steps will install trivy in the `default` namespace:
25+
[Trivy](/docs/scanners/trivy) is a container image scanner that is used by the Container AutoDiscovery. It must be installed in the same namespace as the containers you wish to scan. It also uses a special `ScanType` called `trivy-image-autodiscovery` that should be set manually by installing. The following steps will install `Trivy` with the corresponding `ScanType` in the `default` namespace:
2626
```bash
27-
helm upgrade --install trivy oci://ghcr.io/securecodebox/helm/trivy
27+
helm upgrade --install trivy oci://ghcr.io/securecodebox/helm/trivy --set createAutoDiscoveryScanType=true
2828
```
2929

30-
#### Deactivation
30+
#### Activation
3131

32-
The Container AutoDiscovery is enabled by default but can be disabled manually.
32+
The Container AutoDiscovery is disabled by default and must be enabled manually.
3333

3434
```bash
35-
helm upgrade --namespace securecodebox-system --install auto-discovery-kubernetes oci://ghcr.io/securecodebox/helm/auto-discovery-kubernetes --set config.containerAutoDiscovery.enabled=false
35+
helm upgrade --namespace securecodebox-system --install auto-discovery-kubernetes oci://ghcr.io/securecodebox/helm/auto-discovery-kubernetes --set config.containerAutoDiscovery.enabled=true
3636
```

documentation/docs/auto-discovery/service-auto-discovery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ By default the Service AutoDiscovery creates [ZAP Advanced](../scanners/zap-adva
1818

1919
### Setup
2020

21-
By default the Service AutoDiscovery creates ScheduledScans using the [ZAP Advanced](/docs/scanners/zap-advanced) ScanType. It has to be installed in the same namespace as the containers that you wish to scan. The following steps will install zap-advanced in the `default` namespace:
21+
By default the Service AutoDiscovery creates ScheduledScans using the [ZAP Advanced](/docs/scanners/zap-advanced) `ScanType`. It must be installed in the same namespace as the containers you wish to scan. The following steps will install `zap-advanced` in the `default` namespace:
2222

2323
```bash
2424
helm upgrade --install zap-advanced oci://ghcr.io/securecodebox/helm/zap-advanced

0 commit comments

Comments
 (0)