Merge pull request #38248 from apinnick/oadp72-configuration

OADP-72: Configuration

Author: apinnick

_topic_maps/_topic_map.yml

@@ -2096,8 +2096,8 @@ Topics:
 # - Name: Application backup and restore
 #   Dir: application_backup_and_restore
 #   Topics:
-#   - Name: Application backup and restore
-#     File: placeholder
+#   - Name: Configuring OADP
+#     File: configuring-oadp
 - Name: Control plane backup and restore
   Dir: control_plane_backup_and_restore
   Topics:

backup_and_restore/application_backup_and_restore/configuring-oadp.adoc

@@ -0,0 +1,11 @@
+[id="configuring-oadp"]
+= Configuring the OpenShift API for Data Protection
+include::modules/common-attributes.adoc[]
+:context: configuring-oadp
+
+toc::[]
+
+You can set Velero resource allocations and enable self-signed CA certificates for the OpenShift API for Data Protection (OADP).
+
+include::modules/oadp-setting-resource-limits-and-requests.adoc[leveloffset=+1]
+include::modules/oadp-self-signed-certificate.adoc[leveloffset=+1]

backup_and_restore/application_backup_and_restore/placeholder.adoc

@@ -0,0 +1,40 @@
+// Module included in the following assemblies:
+//
+// * backup_and_restore/application_backup_and_restore/configuring-oadp.adoc
+
+[id="oadp-self-signed-certificate_{context}"]
+= Enabling self-signed CA certificates
+
+You must enable a self-signed CA certificate for object storage by editing the `DataProtectionApplication` custom resource (CR) manifest to prevent a `certificate signed by unknown authority` error.
+
+.Prerequisites
+
+* You must have the OpenShift API for Data Protection (OADP) Operator installed.
+
+.Procedure
+
+* Edit the `spec.backupLocations.velero.objectStorage.caCert` parameter and `spec.backupLocations.velero.config` parameters of the `DataProtectionApplication` CR manifest:
++
+[source,yaml]
+----
+apiVersion: oadp.openshift.io/v1alpha1
+kind: DataProtectionApplication
+metadata:
+  name: <dpa-sample>
+spec:
+...
+  backupLocations:
+    - name: default
+      velero:
+        provider: aws
+        default: true
+        objectStorage:
+          bucket: <bucket>
+          prefix: <prefix>
+          caCert: <base64_encoded_cert_string> <1>
+        config:
+          insecureSkipTLSVerify: "false" <2>
+...
+----
+<1> Specify the Base46-encoded CA certificate string.
+<2> Must be `false` to disable SSL/TLS security.

modules/oadp-self-signed-certificate.adoc

@@ -0,0 +1,40 @@
+// Module included in the following assemblies:
+//
+// * backup_and_restore/application_backup_and_restore/configuring-oadp.adoc
+
+[id="oadp-setting-resource-limits-and-requests_{context}"]
+= Setting Velero CPU and memory resource allocations
+
+You set the CPU and memory resource allocations for the `Velero` pod by editing the  `DataProtectionApplication` custom resource (CR) manifest.
+
+.Prerequisites
+
+* You must have the OpenShift API for Data Protection (OADP) Operator installed.
+
+.Procedure
+
+* Edit the values in the `spec.configuration.velero.podConfig.ResourceAllocations` block of the `DataProtectionApplication` CR manifest, as in the following example:
++
+[source,yaml]
+----
+apiVersion: oadp.openshift.io/v1alpha1
+kind: DataProtectionApplication
+metadata:
+  name: <dpa-sample>
+spec:
+...
+  configuration:
+    velero:
+      podConfig:
+        resourceAllocations:
+          limits:
+            cpu: "1" <1>
+            memory: 512Mi <2>
+          requests:
+            cpu: 500m <3>
+            memory: 256Mi <4>
+----
+<1> Specify the value in millicpus or CPU units. Default value is `500m` or `1` CPU unit.
+<2> Default value is `512Mi`.
+<3> Default value is `500m` or `1` CPU unit.
+<4> Default value is `256Mi`.