Addresses multiple bugs in Quay docs (#1146)

Co-authored-by: Steven Smith <stevsmit@stevsmit-thinkpadt14gen4.remote.csb>
quay · Nov 5, 2024 · 128443b · 128443b
1 parent 6008606
commit 128443b
Show file tree

Hide file tree

Showing 12 changed files with 26 additions and 14 deletions.
diff --git a/modules/backing-up-red-hat-quay-operator.adoc b/modules/backing-up-red-hat-quay-operator.adoc
@@ -227,7 +227,7 @@ quayregistry-quay-database
 +
 [source,terminal]
 ----
-$ oc exec quayregistry-quay-database-59f54bb7-58xs7 -- /usr/bin/pg_dump -C quayregistry-quay-database  > backup.sql
+$ oc -n <quay_namespace> exec quayregistry-quay-database-59f54bb7-58xs7 -- /usr/bin/pg_dump -C quayregistry-quay-database  > backup.sql
 ----
 
 [id="backing-up-managed-object-storage"]

diff --git a/modules/clair-standalone-quay-config.adoc b/modules/clair-standalone-quay-config.adoc
@@ -42,7 +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: 8GB <1>
+SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE: 8G <1>
 ...
 ----
-<1> The recommended maximum of `SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE` is `10GB`.
+<1> The recommended maximum of `SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE` is `10G`.
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`. The default is `8GB`, and the maximum recommended is `10GB`.
+| *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 `8G`, and the maximum recommended is `10G`. Accepted values are `B`, `K`, `M`, `T`, and `G`.
  +
- **Default**: `8GB`
+ **Default**: `8G`
 |===
 
 [id="reindexing-clair-v4"]
@@ -75,7 +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: 8GB <1>
+SECURITY_SCANNER_V4_INDEX_MAX_LAYER_SIZE: 8G <1>
 ...
 ----
-<1> Recommended maximum is `10GB`.
+<1> Recommended maximum is `10G`.
diff --git a/modules/config-fields-storage-swift.adoc b/modules/config-fields-storage-swift.adoc
@@ -13,7 +13,10 @@ DISTRIBUTED_STORAGE_CONFIG:
       swift_password: swift_password_here
       swift_container: swift_container_here
       auth_url: https://example.org/swift/v1/quay
-      auth_version: 1
+      auth_version: 3
+      os_options:
+        tenant_id: <osp_tenant_id_here>
+        user_domain_name: <osp_domain_name_here>
       ca_cert_path: /conf/stack/swift.cert"
       storage_path: /datastorage/registry
 DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS: []

diff --git a/modules/config-fields-tag-expiration.adoc b/modules/config-fields-tag-expiration.adoc
@@ -15,7 +15,7 @@ The following tag expiration configuration fields are available with {productnam
 (Required) | Array of string | If enabled, the options that users can select for expiration of tags in their namespace. + 
  + 
 **Pattern:** + 
-`^[0-9]+(w\|m\|d\|h\|s)$`
+`^[0-9]+(y\|w\|m\|d\|h\|s)$`
 | **DEFAULT_TAG_EXPIRATION** +
 (Required) | String | The default, configurable tag expiration time for time machine. + 
  + 
@@ -66,6 +66,7 @@ TAG_EXPIRATION_OPTIONS:
     - 1w
     - 2w
     - 4w
+    - 3y
 # ...
 ----
 

diff --git a/modules/config-file-minimal.adoc b/modules/config-file-minimal.adoc
@@ -46,6 +46,7 @@ TAG_EXPIRATION_OPTIONS:
     - 1w
     - 2w
     - 4w
+    - 3y
 USER_EVENTS_REDIS:
     host: quay-server.example.com
     port: 6379

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`. The default is `8GB`, and the maximum recommended is `10GB`.
+| *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 `8G`, and the maximum recommended is `10G`.
  +
- *Example*: `8GB`
+ *Example*: `8G`
 |===
diff --git a/modules/operator-config-ui-updated.adoc b/modules/operator-config-ui-updated.adoc
@@ -22,5 +22,6 @@ SUPER_USERS:
 TAG_EXPIRATION_OPTIONS:
 - 2w
 - 4w
+- 3y
 ---
 ----
diff --git a/modules/operator-preconfigure.adoc b/modules/operator-preconfigure.adoc
@@ -43,6 +43,7 @@ TAG_EXPIRATION_OPTIONS:
     - 1w
     - 2w
     - 4w
+    - 3y
 USER_EVENTS_REDIS:
     host: <quay-server.example.com>
     port: 6379

diff --git a/modules/operator-unmanaged-storage.adoc b/modules/operator-unmanaged-storage.adoc
@@ -106,7 +106,10 @@ DISTRIBUTED_STORAGE_CONFIG:
       swift_password: swift_password_here
       swift_container: swift_container_here
       auth_url: https://example.org/swift/v1/quay
-      auth_version: 1
+      auth_version: 3
+      os_options:
+        tenant_id: <osp_tenant_id_here>
+        user_domain_name: <osp_domain_name_here>
       ca_cert_path: /conf/stack/swift.cert"
       storage_path: /datastorage/registry
 DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS: []

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`. The default is `8GB`, and the maximum recommended is `10GB`.
+| *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 `8G`, and the maximum recommended is `10G`.
  +
- *Example*: `8GB`
+ *Example*: `8G`
 |===
 
 [id="new-api-endpoints-312"]

diff --git a/modules/storage-health-check-geo-repl.adoc b/modules/storage-health-check-geo-repl.adoc
@@ -57,6 +57,8 @@ DISTRIBUTED_STORAGE_CONFIG:
         - auth_url: http://10.0.50.50/identity          # driver parameters
           auth_version: "3"
           os_options:
+            tenant_id: <osp_tenant_id_here>
+            user_domain_name: <osp_domain_name_here>
 DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS:
     - default
     - swift