Updates security scanner env var to include max rec (#1089)

Co-authored-by: Steven Smith <stevsmit@stevsmit-thinkpadt14gen4.remote.csb>
quay · Sep 9, 2024 · 7f56843 · 7f56843
1 parent 15eeb5a
commit 7f56843
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 9 deletions.
diff --git a/modules/clair-standalone-quay-config.adoc b/modules/clair-standalone-quay-config.adoc
@@ -42,6 +42,7 @@ SECURITY_SCANNER_V4_MANIFEST_CLEANUP: true
 SECURITY_SCANNER_V4_ENDPOINT: http://quay-server.example.com:8081
 SECURITY_SCANNER_V4_PSK: MTU5YzA4Y2ZkNzJoMQ==
 SERVER_HOSTNAME: quay-server.example.com
-SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE: 8G
+SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE: 8GB <1>
 ...
 ----
+<1> The recommended maximum of `SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE` is `10GB`.
diff --git a/modules/config-fields-scanner.adoc b/modules/config-fields-scanner.adoc
@@ -44,9 +44,9 @@
 
 | *NOTIFICATION_MIN_SEVERITY_ON_NEW_INDEX* | String | Set minimal security level for new notifications on detected vulnerabilities. Avoids creation of large number of notifications after first index. If not defined, defaults to `High`. Available options include `Critical`, `High`, `Medium`, `Low`, `Negligible`, and `Unknown`.
 
-| *SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE* | String | The maximum layer size allowed for indexing. If the layer size exceeds the configured size, the {productname} UI returns the following message: `The manifest for this tag has layer(s) that are too large to index by the Quay Security Scanner`.
+| *SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE* | String | The maximum layer size allowed for indexing. If the layer size exceeds the configured size, the {productname} UI returns the following message: `The manifest for this tag has layer(s) that are too large to index by the Quay Security Scanner`. The default is `8GB`, and the maximum recommended is `10GB`.
  +
- *Example*: `8G`
+ **Default**: `8GB`
 |===
 
 [id="reindexing-clair-v4"]
@@ -75,6 +75,7 @@ SECURITY_SCANNER_V4_MANIFEST_CLEANUP: true
 SECURITY_SCANNER_V4_ENDPOINT: http://quay-server.example.com:8081
 SECURITY_SCANNER_V4_PSK: MTU5YzA4Y2ZkNzJoMQ==
 SERVER_HOSTNAME: quay-server.example.com
-SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE: 8G
+SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE: 8GB <1>
 ...
-----
+----
+<1> Recommended maximum is `10GB`.
diff --git a/modules/config-updates-312.adoc b/modules/config-updates-312.adoc
@@ -126,7 +126,7 @@ The following configuration field has been added for the Clair security scanner,
 
 |===
 | Field | Type | Description
-| *SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE* | String | The maximum layer size allowed for indexing. If the layer size exceeds the configured size, the {productname} UI returns the following message: `The manifest for this tag has layer(s) that are too large to index by the Quay Security Scanner`.
+| *SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE* | String | The maximum layer size allowed for indexing. If the layer size exceeds the configured size, the {productname} UI returns the following message: `The manifest for this tag has layer(s) that are too large to index by the Quay Security Scanner`. The default is `8GB`, and the maximum recommended is `10GB`.
  +
- *Example*: `8G`
+ *Example*: `8GB`
 |===
diff --git a/modules/rn_3_12_0.adoc b/modules/rn_3_12_0.adoc
@@ -281,9 +281,9 @@ The following configuration field has been added for the Clair security scanner,
 
 |===
 | Field | Type | Description
-| *SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE* | String | The maximum layer size allowed for indexing. If the layer size exceeds the configured size, the {productname} UI returns the following message: `The manifest for this tag has layer(s) that are too large to index by the Quay Security Scanner`.
+| *SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE* | String | The maximum layer size allowed for indexing. If the layer size exceeds the configured size, the {productname} UI returns the following message: `The manifest for this tag has layer(s) that are too large to index by the Quay Security Scanner`. The default is `8GB`, and the maximum recommended is `10GB`.
  +
- *Example*: `8G`
+ *Example*: `8GB`
 |===
 
 [id="new-api-endpoints-312"]