Merge pull request #1186 from secureCodeBox/docs/fix-incorrect-scan-mode-reference

the-simmon · web-flow · commit 102d8bf152ea · 2022-05-23T17:31:19.000+02:00
Fix documented values for resourceInclusion modes
diff --git a/auto-discovery/kubernetes/.helm-docs.gotmpl b/auto-discovery/kubernetes/.helm-docs.gotmpl
@@ -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)
 
@@ -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`.
 
diff --git a/auto-discovery/kubernetes/README.md b/auto-discovery/kubernetes/README.md
@@ -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)
 
@@ -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`.
 
diff --git a/auto-discovery/kubernetes/docs/README.ArtifactHub.md b/auto-discovery/kubernetes/docs/README.ArtifactHub.md
@@ -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)
 
@@ -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`.
 
