Skip to content

Commit 5c33829

Browse files
committed
MD5 Checksum doc changes
1 parent bca9ba0 commit 5c33829

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

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
@@ -42,6 +42,7 @@ include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
4242
include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
4343
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
4444
include::modules/oadp-configuring-node-agents.adoc[leveloffset=+2]
45+
include::modules/oadp-configuring-aws-md5sum.adoc[leveloffset=+1]
4546
include::modules/oadp-configuring-dpa-multiple-bsl.adoc[leveloffset=+1]
4647
include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
4748
include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2]
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
4+
5+
6+
:_mod-docs-content-type: PROCEDURE
7+
[id="oadp-configuring-aws-md5sum_{context}"]
8+
= Configuring the backup storage location with a MD5 checksum algorithm
9+
10+
You can configure the Backup Storage Location (BSL) in the Data Protection Application (DPA) to use a MD5 checksum algorithm for both Amazon Simple Storage Service (Amazon S3) and S3-compatible storage providers. The checksum algorithm calculates the checksum for uploading and downloading objects to Amazon S3. You can use one of the following options to set the `checksumAlgorithm` field in the `spec.backupLocations.velero.config.checksumAlgorithm` section of the DPA.
11+
12+
* `CRC32`
13+
* `CRC32C`
14+
* `SHA1`
15+
* `SHA256`
16+
17+
[NOTE]
18+
====
19+
You can also set the `checksumAlgorithm` field to an empty value to skip the MD5 checksum check.
20+
21+
If you do not set a value for the `checksumAlgorithm` field, then the default value is set to `CRC32`.
22+
====
23+
24+
.Prerequisites
25+
26+
* You have installed the {oadp-short} Operator.
27+
* You have configured Amazon S3, or S3-compatible object storage as a backup location.
28+
29+
.Procedure
30+
31+
* Configure the BSL in the DPA as shown in the following example:
32+
+
33+
.Example Data Protection Application
34+
[source,yaml]
35+
----
36+
apiVersion: oadp.openshift.io/v1alpha1
37+
kind: DataProtectionApplication
38+
metadata:
39+
name: test-dpa
40+
namespace: openshift-adp
41+
spec:
42+
backupLocations:
43+
- name: default
44+
velero:
45+
config:
46+
checksumAlgorithm: "" # <1>
47+
insecureSkipTLSVerify: "true"
48+
profile: "default"
49+
region: <bucket_region>
50+
s3ForcePathStyle: "true"
51+
s3Url: <bucket_url>
52+
credential:
53+
key: cloud
54+
name: cloud-credentials
55+
default: true
56+
objectStorage:
57+
bucket: <bucket_name>
58+
prefix: velero
59+
provider: aws
60+
configuration:
61+
velero:
62+
defaultPlugins:
63+
- openshift
64+
- aws
65+
- csi
66+
----
67+
<1> Specify the `checksumAlgorithm`. In this example, the `checksumAlgorithm` field is set to an empty value. You can select an option from the following list: `CRC32`, `CRC32C`, `SHA1`, `SHA256`.
68+
69+
[IMPORTANT]
70+
====
71+
If you are using Noobaa as the object storage provider, and you do not set the `spec.backupLocations.velero.config.checksumAlgorithm` field in the DPA, an empty value of `checksumAlgorithm` is added to the BSL configuration.
72+
73+
The empty value is only added for BSLs that are created using the DPA. This value is not added if you create the BSL by using any other method.
74+
====
75+

0 commit comments

Comments
 (0)