From c0fa0b43c1ff642015b5e6d0c9cfeef2a17372d6 Mon Sep 17 00:00:00 2001 From: Apurva Bhide Date: Mon, 24 Feb 2025 20:06:56 +0530 Subject: [PATCH 1/2] OADP-5634: Add new structure for 3scale user story --- _topic_maps/_topic_map.yml | 4 ++++ .../backing-up-3scale-by-using-oadp.adoc | 24 +++++++++++++++++++ ...up-and-restoring-3scale-by-using-oadp.adoc | 24 ++----------------- .../restoring-3scale-by-using-oadp.adoc | 17 +++++++++++++ modules/backing-up-the-mysql-database.adoc | 2 +- ...up-the-3scale-operator-and-deployment.adoc | 4 ++-- 6 files changed, 50 insertions(+), 25 deletions(-) create mode 100644 backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-3scale-by-using-oadp.adoc create mode 100644 backup_and_restore/application_backup_and_restore/oadp-3scale/restoring-3scale-by-using-oadp.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 73a457a71471..03b1b18c51d6 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -3660,6 +3660,10 @@ Topics: Topics: - Name: Backing up and restoring 3scale by using OADP File: backing-up-and-restoring-3scale-by-using-oadp + - Name: Backing up 3scale by using OADP + File: backing-up-3scale-by-using-oadp + - Name: Restoring 3scale by using OADP + File: restoring-3scale-by-using-oadp - Name: OADP Data Mover Dir: installing Topics: diff --git a/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-3scale-by-using-oadp.adoc b/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-3scale-by-using-oadp.adoc new file mode 100644 index 000000000000..5b7bd461a49e --- /dev/null +++ b/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-3scale-by-using-oadp.adoc @@ -0,0 +1,24 @@ +:_mod-docs-content-type: ASSEMBLY +[id="backing-up-3scale-by-using-oadp_{context}"] += Backing up 3scale by using OADP +include::_attributes/common-attributes.adoc[] +:context: backing-up-3scale-by-using-oadp + +toc::[] + +You can back up 3scale by backing up 3scale Operator, and databses such as mysql and Redis. + +include::modules/creating-the-data-protection-application.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#oadp-installing-dpa_installing-oadp-aws[Installing the Data Protection Application] + +include::modules/backing-up-the-3scale-operator.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources +* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-creating-backup-cr.adoc#oadp-creating-backup-cr-doc[Creating a Backup CR] + +include::modules/backing-up-the-mysql-database.adoc[leveloffset=+1] + +include::modules/backing-up-the-backend-redis-database.adoc[leveloffset=+1] \ No newline at end of file diff --git a/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-and-restoring-3scale-by-using-oadp.adoc b/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-and-restoring-3scale-by-using-oadp.adoc index 7381a8a42e7a..e3ef7af2c97e 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-and-restoring-3scale-by-using-oadp.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-and-restoring-3scale-by-using-oadp.adoc @@ -15,29 +15,9 @@ In this example, the non-service affecting approach is used to back up and resto Additionally, ensure that you are restoring 3scale on the same cluster where it was backed up from. If you want to restore 3scale on a different cluster, ensure that both clusters are using the same custom domain. ==== +You can xref:../oadp-3scale/backing-up-3scale-by-using-oadp.adoc#backing-up-3scale-by-using-oadp[back up 3scale] and xref:../oadp-3scale/restoring-3scale-by-using-oadp.adoc#restoring-3scale-by-using-oadp[restore 3scale] by using OADP. + .Prerequisites * You installed and configured Red Hat 3scale. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_3scale_api_management/2.15/html/installing_red_hat_3scale_api_management[Red Hat 3scale API Management]. -include::modules/creating-the-data-protection-application.adoc[leveloffset=+1] -[role="_additional-resources"] -.Additional resources -* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#oadp-installing-dpa_installing-oadp-aws[Installing the Data Protection Application] - -include::modules/backing-up-the-3scale-operator.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources -* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-creating-backup-cr.adoc#oadp-creating-backup-cr-doc[Creating a Backup CR] - -include::modules/backing-up-the-mysql-database.adoc[leveloffset=+1] - -include::modules/backing-up-the-backend-redis-database.adoc[leveloffset=+1] - -include::modules/restoring-the-secrets-and-apimanager.adoc[leveloffset=+1] - -include::modules/restoring-the-mysql-database.adoc[leveloffset=+1] - -include::modules/restoring-the-backend-redis-database.adoc[leveloffset=+1] - -include::modules/scaling-up-the-3scale-operator-and-deployment.adoc[leveloffset=+1] \ No newline at end of file diff --git a/backup_and_restore/application_backup_and_restore/oadp-3scale/restoring-3scale-by-using-oadp.adoc b/backup_and_restore/application_backup_and_restore/oadp-3scale/restoring-3scale-by-using-oadp.adoc new file mode 100644 index 000000000000..39cac36c890f --- /dev/null +++ b/backup_and_restore/application_backup_and_restore/oadp-3scale/restoring-3scale-by-using-oadp.adoc @@ -0,0 +1,17 @@ +:_mod-docs-content-type: ASSEMBLY +[id="restoring-3scale-by-using-oadp{context}"] += Restoring 3scale by using OADP +include::_attributes/common-attributes.adoc[] +:context: restoring-3scale-by-using-oadp + +toc::[] + +You can restore the 3scale by restoring the backed up 3scale Operator resources, and databses such as mysql and Redis. Once the data has been restored, you can scale up the 3scale Operator and deployment. + +include::modules/restoring-the-secrets-and-apimanager.adoc[leveloffset=+1] + +include::modules/restoring-the-mysql-database.adoc[leveloffset=+1] + +include::modules/restoring-the-backend-redis-database.adoc[leveloffset=+1] + +include::modules/scaling-up-the-3scale-operator-and-deployment.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/backing-up-the-mysql-database.adoc b/modules/backing-up-the-mysql-database.adoc index e7470f470f38..6355a272e510 100644 --- a/modules/backing-up-the-mysql-database.adoc +++ b/modules/backing-up-the-mysql-database.adoc @@ -40,7 +40,7 @@ spec: $ oc create -f ts_pvc.yml ---- -. Attach the PVC to the system database pod by editing the system database deployment to use the `mysql` dump: +. Attach the PVC to the system database pod by editing the `system-mysql` deployment to use the `mysql` dump: + [source,terminal] ---- diff --git a/modules/scaling-up-the-3scale-operator-and-deployment.adoc b/modules/scaling-up-the-3scale-operator-and-deployment.adoc index 3184fd2be9d3..9bec0741de82 100644 --- a/modules/scaling-up-the-3scale-operator-and-deployment.adoc +++ b/modules/scaling-up-the-3scale-operator-and-deployment.adoc @@ -22,11 +22,11 @@ There might be some `system-mysql` or `backend-redis` pods running detached from $ oc scale deployment threescale-operator-controller-manager-v2 --replicas=1 -n threescale ---- -. Ensure that the 3scale Operator was deployed by running the following command: +. Ensure that all pods are running to verify if the 3scale Operator was deployed by running the following command: + [source,terminal] ---- -$ oc get deployment -n threescale +$ oc get pods -n threescale ---- . Scale up the deployments by executing the following script: From 748cfcacce27ffdef017a66328f5b78055fc1588 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Mon, 3 Mar 2025 23:06:17 +0000 Subject: [PATCH 2/2] OADP-5634-improving-threescale-user-story Signed-off-by: A.Arnold --- .../oadp-3scale/backing-up-3scale-by-using-oadp.adoc | 4 ++-- .../backing-up-and-restoring-3scale-by-using-oadp.adoc | 4 ++-- .../oadp-3scale/restoring-3scale-by-using-oadp.adoc | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-3scale-by-using-oadp.adoc b/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-3scale-by-using-oadp.adoc index 5b7bd461a49e..429bf2c0ee76 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-3scale-by-using-oadp.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-3scale-by-using-oadp.adoc @@ -1,5 +1,5 @@ :_mod-docs-content-type: ASSEMBLY -[id="backing-up-3scale-by-using-oadp_{context}"] +[id="backing-up-3scale-by-using-oadp"] = Backing up 3scale by using OADP include::_attributes/common-attributes.adoc[] :context: backing-up-3scale-by-using-oadp @@ -21,4 +21,4 @@ include::modules/backing-up-the-3scale-operator.adoc[leveloffset=+1] include::modules/backing-up-the-mysql-database.adoc[leveloffset=+1] -include::modules/backing-up-the-backend-redis-database.adoc[leveloffset=+1] \ No newline at end of file +include::modules/backing-up-the-backend-redis-database.adoc[leveloffset=+1] diff --git a/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-and-restoring-3scale-by-using-oadp.adoc b/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-and-restoring-3scale-by-using-oadp.adoc index e3ef7af2c97e..c1c0ebcb45b9 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-and-restoring-3scale-by-using-oadp.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-and-restoring-3scale-by-using-oadp.adoc @@ -1,5 +1,5 @@ :_mod-docs-content-type: ASSEMBLY -[id="backing-up-and-restoring-3scale-by-using-oadp_{context}"] +[id="backing-up-and-restoring-3scale-by-using-oadp"] = Backing up and restoring 3scale by using OADP include::_attributes/common-attributes.adoc[] :context: backing-up-and-restoring-3scale-by-using-oadp @@ -15,7 +15,7 @@ In this example, the non-service affecting approach is used to back up and resto Additionally, ensure that you are restoring 3scale on the same cluster where it was backed up from. If you want to restore 3scale on a different cluster, ensure that both clusters are using the same custom domain. ==== -You can xref:../oadp-3scale/backing-up-3scale-by-using-oadp.adoc#backing-up-3scale-by-using-oadp[back up 3scale] and xref:../oadp-3scale/restoring-3scale-by-using-oadp.adoc#restoring-3scale-by-using-oadp[restore 3scale] by using OADP. +You can xref:../../../backup_and_restore/application_backup_and_restore/oadp-3scale/backing-up-3scale-by-using-oadp.adoc#backing-up-3scale-by-using-oadp[back up 3scale] and xref:../../../backup_and_restore/application_backup_and_restore/oadp-3scale/restoring-3scale-by-using-oadp.adoc#restoring-3scale-by-using-oadp[restore 3scale] by using OADP. .Prerequisites diff --git a/backup_and_restore/application_backup_and_restore/oadp-3scale/restoring-3scale-by-using-oadp.adoc b/backup_and_restore/application_backup_and_restore/oadp-3scale/restoring-3scale-by-using-oadp.adoc index 39cac36c890f..6f0e1d696aaa 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-3scale/restoring-3scale-by-using-oadp.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-3scale/restoring-3scale-by-using-oadp.adoc @@ -1,12 +1,12 @@ :_mod-docs-content-type: ASSEMBLY -[id="restoring-3scale-by-using-oadp{context}"] +[id="restoring-3scale-by-using-oadp"] = Restoring 3scale by using OADP include::_attributes/common-attributes.adoc[] :context: restoring-3scale-by-using-oadp toc::[] -You can restore the 3scale by restoring the backed up 3scale Operator resources, and databses such as mysql and Redis. Once the data has been restored, you can scale up the 3scale Operator and deployment. +You can restore the 3scale by restoring the backed up 3scale Operator resources, and databses such as mysql and Redis. Once the data has been restored, you can scale up the 3scale Operator and deployment. include::modules/restoring-the-secrets-and-apimanager.adoc[leveloffset=+1] @@ -14,4 +14,4 @@ include::modules/restoring-the-mysql-database.adoc[leveloffset=+1] include::modules/restoring-the-backend-redis-database.adoc[leveloffset=+1] -include::modules/scaling-up-the-3scale-operator-and-deployment.adoc[leveloffset=+1] \ No newline at end of file +include::modules/scaling-up-the-3scale-operator-and-deployment.adoc[leveloffset=+1]