Merge pull request #95068 from shdeshpa07/OADP-6250-mod-docs

xenolinux · web-flow · commit 9e6cc53a41c2 · 2025-07-10T13:34:15.000+05:30
Oadp 6250 mod docs - Configuring OADP on AWS
diff --git a/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc b/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc
@@ -53,7 +53,6 @@ include::modules/oadp-s3-compatible-backup-storage-providers.adoc[leveloffset=+1
 
 include::modules/oadp-configuring-noobaa-for-dr.adoc[leveloffset=+1]
 
-[discrete]
 [role="_additional-resources"]
 .Additional resources
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc b/backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc
@@ -24,6 +24,6 @@ include::modules/oadp-multiple-bsl-use-case.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* 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]
+* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#oadp-aws-secrets-for-different-credentials_installing-oadp-aws[Creating profiles for different credentials]
 
 :!configuring-oadp-multiple-bsl:
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
@@ -9,6 +9,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
+[role="_abstract"]
 You install the OpenShift API for Data Protection (OADP) with Amazon Web Services (AWS) S3 compatible storage by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
 
 include::snippets/oadp-mtc-operator.adoc[]
@@ -23,7 +24,7 @@ include::modules/oadp-s3-and-gov-cloud.adoc[leveloffset=+1]
 include::modules/migration-configuring-aws-s3.adoc[leveloffset=+1]
 include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
 include::modules/oadp-creating-default-secret.adoc[leveloffset=+2]
-include::modules/oadp-secrets-for-different-credentials.adoc[leveloffset=+2]
+include::modules/oadp-aws-secrets-for-different-credentials.adoc[leveloffset=+2]
 include::modules/oadp-configuring-aws-bsl.adoc[leveloffset=+2]
 include::modules/oadp-ssec-encrypted-backups.adoc[leveloffset=+2]
 
@@ -46,6 +47,7 @@ include::snippets/oadp-nodeselector-snippet.adoc[]
 For more details, see xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#oadp-configuring-node-agents_installing-oadp-aws[Configuring node agents and node labels].
 
 include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
+include::modules/oadp-using-ca-certificates-with-velero-command.adoc[leveloffset=+2]
 
 // include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
 include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
@@ -35,6 +35,7 @@ include::snippets/oadp-nodeselector-snippet.adoc[]
 For more details, see xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc#oadp-configuring-node-agents_installing-oadp-azure[Configuring node agents and node labels].
 
 include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
+include::modules/oadp-using-ca-certificates-with-velero-command.adoc[leveloffset=+2]
 
 // include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
 include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
@@ -35,6 +35,7 @@ include::snippets/oadp-nodeselector-snippet.adoc[]
 For more details, see xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc#oadp-configuring-node-agents_installing-oadp-gcp[Configuring node agents and node labels].
 
 include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
+include::modules/oadp-using-ca-certificates-with-velero-command.adoc[leveloffset=+2]
 
 // include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
 include::modules/oadp-gcp-wif-cloud-authentication.adoc[leveloffset=+1]
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
@@ -40,6 +40,7 @@ include::snippets/oadp-nodeselector-snippet.adoc[]
 For more details, see xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#oadp-configuring-node-agents_installing-oadp-mcg[Configuring node agents and node labels].
 
 include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
+include::modules/oadp-using-ca-certificates-with-velero-command.adoc[leveloffset=+2]
 
 // include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
 include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
@@ -45,6 +45,7 @@ For more details, see xref:../../../backup_and_restore/application_backup_and_re
 
 include::modules/oadp-odf-cpu-memory-requirements.adoc[leveloffset=+3]
 include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
+include::modules/oadp-using-ca-certificates-with-velero-command.adoc[leveloffset=+2]
 
 // include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
 include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
diff --git a/backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc b/backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc
@@ -6,20 +6,10 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-You can install the OpenShift API for Data Protection (OADP) Operator on {product-title} {product-version} by using Operator Lifecycle Manager (OLM).
+You can install the {oadp-first} Operator on {product-title} {product-version} by using Operator Lifecycle Manager (OLM).
 
 The OADP Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
 
-.Prerequisites
-
-* You must be logged in as a user with `cluster-admin` privileges.
-
-.Procedure
-
-. In the {product-title} web console, click *Operators* -> *OperatorHub*.
-. Use the *Filter by keyword* field to find the *OADP Operator*.
-. Select the *OADP Operator* and click *Install*.
-. Click *Install* to install the Operator in the `openshift-adp` project.
-. Click *Operators* -> *Installed Operators* to verify the installation.
+include::modules/installing-operator-oadp.adoc[leveloffset=+1]
 
 include::modules/velero-oadp-version-relationship.adoc[leveloffset=+1]
diff --git a/modules/installing-operator-oadp.adoc b/modules/installing-operator-oadp.adoc
@@ -0,0 +1,17 @@
+:_mod-docs-content-type: PROCEDURE
+[id="installing-operator-oadp_{context}"]
+= Installing the OADP Operator
+
+Use the following procedure to install the {oadp-short} Operator.
+
+.Prerequisites
+
+* You must be logged in as a user with `cluster-admin` privileges.
+
+.Procedure
+
+. In the {product-title} web console, click *Operators* -> *OperatorHub*.
+. Use the *Filter by keyword* field to find the *OADP Operator*.
+. Select the *OADP Operator* and click *Install*.
+. Click *Install* to install the Operator in the `openshift-adp` project.
+. Click *Operators* -> *Installed Operators* to verify the installation.
diff --git a/modules/oadp-about-backup-snapshot-locations-secrets.adoc b/modules/oadp-about-backup-snapshot-locations-secrets.adoc
@@ -13,7 +13,6 @@
 You specify backup and snapshot locations and their secrets in the `DataProtectionApplication` custom resource (CR).
 
 [id="backup-locations_{context}"]
-[discrete]
 == Backup locations
 
 You can specify one of the following AWS S3-compatible object storage solutions as a backup location:
@@ -27,7 +26,6 @@ You can specify one of the following AWS S3-compatible object storage solutions
 Velero backs up {product-title} resources, Kubernetes objects, and internal images as an archive file on object storage.
 
 [id="snapshot-locations_{context}"]
-[discrete]
 == Snapshot locations
 
 If you use your cloud provider's native snapshot API to back up persistent volumes, you must specify the cloud provider as the snapshot location.
@@ -37,7 +35,6 @@ If you use Container Storage Interface (CSI) snapshots, you do not need to speci
 If you use File System Backup (FSB), you do not need to specify a snapshot location because FSB backs up the file system on object storage.
 
 [id="secrets_{context}"]
-[discrete]
 == Secrets
 
 If the backup and snapshot locations use the same credentials or if you do not require a snapshot location, you create a default `Secret`.
diff --git a/modules/oadp-about-disable-node-agent-dpa.adoc b/modules/oadp-about-disable-node-agent-dpa.adoc
@@ -10,6 +10,7 @@
 [id="oadp-about-disable-node-agent-dpa_{context}"]
 = Disabling the node agent in DataProtectionApplication
 
+[role="_abstract"]
 If you are not using `Restic`, `Kopia`, or `DataMover` for your backups, you can disable the `nodeAgent` field in the `DataProtectionApplication` custom resource (CR). Before you disable `nodeAgent`, ensure the {oadp-short} Operator is idle and not running any backups.
 
 .Procedure
diff --git a/modules/oadp-aws-secrets-for-different-credentials.adoc b/modules/oadp-aws-secrets-for-different-credentials.adoc
@@ -0,0 +1,67 @@
+// Module included in the following assemblies:
+//
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="oadp-aws-secrets-for-different-credentials_{context}"]
+= Creating profiles for different credentials
+
+[role="_abstract"]
+If your backup and snapshot locations use different credentials, you create separate profiles in the `credentials-velero` file.
+
+Then, you create a `Secret` object and specify the profiles in the `DataProtectionApplication` custom resource (CR).
+
+.Procedure
+
+. Create a `credentials-velero` file with separate profiles for the backup and snapshot locations, as in the following example:
++
+[source,terminal]
+----
+[backupStorage]
+aws_access_key_id=<AWS_ACCESS_KEY_ID>
+aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>
+
+[volumeSnapshot]
+aws_access_key_id=<AWS_ACCESS_KEY_ID>
+aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>
+----
+
+. Create a `Secret` object with the `credentials-velero` file:
++
+[source,terminal,subs="attributes+"]
+----
+$ oc create secret generic {credentials} -n openshift-adp --from-file cloud=credentials-velero <1>
+----
+
+. Add the profiles to the `DataProtectionApplication` CR, as in the following example:
++
+[source,yaml,subs="attributes+"]
+----
+apiVersion: oadp.openshift.io/v1alpha1
+kind: DataProtectionApplication
+metadata:
+  name: <dpa_sample>
+  namespace: openshift-adp
+spec:
+...
+  backupLocations:
+    - name: default
+      velero:
+        provider: {provider}
+        default: true
+        objectStorage:
+          bucket: <bucket_name>
+          prefix: <prefix>
+        config:
+          region: us-east-1
+          profile: "backupStorage"
+        credential:
+          key: cloud
+          name: {credentials}
+  snapshotLocations:
+    - velero:
+        provider: {provider}
+        config:
+          region: us-west-2
+          profile: "volumeSnapshot"
+----
diff --git a/modules/oadp-configuring-aws-md5sum.adoc b/modules/oadp-configuring-aws-md5sum.adoc
@@ -7,6 +7,7 @@
 [id="oadp-configuring-aws-md5sum_{context}"]
 = Configuring the backup storage location with a MD5 checksum algorithm
 
+[role="_abstract"]
 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.
 
 * `CRC32`
diff --git a/modules/oadp-configuring-client-burst-qps.adoc b/modules/oadp-configuring-client-burst-qps.adoc
@@ -7,6 +7,7 @@
 [id="oadp-configuring-client-burst-qps_{context}"]
 = Configuring the DPA with client burst and QPS settings
 
+[role="_abstract"]
 The burst setting determines how many requests can be sent to the `velero` server before the limit is applied. After the burst limit is reached, the queries per second (QPS) setting determines how many additional requests can be sent per second.
 
 You can set the burst and QPS values of the `velero` server by configuring the Data Protection Application (DPA) with the burst and QPS values. You can use the `dpa.configuration.velero.client-burst` and `dpa.configuration.velero.client-qps` fields of the DPA to set the burst and QPS values.
diff --git a/modules/oadp-configuring-dpa-multiple-bsl.adoc b/modules/oadp-configuring-dpa-multiple-bsl.adoc
@@ -7,6 +7,7 @@
 [id="oadp-configuring-dpa-multiple-bsl_{context}"]
 = Configuring the DPA with more than one BSL
 
+[role="_abstract"]
 You can configure the `DataProtectionApplication` (DPA) custom resource (CR) with more than one `BackupStorageLocation` (BSL) CR and specify the credentials provided by the cloud provider.
 
 For example, where you have configured the following two BSLs:
diff --git a/modules/oadp-configuring-imagepullpolicy.adoc b/modules/oadp-configuring-imagepullpolicy.adoc
@@ -7,6 +7,7 @@
 [id="oadp-configuring-imagepullpolicy_{context}"]
 = Overriding the imagePullPolicy setting in the DPA 
 
+[role="_abstract"]
 In {oadp-short} 1.4.0 or earlier, the Operator sets the `imagePullPolicy` field of the Velero and node agent pods to `Always` for all images.
 
 In {oadp-short} 1.4.1 or later, the Operator first checks if each image has the `sha256` or `sha512` digest and sets the `imagePullPolicy` field accordingly:
diff --git a/modules/oadp-configuring-node-agents.adoc b/modules/oadp-configuring-node-agents.adoc
@@ -13,9 +13,9 @@
 [id="oadp-configuring-node-agents_{context}"]
 = Configuring node agents and node labels
 
+[role="_abstract"]
 The Data Protection Application (DPA) uses the `nodeSelector` field to select which nodes can run the node agent. The `nodeSelector` field is the recommended form of node selection constraint.
 
-
 .Procedure
 
 . Run the node agent on any node that you choose by adding a custom label:
diff --git a/modules/oadp-enabling-csi-dpa.adoc b/modules/oadp-enabling-csi-dpa.adoc
@@ -10,6 +10,7 @@
 [id="oadp-enabling-csi-dpa_{context}"]
 = Enabling CSI in the DataProtectionApplication CR
 
+[role="_abstract"]
 You enable the Container Storage Interface (CSI) in the `DataProtectionApplication` custom resource (CR) in order to back up persistent volumes with CSI snapshots.
 
 .Prerequisites
diff --git a/modules/oadp-installing-dpa-1-3.adoc b/modules/oadp-installing-dpa-1-3.adoc
@@ -12,6 +12,7 @@
 [id="oadp-installing-dpa_{context}"]
 = Installing the Data Protection Application
 
+[role="_abstract"]
 You install the Data Protection Application (DPA) by creating an instance of the `DataProtectionApplication` API.
 
 .Prerequisites
diff --git a/modules/oadp-secrets-for-different-credentials.adoc b/modules/oadp-secrets-for-different-credentials.adoc
@@ -8,71 +8,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="oadp-secrets-for-different-credentials_{context}"]
-ifdef::installing-oadp-aws[]
-= Creating profiles for different credentials
-
-If your backup and snapshot locations use different credentials, you create separate profiles in the `credentials-velero` file.
-
-Then, you create a `Secret` object and specify the profiles in the `DataProtectionApplication` custom resource (CR).
-
-.Procedure
-
-. Create a `credentials-velero` file with separate profiles for the backup and snapshot locations, as in the following example:
-+
-[source,terminal]
-----
-[backupStorage]
-aws_access_key_id=<AWS_ACCESS_KEY_ID>
-aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>
-
-[volumeSnapshot]
-aws_access_key_id=<AWS_ACCESS_KEY_ID>
-aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>
-----
-
-. Create a `Secret` object with the `credentials-velero` file:
-+
-[source,terminal,subs="attributes+"]
-----
-$ oc create secret generic {credentials} -n openshift-adp --from-file cloud=credentials-velero <1>
-----
-
-. Add the profiles to the `DataProtectionApplication` CR, as in the following example:
-+
-[source,yaml,subs="attributes+"]
-----
-apiVersion: oadp.openshift.io/v1alpha1
-kind: DataProtectionApplication
-metadata:
-  name: <dpa_sample>
-  namespace: openshift-adp
-spec:
-...
-  backupLocations:
-    - name: default
-      velero:
-        provider: {provider}
-        default: true
-        objectStorage:
-          bucket: <bucket_name>
-          prefix: <prefix>
-        config:
-          region: us-east-1
-          profile: "backupStorage"
-        credential:
-          key: cloud
-          name: {credentials}
-  snapshotLocations:
-    - velero:
-        provider: {provider}
-        config:
-          region: us-west-2
-          profile: "volumeSnapshot"
-----
-endif::[]
-ifdef::installing-oadp-ibm-cloud,installing-oadp-azure,installing-oadp-gcp,installing-oadp-ocs,installing-oadp-mcg[]
 = Creating secrets for different credentials
 
+[role="_abstract"]
 If your backup and snapshot locations use different credentials, you must create two `Secret` objects:
 
 * Backup location `Secret` with a custom name. The custom name is specified in the `spec.backupLocations` block of the `DataProtectionApplication` custom resource (CR).
@@ -97,7 +35,7 @@ $ oc create secret generic <custom_secret> -n openshift-adp --from-file cloud=cr
 ----
 
 . Add the `Secret` with the custom name to the `DataProtectionApplication` CR, as in the following example:
-endif::[]
+
 ifdef::installing-oadp-azure[]
 +
 [source,yaml,subs="attributes+"]
diff --git a/modules/oadp-self-signed-certificate.adoc b/modules/oadp-self-signed-certificate.adoc
diff --git a/modules/oadp-setting-resource-limits-and-requests.adoc b/modules/oadp-setting-resource-limits-and-requests.adoc
diff --git a/modules/oadp-ssec-encrypted-backups-velero.adoc b/modules/oadp-ssec-encrypted-backups-velero.adoc
diff --git a/modules/oadp-using-ca-certificates-with-velero-command.adoc b/modules/oadp-using-ca-certificates-with-velero-command.adoc
diff --git a/snippets/oadp-nodeselector-snippet.adoc b/snippets/oadp-nodeselector-snippet.adoc
