Skip to content

Commit 4ff33b6

Browse files
stevsmitstevsmit
authored
Merge pull request #71534 from CarmiWisemon/oadp3144-aws-sts
OADP 3144 - Installing OADP on an AWS STS cluster manually
2 parents 00b3e61 + 9617ee6 commit 4ff33b6

13 files changed

+756
-2
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3088,6 +3088,11 @@ Topics:
30883088
Topics:
30893089
- Name: Backing up applications on ROSA STS using OADP
30903090
File: oadp-rosa-backing-up-applications
3091+
- Name: OADP and AWS STS
3092+
Dir: aws-sts
3093+
Topics:
3094+
- Name: Backing up applications on AWS STS using OADP
3095+
File: oadp-aws-sts
30913096
- Name: OADP 1.2 Data Mover
30923097
Dir: installing
30933098
Topics:

‎backup_and_restore/application_backup_and_restore/aws-sts/_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/aws-sts/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/aws-sts/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/aws-sts/oadp-aws-sts.adoc

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="oadp-aws-sts"]
3+
= Backing up applications on AWS STS using OADP
4+
include::_attributes/common-attributes.adoc[]
5+
:context: oadp-aws-sts-backing-up-applications
6+
7+
toc::[]
8+
9+
You install the {oadp-first} with {aws-first} by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
10+
11+
include::snippets/oadp-mtc-operator.adoc[]
12+
13+
You configure {aws-short} for Velero, create a default `Secret`, and then install the Data Protection Application. For more details, see xref:../../..//backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc#oadp-installing-operator-doc[Installing the OADP Operator].
14+
15+
To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.
16+
17+
You can install {oadp-short} on an AWS {sts-first} (AWS STS) cluster manually. Amazon {aws-short} provides {aws-short} STS as a web service that enables you to request temporary, limited-privilege credentials for users. You use STS to provide trusted users with temporary access to resources via API calls, your {aws-short} console, or the {aws-short} command line interface (CLI).
18+
19+
Before installing {oadp-first}, you must set up role and policy credentials for {oadp-short} so that it can use the {aws-full} API.
20+
21+
This process is performed in the following two stages:
22+
23+
. Prepare {aws-short} credentials.
24+
. Install the OADP Operator and give it an IAM role.
25+
26+
include::modules/preparing-aws-sts-credentials-for-oadp.adoc[leveloffset=+1]
27+
28+
include::modules/oadp-setting-resource-limits-and-requests.adoc[leveloffset=+2]
29+
30+
include::modules/installing-oadp-aws-sts.adoc[leveloffset=+1]
31+
32+
[role="_additional-resources"]
33+
.Additional resources
34+
35+
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub using the web console]
36+
* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[Backing up applications]
37+
38+
[id="oadp-aws-sts-backing-up-and-cleaning"]
39+
== Backing up workload on OADP AWS STS, with an optional cleanup
40+
41+
include::modules/performing-a-backup-oadp-aws-sts.adoc[leveloffset=+2]
42+
43+
include::modules/cleanup-a-backup-oadp-aws-sts.adoc[leveloffset=+2]

‎backup_and_restore/application_backup_and_restore/aws-sts/snippets

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ include::modules/installing-oadp-rosa-sts.adoc[leveloffset=+1]
3232
[role="_additional-resources"]
3333
.Additional resources
3434

35-
* 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].
36-
* 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]
35+
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub using the web console].
36+
* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[Backing up applications]
3737
3838
[id="oadp-rosa-backing-up-and-cleaning"]
3939
== Example: Backing up workload on OADP ROSA STS, with an optional cleanup

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

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

0 commit comments

Comments
 (0)