OADP 3183 Doc improvements - Installing and configuring OADP & Uninstalling OADP

CarmiWisemon · CarmiWisemon · commit 6dec6a282e6e · 2024-01-09T11:43:31.000+02:00
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
@@ -23,7 +23,7 @@ include::snippets/snip-noobaa-and-mcg.adoc[]
 :FeatureName: The `CloudStorage` API, which automates the creation of a bucket for object storage,
 include::snippets/technology-preview.adoc[]
 
-You can back up persistent volumes (PVs) by using snapshots or Restic.
+You can back up persistent volumes (PVs) by using snapshots or a File System Backup (FSB).
 
 To back up PVs with snapshots, you must have a cloud provider that supports either a native snapshot API or Container Storage Interface (CSI) snapshots, such as one of the following cloud providers:
 
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
@@ -12,7 +12,7 @@ You install the OpenShift API for Data Protection (OADP) with {rh-storage} by in
 
 include::snippets/oadp-mtc-operator.adoc[]
 
-You can configure xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#installing-oadp-mcg[Multicloud Object Gateway] or any S3-compatible object storage as a backup location.
+You can configure xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#installing-oadp-mcg[Multicloud Object Gateway] or any AWS S3-compatible object storage as a backup location.
 
 :FeatureName: The `CloudStorage` API, which automates the creation of a bucket for object storage,
 include::snippets/technology-preview.adoc[]
diff --git a/modules/about-installing-oadp-on-multiple-namespaces.adoc b/modules/about-installing-oadp-on-multiple-namespaces.adoc
@@ -7,7 +7,7 @@
 [id="about-installing-oadp-on-multiple-namespaces_{context}"]
 = Installation of OADP on multiple namespaces
 
-You can install OADP into multiple namespaces on the same cluster so that multiple project owners can manage their own OADP instance. This use case has been validated with Restic and CSI.
+You can install OpenShift API for Data Protection (OADP) into multiple namespaces on the same cluster so that multiple project owners can manage their own OADP instance. This use case has been validated with File System Backup (FSB) and Container Storage Interface (CSI).
 
 You install each instance of OADP as specified by the per-platform procedures contained in this document with the following additional requirements:
 
diff --git a/modules/migration-configuring-azure.adoc b/modules/migration-configuring-azure.adoc
@@ -12,7 +12,7 @@ ifdef::installing-3-4,installing-mtc[]
 You configure a Microsoft Azure Blob storage container as a replication repository for the {mtc-full} ({mtc-short}).
 endif::[]
 ifdef::installing-oadp-azure[]
-You configure a Microsoft Azure for the OpenShift API for Data Protection (OADP).
+You configure Microsoft Azure for the OpenShift API for Data Protection (OADP).
 endif::[]
 
 .Prerequisites
diff --git a/modules/oadp-about-backup-snapshot-locations-secrets.adoc b/modules/oadp-about-backup-snapshot-locations-secrets.adoc
@@ -16,7 +16,7 @@ You specify backup and snapshot locations and their secrets in the `DataProtecti
 [discrete]
 == Backup locations
 
-You specify S3-compatible object storage, such as Multicloud Object Gateway or MinIO, as a backup location.
+You specify AWS S3-compatible object storage, such as Multicloud Object Gateway or MinIO, as a backup location.
 
 Velero backs up {product-title} resources, Kubernetes objects, and internal images as an archive file on object storage.
 
@@ -28,7 +28,7 @@ If you use your cloud provider's native snapshot API to back up persistent volum
 
 If you use Container Storage Interface (CSI) snapshots, you do not need to specify a snapshot location because you will create a `VolumeSnapshotClass` CR to register the CSI driver.
 
-If you use Restic, you do not need to specify a snapshot location because Restic backs up the file system on object storage.
+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]
diff --git a/modules/oadp-installing-dpa-1-2-and-earlier.adoc b/modules/oadp-installing-dpa-1-2-and-earlier.adoc
@@ -198,7 +198,7 @@ spec:
 <2> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
 <3> Set this value to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that Restic pods run on each working node. In OADP version 1.2 and later, you can configure Restic for backups by adding `spec.defaultVolumesToFsBackup: true` to the `Backup` CR. In OADP version 1.1, add `spec.defaultVolumesToRestic: true` to the `Backup` CR.
 <4> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
-<5> Secret key that contain credentials. For Google workload identity federation cloud authentication use `service_account.json`.
+<5> Secret key that contains credentials. For Google workload identity federation cloud authentication use `service_account.json`.
 <6> Secret name that contains credentials. If you do not specify this value, the default name, `{credentials}`, is used.
 <7> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
 <8> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
@@ -347,7 +347,7 @@ endif::[]
 [id="verifying-oadp-installation-1-2_{context}"]
 == Verifying the installation
 
-. Verify the installation by viewing the OADP resources by running the following command:
+. Verify the installation by viewing the {oadp-first} resources by running the following command:
 +
 [source,terminal]
 ----
@@ -379,11 +379,11 @@ replicaset.apps/oadp-operator-controller-manager-67d9494d47    1         1
 replicaset.apps/velero-588db7f655                              1         1         1       96s
 ----
 
-.  Verify that the DPA is reconciled by running the following command:
+.  Verify that the `DataProtectionApplication` (DPA) is reconciled by running the following command:
 +
 [source,terminal]
 ----
-oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'
+$ oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'
 ----
 .Example output
 [source,yaml]
@@ -394,13 +394,16 @@ oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'
 
 . Verify the `type` is set to `Reconciled`.
 
-. Verify the `BackupStorageLocation` by running the following command:
+. Verify the backup storage location and confirm that the `PHASE` is `Available` by running the following command:
 +
 [source,terminal]
 ----
-oc get backupStorageLocation -n openshift-adp
+$ oc get backupStorageLocation -n openshift-adp
+----
+.Example output
+[source,yaml]
++
+----
 NAME           PHASE       LAST VALIDATED   AGE     DEFAULT
 dpa-sample-1   Available   1s               3d16h   true
 ----
-
-. Verify that the `PHASE` is in `Available`.
diff --git a/modules/oadp-installing-dpa-1-3.adoc b/modules/oadp-installing-dpa-1-3.adoc
@@ -92,7 +92,7 @@ spec:
 <8> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
 <9> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
 <10> Specify the name of the `Secret` object that you created. If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
-<11> Specify a snapshot location, unless you use CSI snapshots or Restic to back up PVs.
+<11> Specify a snapshot location, unless you use CSI snapshots or a File System Backup (FSB) to back up PVs.
 <12> The snapshot location must be in the same region as the PVs.
 endif::[]
 ifdef::installing-oadp-azure[]
@@ -362,7 +362,7 @@ endif::[]
 [id="verifying-oadp-installation-1-3_{context}"]
 == Verifying the installation
 
-. Verify the installation by viewing the OADP resources by running the following command:
+. . Verify the installation by viewing the {oadp-first} resources by running the following command:
 +
 [source,terminal]
 ----
@@ -395,11 +395,11 @@ replicaset.apps/oadp-operator-controller-manager-67d9494d47    1         1
 replicaset.apps/velero-588db7f655                              1         1         1       96s
 ----
 
-.  Verify that the DPA is reconciled by running the following command:
+.  Verify that the `DataProtectionApplication` (DPA) is reconciled by running the following command:
 +
 [source,terminal]
 ----
-oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'
+$ oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'
 ----
 .Example output
 [source,yaml]
@@ -410,13 +410,16 @@ oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'
 
 . Verify the `type` is set to `Reconciled`.
 
-. Verify the `BackupStorageLocation` by running the following command:
+. Verify the backup storage location and confirm that the `PHASE` is `Available` by running the following command:
 +
 [source,terminal]
 ----
-oc get backupStorageLocation -n openshift-adp
+$ oc get backupStorageLocation -n openshift-adp
+----
+.Example output
+[source,yaml]
++
+----
 NAME           PHASE       LAST VALIDATED   AGE     DEFAULT
 dpa-sample-1   Available   1s               3d16h   true
 ----
-
-. Verify that the `PHASE` is in `Available`.
diff --git a/modules/oadp-setting-resource-limits-and-requests.adoc b/modules/oadp-setting-resource-limits-and-requests.adoc
@@ -42,7 +42,7 @@ spec:
 
 [NOTE]
 ====
-Kopia is an option in OADP 1.3 and later releases. You can use Kopia for file system backups, and Kopia is your only option for data mover cases with the Built-in DataMover.
+Kopia is an option in OADP 1.3 and later releases. You can use Kopia for file system backups, and Kopia is your only option for Data Mover cases with the built-in Data Mover.
 
 Kopia is more resource intensive than Restic, and you might need to adjust the CPU and memory requirements accordingly.
 ====
diff --git a/modules/oadp-velero-cpu-memory-requirements.adoc b/modules/oadp-velero-cpu-memory-requirements.adoc
@@ -49,7 +49,7 @@ Memory - Request 16Gi, Limits 40Gi
 
 
 
-|^[5]^ DataMover
+|^[5]^ Data Mover
 |N/A
 |N/A
 |10m - average usage
@@ -63,11 +63,11 @@ Memory - Request 16Gi, Limits 40Gi
 
 2. Large usage - use these settings for large usage situations, such as a large PV (500GB Usage), multiple namespaces (100+), or many pods within a single namespace (2000 pods+), and for optimal performance for backup and restore involving large datasets.
 
-3. Restic resource usage corresponds to the amount of data, and type of data. For example, many small files or large amounts of data can cause Restic to utilize large amounts of resources. The https://velero.io/docs/v1.11/customize-installation/#customize-resource-requests-and-limits/[Velero] documentation references 500m as a supplied default, for most of our testing we found 200m request suitable with 1000m limit.  As cited in the Velero documentation, exact CPU and memory usage is dependent on the scale of files and directories, in addition to environmental limitations.
+3. Restic resource usage corresponds to the amount of data, and type of data. For example, many small files or large amounts of data can cause Restic to use large amounts of resources. The https://velero.io/docs/v1.11/customize-installation/#customize-resource-requests-and-limits/[Velero] documentation references 500m as a supplied default, for most of our testing we found a 200m request suitable with 1000m limit.  As cited in the Velero documentation, exact CPU and memory usage is dependent on the scale of files and directories, in addition to environmental limitations.
 
 4. Increasing the CPU has a significant impact on improving backup and restore times.
 
-5. DataMover - DataMover default resourceTimeout is 10m. Our tests show that for restoring a large PV (500GB usage), it is required to increase the resourceTimeout to 60m.
+5. Data Mover - Data Mover default resourceTimeout is 10m. Our tests show that for restoring a large PV (500GB usage), it is required to increase the resourceTimeout to 60m.
 --
 
 [NOTE]
