Skip to content

[enterprise-4.15] OADP-2736: Restoring to a different cluster with OADP with STS enabled ROSA #68523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 29, 2023
Merged

[enterprise-4.15] OADP-2736: Restoring to a different cluster with OADP with STS enabled ROSA #68523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 36 additions & 15 deletions modules/oadp-installing-oadp-rosa-sts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The Data Mover feature is not currently supported in ROSA clusters. You can use

.Prerequisites

* A ROSA OpenShift Cluster with the required access and tokens. For instructions, see the procedure in _Preparing AWS credentials_.
* A {openshift-rosa} cluster with the required access and tokens. For instructions, see the procedure in "Preparing AWS credentials". If you plan to use two different clusters for backing up and restoring, you need to prepare AWS credentials, including `ROLE_ARN`, for each cluster.


.Procedure
Expand Down Expand Up @@ -90,7 +90,7 @@ spec:
EOF
----

. Create the `DataProtectionApplication resource`, which is used to configure the connection to the storage where the backups and volume snapshots will be stored:
. Create the `DataProtectionApplication` resource, which is used to configure the connection to the storage where the backups and volume snapshots are stored:
+
[source,terminal]
----
Expand All @@ -116,28 +116,49 @@ spec:
defaultPlugins:
- openshift
- aws
restic:
nodeAgent: <1>
enable: false
uploaderType: restic
snapshotLocations:
- velero:
config:
credentialsFile: /tmp/credentials/openshift-adp/cloud-credentials-credentials <1>
enableSharedConfig: "true" <2>
profile: default <3>
region: ${REGION} <4>
credentialsFile: /tmp/credentials/openshift-adp/cloud-credentials-credentials <2>
enableSharedConfig: "true" <3>
profile: default <4>
region: ${REGION} <5>
provider: aws
EOF
----

+
<1> The `credentialsFile` is the mounted location of the bucket credential on the pod.
<2> The `enableSharedConfig` allows the `snapshotLocations` to share or reuse the credential defined for the bucket.
<3> Assume your Velero default for your `profile: default`.
<4> Specify `region` as your AWS region. This must be the same as the cluster region.
<1> See the first note below.
<2> The `credentialsFile` field is the mounted location of the bucket credential on the pod.
<3> The `enableSharedConfig` field allows the `snapshotLocations` to share or reuse the credential defined for the bucket.
<4> Use the profile name set in the AWS credentials file.
<5> Specify `region` as your AWS region. This must be the same as the cluster region.
+
You are now ready to backup and restore OpenShift applications, as described in the link:https://docs.openshift.com/container-platform/4.11/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.html[OADP documentation].

[NOTE]
====
The `enable` parameter of `restic` is set to `false` in this configuration because OADP does not support Restic in ROSA environments.

If you are using OADP 1.2, replace this configuration:
[source,terminal]

----
nodeAgent:
enable: false
uploaderType: restic
----
with the following:

[source,terminal]
----
restic:
enable: false
----
====
+
You are now ready to backup and restore OpenShift applications, as described in the link:https://docs.openshift.com/container-platform/4.11/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.html[OADP documentation].

[NOTE]
====
If you want to use two different clusters for backing up and restoring, the two clusters must have identical AWS S3 storage names in both the cloudstorage CR and the OADP `DataProtectionApplication` configuration.
====
2 changes: 1 addition & 1 deletion rosa_backing_up_and_restoring_applications/backing-up-applications.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ include::modules/oadp-installing-oadp-rosa-sts.adoc[leveloffset=+1]

[id="rosa-backing-up-applications-known-issues"]
== Known issues
.Restic is not supported or recommended
.Restic, Kopia, and DataMover are not supported or recommended

* link:https://issues.redhat.com/browse/OADP-1054[CloudStorage: openshift-adp-controller-manager crashloop seg fault with Restic enabled]
* link:https://issues.redhat.com/browse/OADP-1057[Cloudstorage API: CSI Backup of an app with internal images partially fails with plugin panicked error]
Expand Down