Skip to content

Commit 5c460e4

Browse files
shdeshpa07shdeshpa07
committed
OADP-4622 Multiple BSL and VSL
1 parent c47ab29 commit 5c460e4

11 files changed

+375
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3272,6 +3272,10 @@ Topics:
32723272
File: installing-oadp-ocs
32733273
- Name: Configuring OADP with OpenShift Virtualization
32743274
File: installing-oadp-kubevirt
3275+
- Name: Configuring OADP with multiple backup storage locations
3276+
File: configuring-oadp-multiple-bsl
3277+
- Name: Configuring OADP with multiple Volume Snapshot Locations
3278+
File: configuring-oadp-multiple-vsl
32753279
- Name: Uninstalling OADP
32763280
Dir: installing
32773281
Topics:

‎backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="configuring-oadp-multiple-bsl"]
3+
= Configuring the {oadp-first} with more than one Backup Storage Location
4+
include::_attributes/common-attributes.adoc[]
5+
:context: configuring-oadp-multiple-bsl
6+
:configuring-oadp-multiple-bsl:
7+
8+
9+
toc::[]
10+
11+
12+
You can configure one or more backup storage locations (BSLs) in the Data Protection Application (DPA). You can also select the location to store the backup in when you create the backup. With this configuration, you can store your backups in the following ways:
13+
14+
* To different regions
15+
* To a different storage provider
16+
17+
{oadp-short} supports multiple credentials for configuring more than one BSL, so that you can specify the credentials to use with any BSL.
18+
19+
// module for configuring the DPA with multiple BSLs.
20+
include::modules/oadp-configuring-dpa-multiple-bsl.adoc[leveloffset=+1]
21+
// module for multiple BSL use case.
22+
include::modules/oadp-multiple-bsl-use-case.adoc[leveloffset=+1]
23+
24+
[role="_additional-resources"]
25+
.Additional resources
26+
27+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#oadp-secrets-for-different-credentials_installing-oadp-aws[Creating profiles for different credentials]
28+
29+
:!configuring-oadp-multiple-bsl:

‎backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-vsl.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="configuring-oadp-multiple-vsl"]
3+
= Configuring the {oadp-first} with more than one Volume Snapshot Location
4+
include::_attributes/common-attributes.adoc[]
5+
:context: configuring-oadp-multiple-vsl
6+
:configuring-oadp-multiple-vsl:
7+
8+
toc::[]
9+
10+
11+
You can configure one or more Volume Snapshot Locations (VSLs) to store the snapshots in different cloud provider regions.
12+
13+
// module for configuring the DPA with multiple VSLs.
14+
include::modules/oadp-configuring-dpa-multiple-vsl.adoc[leveloffset=+1]
15+
16+
17+
:!configuring-oadp-multiple-vsl:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
3636

3737
include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
3838
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
39+
include::modules/oadp-configuring-dpa-multiple-bsl.adoc[leveloffset=+1]
3940
include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
4041

4142
[role="_additional-resources"]

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,6 @@ include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
4040

4141
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins]
4242

43+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc#configuring-oadp-multiple-bsl[Configuring the {oadp-first} with multiple backup storage locations]
44+
4345
:installing-oadp-azure!:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,6 @@ include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
4141

4242
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins]
4343

44+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc#configuring-oadp-multiple-bsl[Configuring the {oadp-first} with multiple backup storage locations]
45+
4446
:installing-oadp-gcp!:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,6 @@ include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
5050

5151
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins]
5252

53+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc#configuring-oadp-multiple-bsl[Configuring the {oadp-first} with multiple backup storage locations]
54+
5355
:installing-oadp-mcg!:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,6 @@ include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
5151

5252
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins]
5353

54+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc#configuring-oadp-multiple-bsl[Configuring the {oadp-first} with multiple backup storage locations]
55+
5456
:installing-oadp-ocs!:

‎modules/oadp-configuring-dpa-multiple-bsl.adoc

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc
4+
5+
6+
:_mod-docs-content-type: PROCEDURE
7+
[id="oadp-configuring-dpa-multiple-bsl_{context}"]
8+
= Configuring the DPA with more than one BSL
9+
10+
You can configure the DPA with more than one BSL and specify the credentials provided by the cloud provider.
11+
12+
.Prerequisites
13+
14+
* You must install the {oadp-short} Operator.
15+
* You must create the secrets by using the credentials provided by the cloud provider.
16+
17+
.Procedure
18+
19+
. Configure the DPA with more than one BSL. See the following example.
20+
+
21+
.Example DPA
22+
[source,yaml]
23+
----
24+
apiVersion: oadp.openshift.io/v1alpha1
25+
kind: DataProtectionApplication
26+
#...
27+
backupLocations:
28+
- name: aws # <1>
29+
velero:
30+
provider: aws
31+
default: true # <2>
32+
objectStorage:
33+
bucket: <bucket_name> # <3>
34+
prefix: <prefix> # <4>
35+
config:
36+
region: <region_name> # <5>
37+
profile: "default"
38+
credential:
39+
key: cloud
40+
name: cloud-credentials # <6>
41+
- name: odf # <7>
42+
velero:
43+
provider: aws
44+
default: false
45+
objectStorage:
46+
bucket: <bucket_name>
47+
prefix: <prefix>
48+
config:
49+
profile: "default"
50+
region: <region_name>
51+
s3Url: <url> # <8>
52+
insecureSkipTLSVerify: "true"
53+
s3ForcePathStyle: "true"
54+
credential:
55+
key: cloud
56+
name: <custom_secret_name_odf> # <9>
57+
#...
58+
----
59+
<1> Specify a name for the first BSL.
60+
<2> This parameter indicates that this BSL is the default BSL. If a BSL is not set in the `Backup CR`, the default BSL is used. You can set only one BSL as the default.
61+
<3> Specify the bucket name.
62+
<4> Specify a prefix for Velero backups; for example, `velero`.
63+
<5> Specify the AWS region for the bucket.
64+
<6> Specify the name of the default `Secret` object that you created.
65+
<7> Specify a name for the second BSL.
66+
<8> Specify the URL of the S3 endpoint.
67+
<9> Specify the correct name for the `Secret`; for example, `custom_secret_name_odf`. If you do not specify a `Secret` name, the default name is used.
68+
69+
. Specify the BSL to be used in the backup CR. See the following example.
70+
+
71+
.Example backup CR
72+
[source,yaml]
73+
----
74+
apiVersion: velero.io/v1
75+
kind: Backup
76+
# ...
77+
spec:
78+
includedNamespaces:
79+
- <namespace> # <1>
80+
storageLocation: <backup_storage_location> # <2>
81+
defaultVolumesToFsBackup: true
82+
----
83+
<1> Specify the namespace to back up.
84+
<2> Specify the storage location.

‎modules/oadp-configuring-dpa-multiple-vsl.adoc

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-vsl.adoc
4+
5+
6+
:_mod-docs-content-type: CONCEPT
7+
[id="oadp-configuring-dpa-multiple-vsl_{context}"]
8+
= Configuring the DPA with more than one VSL
9+
10+
You configure the DPA with more than one VSL and specify the credentials provided by the cloud provider. Make sure that you configure the snapshot location in the same region as the persistent volumes. See the following example.
11+
12+
.Example DPA
13+
[source,yaml]
14+
----
15+
apiVersion: oadp.openshift.io/v1alpha1
16+
kind: DataProtectionApplication
17+
#...
18+
snapshotLocations:
19+
- velero:
20+
config:
21+
profile: default
22+
region: <region> # <1>
23+
credential:
24+
key: cloud
25+
name: cloud-credentials
26+
provider: aws
27+
- velero:
28+
config:
29+
profile: default
30+
region: <region>
31+
credential:
32+
key: cloud
33+
name: <custom_credential> # <2>
34+
provider: aws
35+
#...
36+
----
37+
<1> Specify the region. The snapshot location must be in the same region as the persistent volumes.
38+
<2> Specify the custom credential name.

0 commit comments

Comments
 (0)