Skip to content

Fix documented values for resourceInclusion modes #1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
the-simmon merged 1 commit into from
May 23, 2022
Merged

Fix documented values for resourceInclusion modes #1186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions auto-discovery/kubernetes/.helm-docs.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The three different modes are:

1. `enabled-per-namespace` (default): [See section](#enabled-per-namespace-mode-default)
2. `enabled-per-resource`: [See section](#enabled-per-resource-mode)
3. `scan-all`: [See section](#scan-all-mode)
3. `all`: [See section](#all-mode)

#### Enabled per Namespace Mode (default)

Expand Down Expand Up @@ -94,9 +94,9 @@ This mode will start scans for every resources with the annotation `auto-discove
kubectl -n juice-shop annotate service juice-shop auto-discovery.securecodebox.io/enabled=true
```

#### Scan All Mode
#### All Mode

Enable this by setting `config.resourceInclusion.mode=scan-all`.
Enable this by setting `config.resourceInclusion.mode=all`.

This mode will start scans for **every** resources in the cluster **unless** it has the annotation `auto-discovery.securecodebox.io/ignore=true`.

Expand Down
6 changes: 3 additions & 3 deletions auto-discovery/kubernetes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The three different modes are:

1. `enabled-per-namespace` (default): [See section](#enabled-per-namespace-mode-default)
2. `enabled-per-resource`: [See section](#enabled-per-resource-mode)
3. `scan-all`: [See section](#scan-all-mode)
3. `all`: [See section](#all-mode)

#### Enabled per Namespace Mode (default)

Expand Down Expand Up @@ -115,9 +115,9 @@ This mode will start scans for every resources with the annotation `auto-discove
kubectl -n juice-shop annotate service juice-shop auto-discovery.securecodebox.io/enabled=true
```

#### Scan All Mode
#### All Mode

Enable this by setting `config.resourceInclusion.mode=scan-all`.
Enable this by setting `config.resourceInclusion.mode=all`.

This mode will start scans for **every** resources in the cluster **unless** it has the annotation `auto-discovery.securecodebox.io/ignore=true`.

Expand Down
6 changes: 3 additions & 3 deletions auto-discovery/kubernetes/docs/README.ArtifactHub.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The three different modes are:

1. `enabled-per-namespace` (default): [See section](#enabled-per-namespace-mode-default)
2. `enabled-per-resource`: [See section](#enabled-per-resource-mode)
3. `scan-all`: [See section](#scan-all-mode)
3. `all`: [See section](#all-mode)

#### Enabled per Namespace Mode (default)

Expand Down Expand Up @@ -107,9 +107,9 @@ This mode will start scans for every resources with the annotation `auto-discove
kubectl -n juice-shop annotate service juice-shop auto-discovery.securecodebox.io/enabled=true
```

#### Scan All Mode
#### All Mode

Enable this by setting `config.resourceInclusion.mode=scan-all`.
Enable this by setting `config.resourceInclusion.mode=all`.

This mode will start scans for **every** resources in the cluster **unless** it has the annotation `auto-discovery.securecodebox.io/ignore=true`.

Expand Down