Skip to content

Commit b0fbee6

Browse files
kcarmichael08kcarmichael08
authored
Merge pull request #69714 from CarmiWisemon/oadp3250rosa
OADP -3250 Updated1 - OADP ROSA docs xref mob docs
2 parents cb55056 + 9951179 commit b0fbee6

File tree

11 files changed

+739
-4
lines changed

11 files changed

+739
-4
lines changed

‎_attributes/common-attributes.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,13 +204,13 @@ endif::[]
204204
:secrets-store-driver: Secrets Store CSI driver
205205
:secrets-store-operator: Secrets Store CSI Driver Operator
206206
//AWS STS
207-
:sts-first: Security Token Service (STS)
208-
:sts-full: Security Token Service
207+
:sts-first: Security Token Service
208+
:sts-full: Security Token Service (STS)
209209
:sts-short: STS
210210
//Cloud provider names
211211
//AWS
212-
:aws-first: Amazon Web Services (AWS)
213-
:aws-full: Amazon Web Services
212+
:aws-first: Amazon Web Services
213+
:aws-full: Amazon Web Services (AWS)
214214
:aws-short: AWS
215215
//GCP
216216
:gcp-first: Google Cloud Platform (GCP)

‎_topic_maps/_topic_map.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3007,6 +3007,11 @@ Topics:
30073007
Topics:
30083008
- Name: Restoring applications
30093009
File: restoring-applications
3010+
- Name: OADP and ROSA
3011+
Dir: oadp-rosa
3012+
Topics:
3013+
- Name: Backing up applications on ROSA STS using OADP
3014+
File: oadp-rosa-backing-up-applications
30103015
- Name: OADP Data Mover
30113016
Dir: installing
30123017
Topics:

‎backup_and_restore/application_backup_and_restore/oadp-rosa/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../_attributes/

‎backup_and_restore/application_backup_and_restore/oadp-rosa/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../images/

‎backup_and_restore/application_backup_and_restore/oadp-rosa/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../modules

‎backup_and_restore/application_backup_and_restore/oadp-rosa/oadp-rosa-backing-up-applications.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="oadp-rosa-backing-up-applications"]
3+
= Backing up applications on ROSA clusters using OADP
4+
include::_attributes/common-attributes.adoc[]
5+
:context: oadp-rosa-backing-up-applications
6+
7+
toc::[]
8+
9+
You can use {oadp-first} with {product-rosa} (ROSA) clusters to back up and restore application data.
10+
11+
ROSA is a fully-managed, turnkey application platform that allows you to deliver value to your customers by building and deploying applications.
12+
13+
ROSA provides seamless integration with a wide range of {aws-first} compute, database, analytics, machine learning, networking, mobile, and other services to speed up the building and delivery of differentiating experiences to your customers.
14+
15+
You can subscribe to the service directly from your {aws-short} account.
16+
17+
After you create your clusters, you can operate your clusters with the {product-title} web console or through link:https://docs.openshift.com/dedicated/ocm/ocm-overview.html[{cluster-manager-first}]. You can also use ROSA with OpenShift APIs and command-line interface (CLI) tools.
18+
19+
For additional information about ROSA installation, see link:https://www.redhat.com/en/products/interactive-walkthrough/install-rosa[Installing Red Hat Openshift Service on AWS (ROSA) interactive walkthrough].
20+
21+
Before installing {oadp-first}, you must set up role and policy credentials for OADP so that it can use the {aws-full} API.
22+
23+
This process is performed in the following two stages:
24+
25+
. Prepare {aws-short} credentials
26+
. Install the OADP Operator and give it an IAM role
27+
28+
include::modules/preparing-aws-credentials-for-oadp.adoc[leveloffset=+1]
29+
30+
include::modules/installing-oadp-rosa-sts.adoc[leveloffset=+1]
31+
[role="_additional-resources"]
32+
.Additional resources
33+
34+
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html/operators/user-tasks#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub using the web console].
35+
* link:https://docs.openshift.com/container-platform/4.14/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.html[Backing up applications]
36+
37+
[id="oadp-rosa-backing-up-and-cleaning"]
38+
== Example: Backing up workload on OADP ROSA STS, with an optional cleanup
39+
40+
include::modules/performing-a-backup-oadp-rosa-sts.adoc[leveloffset=+2]
41+
include::modules/cleanup-a-backup-oadp-rosa-sts.adoc[leveloffset=+2]
42+

‎backup_and_restore/application_backup_and_restore/oadp-rosa/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../snippets/

‎modules/cleanup-a-backup-oadp-rosa-sts.adoc

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/application_backup_and_restore/oadp-rosa/oadp-rosa-backing-up-applications.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="cleanup-a-backup-oadp-rosa-sts_{context}"]
7+
= Cleaning up a cluster after a backup with OADP and ROSA STS
8+
9+
If you need to uninstall the {oadp-first} Operator together with the backups and the S3 bucket from this example, follow these instructions.
10+
11+
.Procedure
12+
13+
. Delete the workload by running the following command:
14+
+
15+
[source,terminal]
16+
----
17+
$ oc delete ns hello-world
18+
----
19+
. Delete the Data Protection Application (DPA) by running the following command:
20+
+
21+
[source,terminal]
22+
----
23+
$ oc -n openshift-adp delete dpa ${CLUSTER_NAME}-dpa
24+
----
25+
. Delete the cloud storage by running the following command:
26+
+
27+
[source,terminal]
28+
----
29+
$ oc -n openshift-adp delete cloudstorage ${CLUSTER_NAME}-oadp
30+
----
31+
+
32+
[WARNING]
33+
====
34+
If this command hangs, you might need to delete the finalizer by running the following command:
35+
[source,terminal]
36+
----
37+
$ oc -n openshift-adp patch cloudstorage ${CLUSTER_NAME}-oadp -p '{"metadata":{"finalizers":null}}' --type=merge
38+
----
39+
====
40+
. If the Operator is no longer required, remove it by running the following command:
41+
+
42+
[source,terminal]
43+
----
44+
$ oc -n openshift-adp delete subscription oadp-operator
45+
----
46+
. Remove the namespace from the Operator:
47+
+
48+
[source,terminal]
49+
----
50+
$ oc delete ns openshift-adp
51+
----
52+
53+
. If the backup and restore resources are no longer required, remove them from the cluster by running the following command:
54+
55+
+
56+
[source,terminal]
57+
----
58+
$ oc delete backup hello-world
59+
----
60+
+
61+
. To delete backup, restore and remote objects in {aws-short} S3 run the following command:
62+
+
63+
[source,terminal]
64+
----
65+
$ velero backup delete hello-world
66+
----
67+
. If you no longer need the Custom Resource Definitions (CRD), remove them from the cluster by running the following command:
68+
+
69+
[source,terminal]
70+
----
71+
$ for CRD in `oc get crds | grep velero | awk '{print $1}'`; do oc delete crd $CRD; done
72+
----
73+
. Delete the {aws-short} S3 bucket by running the following commands:
74+
+
75+
[source,terminal]
76+
----
77+
$ aws s3 rm s3://${CLUSTER_NAME}-oadp --recursive
78+
----
79+
+
80+
[source,terminal]
81+
----
82+
$ aws s3api delete-bucket --bucket ${CLUSTER_NAME}-oadp
83+
----
84+
. Detach the policy from the role by running the following command:
85+
+
86+
[source,terminal]
87+
----
88+
$ aws iam detach-role-policy --role-name "${ROLE_NAME}" \
89+
--policy-arn "${POLICY_ARN}"
90+
----
91+
. Delete the role by running the following command:
92+
+
93+
[source,terminal]
94+
----
95+
$ aws iam delete-role --role-name "${ROLE_NAME}"
96+
----

0 commit comments

Comments
 (0)