Skip to content

OADP-6348-dita-vale-oadp-usecases #95785

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

OADP-6348-dita-vale-oadp-usecases #95785

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
1 change: 1 addition & 0 deletions ...pplication_backup_and_restore/oadp-use-cases/oadp-usecase-backup-using-odf.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

[role="_abstract"]
Following is a use case for using {oadp-short} and {odf-short} to back up an application.

//backup
Expand Down
1 change: 1 addition & 0 deletions .../application_backup_and_restore/oadp-use-cases/oadp-usecase-enable-ca-cert.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

[role="_abstract"]
You can include a self-signed Certificate Authority (CA) certificate in the Data Protection Application (DPA) and then back up an application. You store the backup in a NooBaa bucket provided by {odf-first}.

// include a CA cert and run a backup
Expand Down
1 change: 1 addition & 0 deletions ...plication_backup_and_restore/oadp-use-cases/oadp-usecase-legacy-aws-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

[role="_abstract"]
If you are using an {aws-short} S3-compatible backup storage location, you might get a `SignatureDoesNotMatch` error while backing up your application. This error occurs because some backup storage locations still use the older versions of the S3 APIs, which are incompatible with the newer AWS SDK for Go V2. To resolve this issue, you can use the `legacy-aws` Velero plugin in the `DataProtectionApplication` custom resource (CR). The `legacy-aws` Velero plugin uses the older AWS SDK for Go V1, which is compatible with the legacy S3 APIs, ensuring successful backups.

// using legacy-aws velero plugin
Expand Down
1 change: 1 addition & 0 deletions ...backup_and_restore/oadp-use-cases/oadp-usecase-restore-different-namespace.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

[role="_abstract"]
Following is a use case for using {oadp-short} to restore a backup to a different namespace.

//restore
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-usecase-backup-odf.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-usecase-backup-odf_{context}"]
= Backing up an application using {oadp-short} and {odf-short}

[role="_abstract"]
In this use case, you back up an application by using {oadp-short} and store the backup in an object storage provided by {odf-first}.

* You create an object bucket claim (OBC) to configure the backup storage location. You use {odf-short} to configure an Amazon S3-compatible object storage bucket. {odf-short} provides MultiCloud Object Gateway (NooBaa MCG) and Ceph Object Gateway, also known as RADOS Gateway (RGW), object storage service. In this use case, you use NooBaa MCG as the backup storage location.
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-usecase-include-ca-cert-backup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-usecase-include-ca-cert-backup_{context}"]
= Backing up an application and its self-signed CA certificate

[role="_abstract"]
The `s3.openshift-storage.svc` service, provided by {odf-short}, uses a Transport Layer Security protocol (TLS) certificate that is signed with the self-signed service CA.

To prevent a `certificate signed by unknown authority` error, you must include a self-signed CA certificate in the backup storage location (BSL) section of `DataProtectionApplication` custom resource (CR). For this situation, you must complete the following tasks:
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-usecase-restore.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-usecase-restore_{context}"]
= Restoring an application to a different namespace using {oadp-short}

[role="_abstract"]
Restore a backup of an application by using {oadp-short} to a new target namespace, `test-restore-application`. To restore a backup, you create a restore custom resource (CR) as shown in the following example. In the restore CR, the source namespace refers to the application namespace that you included in the backup. You then verify the restore by changing your project to the new restored namespace and verifying the resources.

.Prerequisites
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-using-legacy-aws-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[id="oadp-using-legacy-aws-plugin_{context}"]
= Using the legacy-aws Velero plugin in the DataProtectionApplication CR

[role="_abstract"]
In the following use case, you configure the `DataProtectionApplication` CR with the `legacy-aws` Velero plugin and then back up an application.

[NOTE]
Expand Down