From e091b30e14d67fe5b36f9996ad577fc218c8be20 Mon Sep 17 00:00:00 2001 From: dmesser Date: Tue, 21 Jun 2022 14:12:54 +0200 Subject: [PATCH 01/37] refining backup and restore procedures --- modules/backing-up-and-restoring-intro.adoc | 4 +- modules/backing-up-red-hat-quay.adoc | 146 +++++++++++++----- modules/restoring-red-hat-quay.adoc | 161 +++++++++++++++----- 3 files changed, 230 insertions(+), 81 deletions(-) diff --git a/modules/backing-up-and-restoring-intro.adoc b/modules/backing-up-and-restoring-intro.adoc index 56358cda8..117728500 100644 --- a/modules/backing-up-and-restoring-intro.adoc +++ b/modules/backing-up-and-restoring-intro.adoc @@ -1,4 +1,4 @@ [[backing-up-and-restoring-intro]] -= Backing up and restoring Red Hat Quay on an OpenShift Container Platform deployment += Backing up and restoring {productname} managed by the {productname} operator -Use the content within this section to back up and restore {productname} on an OpenShift Container Platform deployment. +Use the content within this section to back up and restore {productname} when managed via the {productname} operator on OpenShift Container Platform. diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 4f616844d..9e85bd074 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -1,14 +1,21 @@ [[backing-up-red-hat-quay]] -== Backing up Red Hat Quay +== Backing up {productname} -This procedure is exclusively for OpenShift Container Platform and NooBaa deployments. +This procedure describees how to create a backup of {productname} deployed on OpenShift Container Platform using the {productname} operator .Prerequisites -* A {productname} deployment on OpenShift Container Platform. +* A {productname} deployment on OpenShift Container Platform using the {productname} operator that is healthy (status condition `Available` is set to `true`) +* The components `quay`, `postgres` and `objectstorage` are set to `managed: true` +* If the component `clair` is set to `managed: true` the component `clairpostgres` is also set to `managed: true` (starting if {productname} operator v3.7 or later) +[NOTE] +==== +If your deployment contains partially unmanaged database or storage components and you are using external services for Postgres or S3-compatible object storage to run your {productname} deployment, you must refer to the service provider or vendor documentation to create a backup of the data. +You can refer to the tools described in this guide to get a starting point on how to backup your external Postgres database or object storage. +==== -.Procedure +=== {productname} configuration backup . Backup the `QuayRegistry` custom resource by exporting it: @@ -33,7 +40,7 @@ $ oc get quayregistry -n -o yaml > quay-re + [NOTE] ==== -If you are running a version older than Red Hat Quay 3.7.0, this step can be skipped. Some secrets are automatically generated while deploying Quay for the first time. These are stored in a secret called `-quay-registry-managed-secret-keys` in the QuayRegistry namespace. +If you are running a version older than {productname} 3.7.0, this step can be skipped. Some secrets are automatically generated while deploying Quay for the first time. These are stored in a secret called `-quay-registry-managed-secret-keys` in the namespace of the `QuayRegistry` resource. ==== + [source,terminal] @@ -41,7 +48,7 @@ If you are running a version older than Red Hat Quay 3.7.0, this step can be ski $ oc get secret -n -quay-registry-managed-secret-keys -o yaml > managed-secret-keys.yaml ---- -. Edit the the resulting `managed-secret-keys.yaml` file and remove all owner references. Your `managed-secret-keys.yaml` file should look similar to the following: +. Edit the the resulting `managed-secret-keys.yaml` file and remove the entry `metadata.ownerReferences`. Your `managed-secret-keys.yaml` file should look similar to the following: + [source,yaml] ---- @@ -69,21 +76,54 @@ All information under the `data` property should remain the same. $ oc get secret -n $(oc get quayregistry -n -o jsonpath='{.spec.configBundleSecret}') -o yaml > config-bundle.yaml ---- -. Scale down the Quay the Quay Operator: +=== Scale down your {productname} deployment + +[NOTE] +==== +This step is needed to create a consistent backup of the state of your {productname} deployment. Do not omit this step, including in setups where Postgres databases and/or S3-compatible object storage are provided by external services (unmanaged by the operator). +==== + +. *For operator version 3.7 and newer*: scale down the {productname} deployment by disabling auto scaling and overriding the replica count for Quay, Mirror workers and Clair (if managed). Your `QuayRegistry` resource should look similar to the following: + -[source,terminal] ----- -$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n +[source,yaml] ---- +apiVersion: quay.redhat.com/v1 +kind: QuayRegistry +metadata: + name: registry + namespace: ns +spec: + components: + … + - kind: horizontalpodautoscaler + managed: false <1> + - kind: quay + managed: true + overrides: <2> + replicas: 0 + - kind: clair + managed: true + overrides: + replicas: 0 + - kind: mirror + managed: true + overrides: + replicas: 0 + … +---- +<1> disable auto scaling of Quay, Clair and Mirroring workers +<2> set the replica count to 0 for components accessing the database and objectstorage -. Scale down the Quay namespace: +. *For operator version 3.6 and earlier*: scale down the {productname} deployment by scaling down the {productname} operator first and then the managed {productname} resources: + [source,terminal] ---- +$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n + $ oc scale --replicas=0 deployment $(oc get deployment -n -l quay-component=quay -o jsonpath='{.items[0].metadata.name}') -n ---- -. Wait for the `registry-quay-app` pods to disappear. You can check their status by running the following command: +. Wait for the `registry-quay-app`, `registry-quay-mirror` and `registry-clair-app` pods (depending on which components you set to be managed by operator) to disappear. You can check their status by running the following command: + [source,terminal] ---- @@ -96,11 +136,16 @@ Example output: ---- registry-quay-config-editor-77847fc4f5-nsbbv 1/1 Running 0 9m1s registry-quay-database-66969cd859-n2ssm 1/1 Running 0 6d1h -registry-quay-mirror-758fc68ff7-5wxlp 1/1 Running 0 8m29s -registry-quay-mirror-758fc68ff7-lbl82 1/1 Running 0 8m29s registry-quay-redis-7cc5f6c977-956g8 1/1 Running 0 5d21h ---- +=== {productname} managed database backup + +[NOTE] +==== +If your {productname} deployment is configured with external (unmanged) Postgres database(s), please refer to your vendor's documentation on how to create a consistent backup of these databases. +==== + . Identify the Quay PostgreSQL pod name: + [source,terminal] @@ -109,6 +154,7 @@ $ oc get pod -l quay-component=postgres -n -o jsonpath='{.items ---- + Exampe output: ++ [source,terminal] ---- quayregistry-quay-database-59f54bb7-58xs7 @@ -129,6 +175,15 @@ quayregistry-quay-database $ oc exec quayregistry-quay-database-59f54bb7-58xs7 -- /usr/bin/pg_dump -C quayregistry-quay-database > backup.sql ---- +=== {productname} managed object storage backup + +The follow instructions apply to both configurations, standalone multi-cloud object gateway and OpenShift Data Foundations storage that the {productname} operator provisioned a S3 object storage bucket from, via the `ObjectStorageBucketClaim` API. + +[NOTE] +==== +If your {productname} deployment is configured with external (unmanged) object storage, please refer to your vendor's documentation on how to create a copy of the content of Quay's storage bucket. +==== + . Decode and export the `AWS_ACCESS_KEY_ID`: + [source,terminal] @@ -148,39 +203,54 @@ $ export AWS_SECRET_ACCESS_KEY=$(oc get secret -l app=noobaa -n [source,terminal] ---- $ mkdir blobs ----- -+ -[source,terminal] -+ ----- + $ aws s3 sync --no-verify-ssl --endpoint https://$(oc get route s3 -n openshift-storage -o jsonpath='{.spec.host}') s3://$(oc get cm -l app=noobaa -n -o jsonpath='{.items[0].data.BUCKET_NAME}') ./blobs ---- - [NOTE] ==== You can also use link:https://rclone.org/[rclone] or link:https://s3tools.org/s3cmd[sc3md] instead of the AWS command line utility. ==== -. Scale up the Quay the Quay Operator: +=== Scale the {productname} deployment back up + +. *For operator version 3.7 and newer*: scale up the {productname} deployment by re-enabling auto scaling (if desired) and removing the replica overrides for Quay, Mirror workers and Clair as appliable. Your `QuayRegistry` resource should look similar to the following: + -[source,terminal] ----- -$ oc scale --replicas=1 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n +[source,yaml] ---- +apiVersion: quay.redhat.com/v1 +kind: QuayRegistry +metadata: + name: registry + namespace: ns +spec: + components: + … + - kind: horizontalpodautoscaler + managed: true <1> + - kind: quay <2> + managed: true + - kind: clair + managed: true + - kind: mirror + managed: true + … +---- +<1> re-enables auto scaling of Quay, Clair and Mirroring workers again (if desired) +<2> replica overrides are removed again to scale the Quay components back up -. Scale up the Quay namespace: +. *For operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} operator again: + [source,terminal] ---- -$ oc scale --replicas=1 deployment $(oc get deployment -n -l quay-component=quay -o jsonpath='{.items[0].metadata.name}') -n +$ oc scale --replicas=1 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n ---- -. Check the status of the Operator: +. Check the status of the {productname} deployment: + [source,terminal] ---- -$ oc get quayregistry -n -o yaml +$ oc wait quayregistry registry--for=condition=Available=true ---- + Example output: @@ -191,22 +261,16 @@ apiVersion: quay.redhat.com/v1 kind: QuayRegistry metadata: ... - name: example-registry + name: registry namespace: ... spec: - components: - - kind: quay - managed: true ... - - kind: clairpostgres - managed: true - configBundleSecret: init-config-bundle-secret status: - configEditorCredentialsSecret: example-registry-quay-config-editor-credentials-fg2gdgtm24 - configEditorEndpoint: https://example-registry-quay-config-editor-quay-enterprise.apps.docs.gcp.quaydev.org - currentVersion: 3.7.0 - lastUpdated: 2022-05-11 13:28:38.199476938 +0000 UTC - registryEndpoint: https://example-registry-quay-quay-enterprise.apps.docs.gcp.quaydev.org - 0 5d21h + - lastTransitionTime: '2022-06-20T05:31:17Z' + lastUpdateTime: '2022-06-20T17:31:13Z' + message: All components reporting as healthy + reason: HealthChecksPassing + status: 'True' + type: Available ---- diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index 3d8d9d2e0..94289686b 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -1,54 +1,118 @@ [[restoring-up-red-hat-quay]] -== Restoring Red Hat Quay +== Restoring {productname} -This procedure is used to restore {productname} when the Red Hat Quay Operator manages the database. It should be performed after a backup of your Quay registry has been performed. +This procedure is used to restore {productname} when the {productname} Quay Operator manages the database. It should be performed after a backup of your {productname} registry has been performed. See the section Refer to xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] for more information. .Prerequisites -* {productname} is deployed on OpenShift Container Platform using the Quay Operator. +* {productname} is deployed on OpenShift Container Platform using the {productname} operator. +* A backup of the {productname} configuration managed by the {productname} operator has been created following the instructions in the xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] section * Your {productname} database has been backed up. +* The object storage bucket used by {productname} has been backed up. +* The components `quay`, `postgres` and `objectstorage` are set to `managed: true` +* If the component `clair` is set to `managed: true` the component `clairpostgres` is also set to `managed: true` (starting if {productname} operator v3.7 or later) +* there is no running {productname} deployment managed by the {productname} operator in the target namespace on your OpenShift Container Platform cluster -.Procedure +[NOTE] +==== +If your deployment contains partially unmanaged database or storage components and you are using external services for Postgres or S3-compatible object storage to run your {productname} deployment, you must refer to the service provider or vendor documentation to restore their data from a backup prior to restore {productname} +==== + +=== Restoring {productname} and its configuration from a backup +[NOTE] +==== +These instructions assume you have followed the process in the xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] guide and create the backup files with the same names. +==== -. Restore the backed up Quay configuration and the randomly generated keys: +. Restore the backed up Quay configuration and the generated keys from the backup + [source,terminal] ---- $ oc create -f ./config-bundle.yaml ----- -+ -[source,terminal] ----- + $ oc create -f ./managed-secret-keys.yaml ---- + -[NOTE] +[IMPORTANT] ==== If you receive the error `Error from server (AlreadyExists): error when creating "./config-bundle.yaml": secrets "config-bundle-secret" already exists`, you must delete your exist resource with `$ oc delete Secret config-bundle-secret -n ` and recreate it with `$ oc create -f ./config-bundle.yaml`. ==== -. Restore the QuayRegistry custom resource: +. Restore the `QuayRegistry` custom resource: + [source,terminal] ---- $ oc create -f ./quay-registry.yaml ---- -. Scale down the Quay the Quay Operator: +. Check the status of the {productname} deployment and wait for it to be available: + [source,terminal] ---- -$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n +$ oc wait quayregistry registry--for=condition=Available=true ---- -. Scale down the Quay namespace: +=== Scale down your {productname} deployment + +. *For operator version 3.7 and newer*: scale down the {productname} deployment by disabling auto scaling and overriding the replica count for Quay, Mirror workers and Clair (if managed). Your `QuayRegistry` resource should look similar to the following: ++ +[source,yaml] +---- +apiVersion: quay.redhat.com/v1 +kind: QuayRegistry +metadata: + name: registry + namespace: ns +spec: + components: + … + - kind: horizontalpodautoscaler + managed: false <1> + - kind: quay + managed: true + overrides: <2> + replicas: 0 + - kind: clair + managed: true + overrides: + replicas: 0 + - kind: mirror + managed: true + overrides: + replicas: 0 + … +---- +<1> disable auto scaling of Quay, Clair and Mirroring workers +<2> set the replica count to 0 for components accessing the database and objectstorage + +. *For operator version 3.6 and earlier*: scale down the {productname} deployment by scaling down the {productname} operator first and then the managed {productname} resources: + [source,terminal] ---- +$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n + $ oc scale --replicas=0 deployment $(oc get deployment -n -l quay-component=quay -o jsonpath='{.items[0].metadata.name}') -n ----- +---- + +. Wait for the `registry-quay-app`, `registry-quay-mirror` and `registry-clair-app` pods (depending on which components you set to be managed by operator) to disappear. You can check their status by running the following command: ++ +[source,terminal] +---- +$ oc get pods -n +---- ++ +Example output: ++ +[source,terminal] +---- +registry-quay-config-editor-77847fc4f5-nsbbv 1/1 Running 0 9m1s +registry-quay-database-66969cd859-n2ssm 1/1 Running 0 6d1h +registry-quay-redis-7cc5f6c977-956g8 1/1 Running 0 5d21h +---- + +=== Restore your {productname} database . Identify your Quay database pod: + @@ -130,6 +194,8 @@ sh-4.4$ psql < /tmp/backup.sql sh-4.4$ exit ---- +=== Restore your {productname} object storage data + . Export the `AWS_ACCESS_KEY_ID`: + [source,terminal] @@ -151,24 +217,49 @@ $ export AWS_SECRET_ACCESS_KEY=$(oc get secret -l app=noobaa -n $ aws s3 sync --no-verify-ssl --endpoint https://$(oc get route s3 -n openshift-storage -o jsonpath='{.spec.host}') ./blobs s3://$(oc get cm -l app=noobaa -n -o jsonpath='{.items[0].data.BUCKET_NAME}') ---- -. Scale up the Quay the Quay Operator: +[NOTE] +==== +You can also use link:https://rclone.org/[rclone] or link:https://s3tools.org/s3cmd[sc3md] instead of the AWS command line utility. +==== + +=== Scale up your {productname} deployment + +. *For operator version 3.7 and newer*: scale up the {productname} deployment by re-enabling auto scaling (if desired) and removing the replica overrides for Quay, Mirror workers and Clair as appliable. Your `QuayRegistry` resource should look similar to the following: + -[source,terminal] ----- -$ oc scale --replicas=1 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n +[source,yaml] ---- +apiVersion: quay.redhat.com/v1 +kind: QuayRegistry +metadata: + name: registry + namespace: ns +spec: + components: + … + - kind: horizontalpodautoscaler + managed: true <1> + managed: true + - kind: clair + managed: true + - kind: mirror + managed: true + … +---- +<1> re-enables auto scaling of Quay, Clair and Mirroring workers again (if desired) +<2> replica overrides are removed again to scale the Quay components back up -. Scale up the Quay namespace: +. *For operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} operator again: + [source,terminal] ---- -$ oc scale --replicas=1 deployment $(oc get deployment -n -l quay-component=quay -o jsonpath='{.items[0].metadata.name}') -n +$ oc scale --replicas=1 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n ---- -. Check the status of the Operator and ensure it has come back online: + +. Check the status of the {productname} deployment: + [source,terminal] ---- -$ oc get quayregistry -n -o yaml +$ oc wait quayregistry registry--for=condition=Available=true ---- + Example output: @@ -179,22 +270,16 @@ apiVersion: quay.redhat.com/v1 kind: QuayRegistry metadata: ... - name: example-registry - namespace: quay-enterprise + name: registry + namespace: ... spec: - components: - - kind: quay - managed: true ... - - kind: clairpostgres - managed: true - configBundleSecret: init-config-bundle-secret status: - configEditorCredentialsSecret: example-registry-quay-config-editor-credentials-fg2gdgtm24 - configEditorEndpoint: https://example-registry-quay-config-editor-quay-enterprise.apps.docs.gcp.quaydev.org - currentVersion: 3.7.0 - lastUpdated: 2022-05-11 13:28:38.199476938 +0000 UTC - registryEndpoint: https://example-registry-quay-quay-enterprise.apps.docs.gcp.quaydev.org - 0 5d21h ----- + - lastTransitionTime: '2022-06-20T05:31:17Z' + lastUpdateTime: '2022-06-20T17:31:13Z' + message: All components reporting as healthy + reason: HealthChecksPassing + status: 'True' + type: Available +---- \ No newline at end of file From 80a4ac67dea208e40e92f0a8eb0ff976f8ceb67e Mon Sep 17 00:00:00 2001 From: dmesser Date: Wed, 22 Jun 2022 11:28:47 +0200 Subject: [PATCH 02/37] address review comments --- modules/backing-up-red-hat-quay.adoc | 18 ++++++++++++------ modules/restoring-red-hat-quay.adoc | 6 ++++-- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 9e85bd074..6f182e6e8 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -118,9 +118,10 @@ spec: + [source,terminal] ---- -$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n - -$ oc scale --replicas=0 deployment $(oc get deployment -n -l quay-component=quay -o jsonpath='{.items[0].metadata.name}') -n +$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n +$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/quay-app/ {print $1}') -n +$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/quay-mirror/ {print $1}') -n +$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/clair-app/ {print $1}') -n ---- . Wait for the `registry-quay-app`, `registry-quay-mirror` and `registry-clair-app` pods (depending on which components you set to be managed by operator) to disappear. You can check their status by running the following command: @@ -134,9 +135,14 @@ Example output: + [source,terminal] ---- -registry-quay-config-editor-77847fc4f5-nsbbv 1/1 Running 0 9m1s -registry-quay-database-66969cd859-n2ssm 1/1 Running 0 6d1h -registry-quay-redis-7cc5f6c977-956g8 1/1 Running 0 5d21h +$ oc get pod + +quay-operator.v3.7.1-6f9d859bd-p5ftc 1/1 Running 0 12m +quayregistry-clair-postgres-7487f5bd86-xnxpr 1/1 Running 1 (12m ago) 12m +quayregistry-quay-app-upgrade-xq2v6 0/1 Completed 0 12m +quayregistry-quay-config-editor-6dfdcfc44f-hlvwm 1/1 Running 0 73s +quayregistry-quay-database-859d5445ff-cqthr 1/1 Running 0 12m +quayregistry-quay-redis-84f888776f-hhgms 1/1 Running 0 12m ---- === {productname} managed database backup diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index 94289686b..a3efdcfb2 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -91,9 +91,11 @@ spec: + [source,terminal] ---- -$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n +$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n -$ oc scale --replicas=0 deployment $(oc get deployment -n -l quay-component=quay -o jsonpath='{.items[0].metadata.name}') -n +$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/quay-app/ {print $1}') -n +$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/quay-mirror/ {print $1}') -n +$ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/clair-app/ {print $1}') -n ---- . Wait for the `registry-quay-app`, `registry-quay-mirror` and `registry-clair-app` pods (depending on which components you set to be managed by operator) to disappear. You can check their status by running the following command: From 1623278d4509854c12deff0e85d9eea4a6b34cc9 Mon Sep 17 00:00:00 2001 From: dmesser Date: Wed, 22 Jun 2022 14:40:28 +0200 Subject: [PATCH 03/37] correct type in wait command --- modules/backing-up-red-hat-quay.adoc | 2 +- modules/restoring-red-hat-quay.adoc | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 6f182e6e8..903ba67a2 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -256,7 +256,7 @@ $ oc scale --replicas=1 deployment $(oc get deployment -n ---- + Example output: diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index a3efdcfb2..f0ae90e10 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -51,7 +51,7 @@ $ oc create -f ./quay-registry.yaml + [source,terminal] ---- -$ oc wait quayregistry registry--for=condition=Available=true +$ oc wait quayregistry registry --for=condition=Available=true -n ---- === Scale down your {productname} deployment @@ -261,7 +261,7 @@ $ oc scale --replicas=1 deployment $(oc get deployment -n ---- + Example output: From 8fb5f95b9fc86442f31d1cafde16a361a0ce6fc1 Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 12:00:27 -0400 Subject: [PATCH 04/37] Update backing-up-and-restoring-intro.adoc --- modules/backing-up-and-restoring-intro.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-and-restoring-intro.adoc b/modules/backing-up-and-restoring-intro.adoc index 117728500..c7f1deca7 100644 --- a/modules/backing-up-and-restoring-intro.adoc +++ b/modules/backing-up-and-restoring-intro.adoc @@ -1,4 +1,4 @@ [[backing-up-and-restoring-intro]] = Backing up and restoring {productname} managed by the {productname} operator -Use the content within this section to back up and restore {productname} when managed via the {productname} operator on OpenShift Container Platform. +Use the content within this section to back up and restore {productname} when managed via the {productname} Operator on OpenShift Container Platform. From 0564df83c50167a19dfd7f05a30658fa0a2d2a33 Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 12:02:37 -0400 Subject: [PATCH 05/37] Update backing-up-and-restoring-intro.adoc --- modules/backing-up-and-restoring-intro.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-and-restoring-intro.adoc b/modules/backing-up-and-restoring-intro.adoc index c7f1deca7..7e58f8f16 100644 --- a/modules/backing-up-and-restoring-intro.adoc +++ b/modules/backing-up-and-restoring-intro.adoc @@ -1,4 +1,4 @@ [[backing-up-and-restoring-intro]] -= Backing up and restoring {productname} managed by the {productname} operator += Backing up and restoring {productname} managed by the {productname} Operator Use the content within this section to back up and restore {productname} when managed via the {productname} Operator on OpenShift Container Platform. From c0f37230cf4d084f4e77034b3eea5dedf4b4ae15 Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 12:03:01 -0400 Subject: [PATCH 06/37] Update backing-up-and-restoring-intro.adoc --- modules/backing-up-and-restoring-intro.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-and-restoring-intro.adoc b/modules/backing-up-and-restoring-intro.adoc index 7e58f8f16..ff9b30ba7 100644 --- a/modules/backing-up-and-restoring-intro.adoc +++ b/modules/backing-up-and-restoring-intro.adoc @@ -1,4 +1,4 @@ [[backing-up-and-restoring-intro]] = Backing up and restoring {productname} managed by the {productname} Operator -Use the content within this section to back up and restore {productname} when managed via the {productname} Operator on OpenShift Container Platform. +Use the content within this section to back up and restore {productname} when managed by the {productname} Operator on OpenShift Container Platform. From b0804083ff3befc43ba795f82426673237b6901f Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 12:11:22 -0400 Subject: [PATCH 07/37] Update backing-up-red-hat-quay.adoc --- modules/backing-up-red-hat-quay.adoc | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 903ba67a2..8358d286e 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -1,17 +1,17 @@ [[backing-up-red-hat-quay]] == Backing up {productname} -This procedure describees how to create a backup of {productname} deployed on OpenShift Container Platform using the {productname} operator +This procedure describees how to create a backup of {productname} deployed on OpenShift Container Platform using the {productname} Operator .Prerequisites -* A {productname} deployment on OpenShift Container Platform using the {productname} operator that is healthy (status condition `Available` is set to `true`) +* A {productname} deployment on OpenShift Container Platform using the {productname} Operator that is healthy (status condition `Available` is set to `true`) * The components `quay`, `postgres` and `objectstorage` are set to `managed: true` -* If the component `clair` is set to `managed: true` the component `clairpostgres` is also set to `managed: true` (starting if {productname} operator v3.7 or later) +* If the component `clair` is set to `managed: true` the component `clairpostgres` is also set to `managed: true` (starting if {productname} Operator v3.7 or later) [NOTE] ==== -If your deployment contains partially unmanaged database or storage components and you are using external services for Postgres or S3-compatible object storage to run your {productname} deployment, you must refer to the service provider or vendor documentation to create a backup of the data. +If your deployment contains a partially unmanaged database or storage components and you are using external services for Postgres or S3-compatible object storage to run your {productname} deployment, you must refer to the service provider or vendor documentation to create a backup of the data. You can refer to the tools described in this guide to get a starting point on how to backup your external Postgres database or object storage. ==== @@ -78,7 +78,7 @@ $ oc get secret -n $(oc get quayregistry === Scale down your {productname} deployment -[NOTE] +[IMPORTANT] ==== This step is needed to create a consistent backup of the state of your {productname} deployment. Do not omit this step, including in setups where Postgres databases and/or S3-compatible object storage are provided by external services (unmanaged by the operator). ==== @@ -124,7 +124,7 @@ $ oc scale --replicas=0 deployment $(oc get deployment -n |awk ' $ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/clair-app/ {print $1}') -n ---- -. Wait for the `registry-quay-app`, `registry-quay-mirror` and `registry-clair-app` pods (depending on which components you set to be managed by operator) to disappear. You can check their status by running the following command: +. Wait for the `registry-quay-app`, `registry-quay-mirror` and `registry-clair-app` pods (depending on which components you set to be managed by the {productname} Operator) to disappear. You can check their status by running the following command: + [source,terminal] ---- @@ -183,7 +183,7 @@ $ oc exec quayregistry-quay-database-59f54bb7-58xs7 -- /usr/bin/pg_dump -C quayr === {productname} managed object storage backup -The follow instructions apply to both configurations, standalone multi-cloud object gateway and OpenShift Data Foundations storage that the {productname} operator provisioned a S3 object storage bucket from, via the `ObjectStorageBucketClaim` API. +The following instructions apply to both configurations, standalone multi-cloud object gateway and OpenShift Data Foundations storage that the {productname} Operator provisioned a S3 object storage bucket from, via the `ObjectStorageBucketClaim` API. [NOTE] ==== @@ -220,7 +220,7 @@ You can also use link:https://rclone.org/[rclone] or link:https://s3tools.org/s3 === Scale the {productname} deployment back up -. *For operator version 3.7 and newer*: scale up the {productname} deployment by re-enabling auto scaling (if desired) and removing the replica overrides for Quay, Mirror workers and Clair as appliable. Your `QuayRegistry` resource should look similar to the following: +. *For Operator version 3.7 and newer*: scale up the {productname} deployment by re-enabling auto scaling (if desired) and removing the replica overrides for Quay, Mirror workers and Clair as appliable. Your `QuayRegistry` resource should look similar to the following: + [source,yaml] ---- @@ -245,7 +245,7 @@ spec: <1> re-enables auto scaling of Quay, Clair and Mirroring workers again (if desired) <2> replica overrides are removed again to scale the Quay components back up -. *For operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} operator again: +. *For Operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} operator again: + [source,terminal] ---- From 16d0311be7d8010eafbeac3f5ee9b1416032a095 Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 12:12:57 -0400 Subject: [PATCH 08/37] Update backing-up-red-hat-quay.adoc --- modules/backing-up-red-hat-quay.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 8358d286e..5d4ef466b 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -80,10 +80,10 @@ $ oc get secret -n $(oc get quayregistry [IMPORTANT] ==== -This step is needed to create a consistent backup of the state of your {productname} deployment. Do not omit this step, including in setups where Postgres databases and/or S3-compatible object storage are provided by external services (unmanaged by the operator). +This step is needed to create a consistent backup of the state of your {productname} deployment. Do not omit this step, including in setups where Postgres databases and/or S3-compatible object storage are provided by external services (unmanaged by the Operator). ==== -. *For operator version 3.7 and newer*: scale down the {productname} deployment by disabling auto scaling and overriding the replica count for Quay, Mirror workers and Clair (if managed). Your `QuayRegistry` resource should look similar to the following: +. *For Operator version 3.7 and newer*: scale down the {productname} deployment by disabling auto scaling and overriding the replica count for Quay, Mirror workers and Clair (if managed). Your `QuayRegistry` resource should look similar to the following: + [source,yaml] ---- @@ -114,7 +114,7 @@ spec: <1> disable auto scaling of Quay, Clair and Mirroring workers <2> set the replica count to 0 for components accessing the database and objectstorage -. *For operator version 3.6 and earlier*: scale down the {productname} deployment by scaling down the {productname} operator first and then the managed {productname} resources: +. *For Operator version 3.6 and earlier*: scale down the {productname} deployment by scaling down the {productname} Operator first and then the managed {productname} resources: + [source,terminal] ---- @@ -245,7 +245,7 @@ spec: <1> re-enables auto scaling of Quay, Clair and Mirroring workers again (if desired) <2> replica overrides are removed again to scale the Quay components back up -. *For Operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} operator again: +. *For Operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} Operator again: + [source,terminal] ---- From 3c7716733994778576098b407d0ae72ff1ad9170 Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 12:34:29 -0400 Subject: [PATCH 09/37] Update restoring-red-hat-quay.adoc --- modules/restoring-red-hat-quay.adoc | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index f0ae90e10..d93c68f50 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -6,13 +6,13 @@ This procedure is used to restore {productname} when the {productname} Quay Oper .Prerequisites -* {productname} is deployed on OpenShift Container Platform using the {productname} operator. -* A backup of the {productname} configuration managed by the {productname} operator has been created following the instructions in the xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] section +* {productname} is deployed on OpenShift Container Platform using the {productname} Operator. +* A backup of the {productname} configuration managed by the {productname} Operator has been created following the instructions in the xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] section * Your {productname} database has been backed up. * The object storage bucket used by {productname} has been backed up. * The components `quay`, `postgres` and `objectstorage` are set to `managed: true` -* If the component `clair` is set to `managed: true` the component `clairpostgres` is also set to `managed: true` (starting if {productname} operator v3.7 or later) -* there is no running {productname} deployment managed by the {productname} operator in the target namespace on your OpenShift Container Platform cluster +* If the component `clair` is set to `managed: true` the component `clairpostgres` is also set to `managed: true` (starting if {productname} Operator v3.7 or later) +* there is no running {productname} deployment managed by the {productname} Operator in the target namespace on your OpenShift Container Platform cluster [NOTE] ==== @@ -37,7 +37,7 @@ $ oc create -f ./managed-secret-keys.yaml + [IMPORTANT] ==== -If you receive the error `Error from server (AlreadyExists): error when creating "./config-bundle.yaml": secrets "config-bundle-secret" already exists`, you must delete your exist resource with `$ oc delete Secret config-bundle-secret -n ` and recreate it with `$ oc create -f ./config-bundle.yaml`. +If you receive the error `Error from server (AlreadyExists): error when creating "./config-bundle.yaml": secrets "config-bundle-secret" already exists`, you must delete your existing resource with `$ oc delete Secret config-bundle-secret -n ` and recreate it with `$ oc create -f ./config-bundle.yaml`. ==== . Restore the `QuayRegistry` custom resource: @@ -56,7 +56,7 @@ $ oc wait quayregistry registry --for=condition=Available=true -n disable auto scaling of Quay, Clair and Mirroring workers <2> set the replica count to 0 for components accessing the database and objectstorage -. *For operator version 3.6 and earlier*: scale down the {productname} deployment by scaling down the {productname} operator first and then the managed {productname} resources: +. *For Operator version 3.6 and earlier*: scale down the {productname} deployment by scaling down the {productname} Operator first and then the managed {productname} resources: + [source,terminal] ---- @@ -98,7 +98,7 @@ $ oc scale --replicas=0 deployment $(oc get deployment -n |awk ' $ oc scale --replicas=0 deployment $(oc get deployment -n |awk '/clair-app/ {print $1}') -n ---- -. Wait for the `registry-quay-app`, `registry-quay-mirror` and `registry-clair-app` pods (depending on which components you set to be managed by operator) to disappear. You can check their status by running the following command: +. Wait for the `registry-quay-app`, `registry-quay-mirror` and `registry-clair-app` pods (depending on which components you set to be managed by Operator) to disappear. You can check their status by running the following command: + [source,terminal] ---- @@ -226,7 +226,7 @@ You can also use link:https://rclone.org/[rclone] or link:https://s3tools.org/s3 === Scale up your {productname} deployment -. *For operator version 3.7 and newer*: scale up the {productname} deployment by re-enabling auto scaling (if desired) and removing the replica overrides for Quay, Mirror workers and Clair as appliable. Your `QuayRegistry` resource should look similar to the following: +. *For Operator version 3.7 and newer*: scale up the {productname} deployment by re-enabling auto scaling (if desired) and removing the replica overrides for Quay, Mirror workers and Clair as appliable. Your `QuayRegistry` resource should look similar to the following: + [source,yaml] ---- @@ -250,7 +250,7 @@ spec: <1> re-enables auto scaling of Quay, Clair and Mirroring workers again (if desired) <2> replica overrides are removed again to scale the Quay components back up -. *For operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} operator again: +. *For Operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} Operator again: + [source,terminal] ---- @@ -284,4 +284,4 @@ status: reason: HealthChecksPassing status: 'True' type: Available ----- \ No newline at end of file +---- From bc079bb53eebe3d374fc8ed3da608bfb8dd5eb0c Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 12:36:11 -0400 Subject: [PATCH 10/37] Update restoring-red-hat-quay.adoc --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index d93c68f50..3efcf2396 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -26,7 +26,7 @@ If your deployment contains partially unmanaged database or storage components a These instructions assume you have followed the process in the xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] guide and create the backup files with the same names. ==== -. Restore the backed up Quay configuration and the generated keys from the backup +. Restore the backed up Quay configuration and the generated keys from the backup: + [source,terminal] ---- From 63a778a8d9fe65e6a2523b4c3e3f042719bb98ed Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 12:51:43 -0400 Subject: [PATCH 11/37] Update restoring-red-hat-quay.adoc --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index 3efcf2396..63edf59d1 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -1,7 +1,7 @@ [[restoring-up-red-hat-quay]] == Restoring {productname} -This procedure is used to restore {productname} when the {productname} Quay Operator manages the database. It should be performed after a backup of your {productname} registry has been performed. See the section Refer to xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] for more information. +This procedure is used to restore {productname} when the {productname} Quay Operator manages the database. It should be performed after a backup of your {productname} registry has been performed. See xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] for more information. .Prerequisites From 010bf4f9b775f22f2224e8261b5969c89f0824cf Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 12:52:30 -0400 Subject: [PATCH 12/37] Update backing-up-red-hat-quay.adoc --- modules/backing-up-red-hat-quay.adoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 5d4ef466b..82fce39c5 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -183,7 +183,10 @@ $ oc exec quayregistry-quay-database-59f54bb7-58xs7 -- /usr/bin/pg_dump -C quayr === {productname} managed object storage backup -The following instructions apply to both configurations, standalone multi-cloud object gateway and OpenShift Data Foundations storage that the {productname} Operator provisioned a S3 object storage bucket from, via the `ObjectStorageBucketClaim` API. +The instructions in this section apply to the following configurations: + +Standalone, multi-cloud object gateway configurations +OpenShift Data Foundations storage conditions that the {productname} Operator provisioned an S3 object storage bucket from, through the ObjectStorageBucketClaim API [NOTE] ==== From 9c16193fa0e1989139c0ffe485c8211e316754cc Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 12:56:57 -0400 Subject: [PATCH 13/37] Update backing-up-red-hat-quay.adoc --- modules/backing-up-red-hat-quay.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 82fce39c5..190ed87dc 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -149,7 +149,7 @@ quayregistry-quay-redis-84f888776f-hhgms 1/1 Running 0 [NOTE] ==== -If your {productname} deployment is configured with external (unmanged) Postgres database(s), please refer to your vendor's documentation on how to create a consistent backup of these databases. +If your {productname} deployment is configured with external (unmanged) Postgres database(s), refer to your vendor's documentation on how to create a consistent backup of these databases. ==== . Identify the Quay PostgreSQL pod name: @@ -190,7 +190,7 @@ OpenShift Data Foundations storage conditions that the {productname} Operator pr [NOTE] ==== -If your {productname} deployment is configured with external (unmanged) object storage, please refer to your vendor's documentation on how to create a copy of the content of Quay's storage bucket. +If your {productname} deployment is configured with external (unmanged) object storage, refer to your vendor's documentation on how to create a copy of the content of Quay's storage bucket. ==== . Decode and export the `AWS_ACCESS_KEY_ID`: From d331e59e476aa3f58fe270919ac8ce23d478febc Mon Sep 17 00:00:00 2001 From: Steven Smith <77019920+stevsmit@users.noreply.github.com> Date: Wed, 22 Jun 2022 13:02:52 -0400 Subject: [PATCH 14/37] Update restoring-red-hat-quay.adoc --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index 63edf59d1..e506730b9 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -1,7 +1,7 @@ [[restoring-up-red-hat-quay]] == Restoring {productname} -This procedure is used to restore {productname} when the {productname} Quay Operator manages the database. It should be performed after a backup of your {productname} registry has been performed. See xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] for more information. +This procedure is used to restore {productname} when the {productname} Operator manages the database. It should be performed after a backup of your {productname} registry has been performed. See xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] for more information. .Prerequisites From 054c10a326c40bd48701917fd799b92a7bbf189e Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:31:18 +0200 Subject: [PATCH 15/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 190ed87dc..828e630a5 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -1,7 +1,7 @@ [[backing-up-red-hat-quay]] == Backing up {productname} -This procedure describees how to create a backup of {productname} deployed on OpenShift Container Platform using the {productname} Operator +This procedure describes how to create a backup of {productname} deployed on OpenShift Container Platform using the {productname} Operator .Prerequisites From 6a75d5eee542e3c737d4640230adb3316bc932df Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:31:33 +0200 Subject: [PATCH 16/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 828e630a5..5265365b9 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -5,7 +5,7 @@ This procedure describes how to create a backup of {productname} deployed on Ope .Prerequisites -* A {productname} deployment on OpenShift Container Platform using the {productname} Operator that is healthy (status condition `Available` is set to `true`) +* A healthy {productname} deployment on OpenShift Container Platform using the {productname} Operator (status condition `Available` is set to `true`) * The components `quay`, `postgres` and `objectstorage` are set to `managed: true` * If the component `clair` is set to `managed: true` the component `clairpostgres` is also set to `managed: true` (starting if {productname} Operator v3.7 or later) From e60b1d5dd011c45e688042b403504fb7f97f75c7 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:31:47 +0200 Subject: [PATCH 17/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 5265365b9..f13361ad6 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -7,7 +7,7 @@ This procedure describes how to create a backup of {productname} deployed on Ope * A healthy {productname} deployment on OpenShift Container Platform using the {productname} Operator (status condition `Available` is set to `true`) * The components `quay`, `postgres` and `objectstorage` are set to `managed: true` -* If the component `clair` is set to `managed: true` the component `clairpostgres` is also set to `managed: true` (starting if {productname} Operator v3.7 or later) +* If the component `clair` is set to `managed: true` the component `clairpostgres` is also set to `managed: true` (starting with {productname} Operator v3.7 or later) [NOTE] ==== From 740e47456eb906ef084190298c423e8e6fcc62b7 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:31:57 +0200 Subject: [PATCH 18/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index f13361ad6..3a741f87b 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -11,7 +11,7 @@ This procedure describes how to create a backup of {productname} deployed on Ope [NOTE] ==== -If your deployment contains a partially unmanaged database or storage components and you are using external services for Postgres or S3-compatible object storage to run your {productname} deployment, you must refer to the service provider or vendor documentation to create a backup of the data. +If your deployment contains partially unmanaged database or storage components and you are using external services for Postgres or S3-compatible object storage to run your {productname} deployment, you must refer to the service provider or vendor documentation to create a backup of the data. You can refer to the tools described in this guide to get a starting point on how to backup your external Postgres database or object storage. ==== From 3b8e56896ce816b959595774b93e1006304d06db Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:32:10 +0200 Subject: [PATCH 19/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 3a741f87b..0dcab035c 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -12,7 +12,7 @@ This procedure describes how to create a backup of {productname} deployed on Ope [NOTE] ==== If your deployment contains partially unmanaged database or storage components and you are using external services for Postgres or S3-compatible object storage to run your {productname} deployment, you must refer to the service provider or vendor documentation to create a backup of the data. -You can refer to the tools described in this guide to get a starting point on how to backup your external Postgres database or object storage. +You can refer to the tools described in this guide as a starting point on how to backup your external Postgres database or object storage. ==== === {productname} configuration backup From 9b9df0d6c049eb47f8b0076c78375155ea2a2f22 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:32:30 +0200 Subject: [PATCH 20/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 0dcab035c..811b93538 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -83,7 +83,7 @@ $ oc get secret -n $(oc get quayregistry This step is needed to create a consistent backup of the state of your {productname} deployment. Do not omit this step, including in setups where Postgres databases and/or S3-compatible object storage are provided by external services (unmanaged by the Operator). ==== -. *For Operator version 3.7 and newer*: scale down the {productname} deployment by disabling auto scaling and overriding the replica count for Quay, Mirror workers and Clair (if managed). Your `QuayRegistry` resource should look similar to the following: +. *For Operator version 3.7 and newer:* Scale down the {productname} deployment by disabling auto scaling and overriding the replica count for {productname}, mirror workers, and Clair (if managed). Your `QuayRegistry` resource should look similar to the following: + [source,yaml] ---- From d476af251ade3ab8476c1aa141965b49025f87e2 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:32:46 +0200 Subject: [PATCH 21/37] Update modules/restoring-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index e506730b9..e7ec6cc49 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -226,7 +226,7 @@ You can also use link:https://rclone.org/[rclone] or link:https://s3tools.org/s3 === Scale up your {productname} deployment -. *For Operator version 3.7 and newer*: scale up the {productname} deployment by re-enabling auto scaling (if desired) and removing the replica overrides for Quay, Mirror workers and Clair as appliable. Your `QuayRegistry` resource should look similar to the following: +. *For Operator version 3.7 and newer:* Scale up the {productname} deployment by re-enabling auto scaling, if desired, and removing the replica overrides for Quay, mirror workers and Clair as applicable. Your `QuayRegistry` resource should look similar to the following: + [source,yaml] ---- From b21e6136d9e6545ea286b5bd461e53c5c348b3dc Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:32:55 +0200 Subject: [PATCH 22/37] Update modules/restoring-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index e7ec6cc49..8a05c6f84 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -247,7 +247,7 @@ spec: managed: true … ---- -<1> re-enables auto scaling of Quay, Clair and Mirroring workers again (if desired) +<1> Re-enables auto scaling of {productname}, Clair and mirroring workers again (if desired) <2> replica overrides are removed again to scale the Quay components back up . *For Operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} Operator again: From 0798bdda763d300bd8acecd1d3201eae2b1d250d Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:33:07 +0200 Subject: [PATCH 23/37] Update modules/restoring-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index 8a05c6f84..400c39e7c 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -248,7 +248,7 @@ spec: … ---- <1> Re-enables auto scaling of {productname}, Clair and mirroring workers again (if desired) -<2> replica overrides are removed again to scale the Quay components back up +<2> Replica overrides are removed again to scale the {productname} components back up . *For Operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} Operator again: + From 276f69bf881a2c16de6dfcc4ec4c97d0fe69a0ff Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:33:19 +0200 Subject: [PATCH 24/37] Update modules/restoring-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index 400c39e7c..7fbf43dff 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -250,7 +250,7 @@ spec: <1> Re-enables auto scaling of {productname}, Clair and mirroring workers again (if desired) <2> Replica overrides are removed again to scale the {productname} components back up -. *For Operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} Operator again: +. *For Operator version 3.6 and earlier:* Scale up the {productname} deployment by scaling up the {productname} Operator again: + [source,terminal] ---- From ab68ab1bc294bd51f611debb7d206cfbb39c52d5 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:33:36 +0200 Subject: [PATCH 25/37] Update modules/restoring-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index 7fbf43dff..757e55c91 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -254,7 +254,7 @@ spec: + [source,terminal] ---- -$ oc scale --replicas=1 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n +$ oc scale --replicas=1 deployment $(oc get deployment -n | awk '/^quay-operator/ {print $1}') -n ---- . Check the status of the {productname} deployment: From e2c28732b7bb61c4f8b77a540a10e0a5ff2ece8a Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:33:51 +0200 Subject: [PATCH 26/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 811b93538..73189bd22 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -111,7 +111,7 @@ spec: replicas: 0 … ---- -<1> disable auto scaling of Quay, Clair and Mirroring workers +<1> Disable auto scaling of Quay, Clair and Mirroring workers <2> set the replica count to 0 for components accessing the database and objectstorage . *For Operator version 3.6 and earlier*: scale down the {productname} deployment by scaling down the {productname} Operator first and then the managed {productname} resources: From 3705e5e13ac159177d25d5c3cd55f1ef51ce67a0 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:34:07 +0200 Subject: [PATCH 27/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 73189bd22..490f6e8d3 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -112,7 +112,7 @@ spec: … ---- <1> Disable auto scaling of Quay, Clair and Mirroring workers -<2> set the replica count to 0 for components accessing the database and objectstorage +<2> Set the replica count to 0 for components accessing the database and objectstorage . *For Operator version 3.6 and earlier*: scale down the {productname} deployment by scaling down the {productname} Operator first and then the managed {productname} resources: + From 417ad7150d8172dca2dfc93c314f7fc1e255ec94 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:34:28 +0200 Subject: [PATCH 28/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 490f6e8d3..c6e5405aa 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -114,7 +114,7 @@ spec: <1> Disable auto scaling of Quay, Clair and Mirroring workers <2> Set the replica count to 0 for components accessing the database and objectstorage -. *For Operator version 3.6 and earlier*: scale down the {productname} deployment by scaling down the {productname} Operator first and then the managed {productname} resources: +. *For Operator version 3.6 and earlier*: Scale down the {productname} deployment by scaling down the {productname} Operator first and then the managed {productname} resources: + [source,terminal] ---- From ae04ef649d7114b8fc5f1e4c46b2d776cb042651 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:37:13 +0200 Subject: [PATCH 29/37] Update modules/restoring-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index 757e55c91..7d31d59b7 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -87,7 +87,7 @@ spec: <1> disable auto scaling of Quay, Clair and Mirroring workers <2> set the replica count to 0 for components accessing the database and objectstorage -. *For Operator version 3.6 and earlier*: scale down the {productname} deployment by scaling down the {productname} Operator first and then the managed {productname} resources: +. *For Operator version 3.6 and earlier:* Scale down the {productname} deployment by scaling down the {productname} Operator first and then the managed {productname} resources: + [source,terminal] ---- From 0adf7e98235dedeb6eaf12f431219146854438c5 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:39:20 +0200 Subject: [PATCH 30/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index c6e5405aa..9ea5febf4 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -185,8 +185,8 @@ $ oc exec quayregistry-quay-database-59f54bb7-58xs7 -- /usr/bin/pg_dump -C quayr The instructions in this section apply to the following configurations: -Standalone, multi-cloud object gateway configurations -OpenShift Data Foundations storage conditions that the {productname} Operator provisioned an S3 object storage bucket from, through the ObjectStorageBucketClaim API +* Standalone, multi-cloud object gateway configurations +* OpenShift Data Foundations storage requires that the {productname} Operator provisioned an S3 object storage bucket from, through the ObjectStorageBucketClaim API [NOTE] ==== From 620aa906f388f56f6d4170775a9d74037cd1d9ec Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:39:32 +0200 Subject: [PATCH 31/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 9ea5febf4..b955021fa 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -223,7 +223,7 @@ You can also use link:https://rclone.org/[rclone] or link:https://s3tools.org/s3 === Scale the {productname} deployment back up -. *For Operator version 3.7 and newer*: scale up the {productname} deployment by re-enabling auto scaling (if desired) and removing the replica overrides for Quay, Mirror workers and Clair as appliable. Your `QuayRegistry` resource should look similar to the following: +. *For Operator version 3.7 and newer:* Scale up the {productname} deployment by re-enabling auto scaling, if desired, and removing the replica overrides for Quay, mirror workers and Clair as applicable. Your `QuayRegistry` resource should look similar to the following: + [source,yaml] ---- From 843d111694a8db510362ef9a87b9a9f60f63e444 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:39:43 +0200 Subject: [PATCH 32/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index b955021fa..7cdb028e5 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -248,7 +248,7 @@ spec: <1> re-enables auto scaling of Quay, Clair and Mirroring workers again (if desired) <2> replica overrides are removed again to scale the Quay components back up -. *For Operator version 3.6 and earlier*: scale up the {productname} deployment by scaling up the {productname} Operator again: +. *For Operator version 3.6 and earlier:* Scale up the {productname} deployment by scaling up the {productname} Operator again: + [source,terminal] ---- From 4afd14a99c169b8c11395c546b4e245c74bda17c Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:39:55 +0200 Subject: [PATCH 33/37] Update modules/backing-up-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/backing-up-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backing-up-red-hat-quay.adoc b/modules/backing-up-red-hat-quay.adoc index 7cdb028e5..5522559f4 100644 --- a/modules/backing-up-red-hat-quay.adoc +++ b/modules/backing-up-red-hat-quay.adoc @@ -252,7 +252,7 @@ spec: + [source,terminal] ---- -$ oc scale --replicas=1 deployment $(oc get deployment -n |awk '/^quay-operator/ {print $1}') -n +$ oc scale --replicas=1 deployment $(oc get deployment -n | awk '/^quay-operator/ {print $1}') -n ---- . Check the status of the {productname} deployment: From 58c571f893d4920ca85cf91a74c2822aff10534f Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:45:50 +0200 Subject: [PATCH 34/37] Update modules/restoring-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index 7d31d59b7..abba37bfb 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -11,7 +11,7 @@ This procedure is used to restore {productname} when the {productname} Operator * Your {productname} database has been backed up. * The object storage bucket used by {productname} has been backed up. * The components `quay`, `postgres` and `objectstorage` are set to `managed: true` -* If the component `clair` is set to `managed: true` the component `clairpostgres` is also set to `managed: true` (starting if {productname} Operator v3.7 or later) +* If the component `clair` is set to `managed: true`, the component `clairpostgres` is also set to `managed: true` (starting with {productname} Operator v3.7 or later) * there is no running {productname} deployment managed by the {productname} Operator in the target namespace on your OpenShift Container Platform cluster [NOTE] From bfa91a739fc4c0f75e54b30ba75e6bfb3829a86e Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:46:02 +0200 Subject: [PATCH 35/37] Update modules/restoring-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index abba37bfb..d08a3b448 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -12,7 +12,7 @@ This procedure is used to restore {productname} when the {productname} Operator * The object storage bucket used by {productname} has been backed up. * The components `quay`, `postgres` and `objectstorage` are set to `managed: true` * If the component `clair` is set to `managed: true`, the component `clairpostgres` is also set to `managed: true` (starting with {productname} Operator v3.7 or later) -* there is no running {productname} deployment managed by the {productname} Operator in the target namespace on your OpenShift Container Platform cluster +* There is no running {productname} deployment managed by the {productname} Operator in the target namespace on your OpenShift Container Platform cluster [NOTE] ==== From d41dec59865979ebe20ef2d0bab5ac7e3314e596 Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:48:46 +0200 Subject: [PATCH 36/37] Update modules/restoring-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index d08a3b448..2eb99cba9 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -26,7 +26,7 @@ If your deployment contains partially unmanaged database or storage components a These instructions assume you have followed the process in the xref:backing-up-red-hat-quay.adoc#backing-up-red-hat-quay[Backing up {productname}] guide and create the backup files with the same names. ==== -. Restore the backed up Quay configuration and the generated keys from the backup: +. Restore the backed up {productname} configuration and the generated keys from the backup: + [source,terminal] ---- From a3491da9b93f12368fb7ab61cbe2f9f82da22adf Mon Sep 17 00:00:00 2001 From: Daniel Messer Date: Fri, 24 Jun 2022 09:48:59 +0200 Subject: [PATCH 37/37] Update modules/restoring-red-hat-quay.adoc Co-authored-by: Gabriel McGoldrick <75261888+gabriel-rh@users.noreply.github.com> --- modules/restoring-red-hat-quay.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/restoring-red-hat-quay.adoc b/modules/restoring-red-hat-quay.adoc index 2eb99cba9..f742d041f 100644 --- a/modules/restoring-red-hat-quay.adoc +++ b/modules/restoring-red-hat-quay.adoc @@ -56,7 +56,7 @@ $ oc wait quayregistry registry --for=condition=Available=true -n