Skip to content

Commit ee4120b

Browse files
authored
Merge pull request #72112 from anarnold97/OADP-3522-ROSA-docs-missing-internal-image-backup
OADP-3522: ROSA docs is missing instructions related to the internal image backup
2 parents 8d43475 + 05fa993 commit ee4120b

File tree

3 files changed

+35
-16
lines changed

3 files changed

+35
-16
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ This process is performed in the following two stages:
2828
include::modules/preparing-aws-credentials-for-oadp.adoc[leveloffset=+1]
2929

3030
include::modules/installing-oadp-rosa-sts.adoc[leveloffset=+1]
31+
3132
[role="_additional-resources"]
3233
.Additional resources
3334

@@ -38,4 +39,5 @@ include::modules/installing-oadp-rosa-sts.adoc[leveloffset=+1]
3839
== Example: Backing up workload on OADP ROSA STS, with an optional cleanup
3940

4041
include::modules/performing-a-backup-oadp-rosa-sts.adoc[leveloffset=+2]
42+
4143
include::modules/cleanup-a-backup-oadp-rosa-sts.adoc[leveloffset=+2]

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

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,39 @@ If you need to uninstall the {oadp-first} Operator together with the backups and
1616
----
1717
$ oc delete ns hello-world
1818
----
19+
1920
. Delete the Data Protection Application (DPA) by running the following command:
2021
+
2122
[source,terminal]
2223
----
2324
$ oc -n openshift-adp delete dpa ${CLUSTER_NAME}-dpa
2425
----
26+
2527
. Delete the cloud storage by running the following command:
2628
+
2729
[source,terminal]
2830
----
2931
$ oc -n openshift-adp delete cloudstorage ${CLUSTER_NAME}-oadp
3032
----
33+
3134
+
3235
[WARNING]
3336
====
3437
If this command hangs, you might need to delete the finalizer by running the following command:
38+
3539
[source,terminal]
3640
----
3741
$ oc -n openshift-adp patch cloudstorage ${CLUSTER_NAME}-oadp -p '{"metadata":{"finalizers":null}}' --type=merge
3842
----
3943
====
44+
4045
. If the Operator is no longer required, remove it by running the following command:
4146
+
4247
[source,terminal]
4348
----
4449
$ oc -n openshift-adp delete subscription oadp-operator
4550
----
51+
4652
. Remove the namespace from the Operator:
4753
+
4854
[source,terminal]
@@ -51,25 +57,26 @@ $ oc delete ns openshift-adp
5157
----
5258

5359
. If the backup and restore resources are no longer required, remove them from the cluster by running the following command:
54-
5560
+
5661
[source,terminal]
5762
----
5863
$ oc delete backup hello-world
5964
----
60-
+
65+
6166
. To delete backup, restore and remote objects in {aws-short} S3 run the following command:
6267
+
6368
[source,terminal]
6469
----
6570
$ velero backup delete hello-world
6671
----
72+
6773
. If you no longer need the Custom Resource Definitions (CRD), remove them from the cluster by running the following command:
6874
+
6975
[source,terminal]
7076
----
7177
$ for CRD in `oc get crds | grep velero | awk '{print $1}'`; do oc delete crd $CRD; done
7278
----
79+
7380
. Delete the {aws-short} S3 bucket by running the following commands:
7481
+
7582
[source,terminal]
@@ -81,13 +88,14 @@ $ aws s3 rm s3://${CLUSTER_NAME}-oadp --recursive
8188
----
8289
$ aws s3api delete-bucket --bucket ${CLUSTER_NAME}-oadp
8390
----
91+
8492
. Detach the policy from the role by running the following command:
8593
+
8694
[source,terminal]
8795
----
88-
$ aws iam detach-role-policy --role-name "${ROLE_NAME}" \
89-
--policy-arn "${POLICY_ARN}"
96+
$ aws iam detach-role-policy --role-name "${ROLE_NAME}" --policy-arn "${POLICY_ARN}"
9097
----
98+
9199
. Delete the role by running the following command:
92100
+
93101
[source,terminal]

modules/installing-oadp-rosa-sts.adoc

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ $ cat << EOF | oc create -f -
155155
name: ${CLUSTER_NAME}-dpa
156156
namespace: openshift-adp
157157
spec:
158-
backupImages: false
158+
backupImages: true <1>
159159
features:
160160
dataMover:
161161
enable: false
@@ -166,6 +166,7 @@ $ cat << EOF | oc create -f -
166166
credential:
167167
key: credentials
168168
name: cloud-credentials
169+
prefix: velero
169170
default: true
170171
config:
171172
region: ${REGION}
@@ -179,6 +180,8 @@ $ cat << EOF | oc create -f -
179180
enable: false
180181
EOF
181182
----
183+
<1> ROSA supports internal image backup. Set this field to `false` if you do not want to use image backup.
184+
182185
// . Create the `DataProtectionApplication` resource, which is used to configure the connection to the storage where the backups and volume snapshots are stored:
183186

184187
.. If you are using CSI or non-CSI volumes, deploy a Data Protection Application by entering the following command:
@@ -192,13 +195,18 @@ $ cat << EOF | oc create -f -
192195
name: ${CLUSTER_NAME}-dpa
193196
namespace: openshift-adp
194197
spec:
198+
backupImages: true <1>
199+
features:
200+
dataMover:
201+
enable: false
195202
backupLocations:
196203
- bucket:
197204
cloudStorageRef:
198205
name: ${CLUSTER_NAME}-oadp
199206
credential:
200207
key: credentials
201208
name: cloud-credentials
209+
prefix: velero
202210
default: true
203211
config:
204212
region: ${REGION}
@@ -207,24 +215,25 @@ $ cat << EOF | oc create -f -
207215
defaultPlugins:
208216
- openshift
209217
- aws
210-
nodeAgent: <1>
218+
nodeAgent: <2>
211219
enable: false
212220
uploaderType: restic
213221
snapshotLocations:
214222
- velero:
215223
config:
216-
credentialsFile: /tmp/credentials/openshift-adp/cloud-credentials-credentials <2>
217-
enableSharedConfig: "true" <3>
218-
profile: default <4>
219-
region: ${REGION} <5>
224+
credentialsFile: /tmp/credentials/openshift-adp/cloud-credentials-credentials <3>
225+
enableSharedConfig: "true" <4>
226+
profile: default <5>
227+
region: ${REGION} <6>
220228
provider: aws
221229
EOF
222230
----
223-
<1> See the following note.
224-
<2> The `credentialsFile` field is the mounted location of the bucket credential on the pod.
225-
<3> The `enableSharedConfig` field allows the `snapshotLocations` to share or reuse the credential defined for the bucket.
226-
<4> Use the profile name set in the {aws-short} credentials file.
227-
<5> Specify `region` as your {aws-short} region. This must be the same as the cluster region.
231+
<1> ROSA supports internal image backup. Set this field to false if you do not want to use image backup.
232+
<2> See the following note.
233+
<3> The `credentialsFile` field is the mounted location of the bucket credential on the pod.
234+
<4> The `enableSharedConfig` field allows the `snapshotLocations` to share or reuse the credential defined for the bucket.
235+
<5> Use the profile name set in the {aws-short} credentials file.
236+
<6> Specify `region` as your {aws-short} region. This must be the same as the cluster region.
228237
+
229238
You are now ready to back up and restore {product-title} applications, as described in _Backing up applications_.
230239

@@ -233,8 +242,8 @@ You are now ready to back up and restore {product-title} applications, as descri
233242
The `enable` parameter of `restic` is set to `false` in this configuration, because OADP does not support Restic in ROSA environments.
234243
235244
If you use OADP 1.2, replace this configuration:
236-
[source,terminal]
237245
246+
[source,terminal]
238247
----
239248
nodeAgent:
240249
enable: false

0 commit comments

Comments
 (0)