Merge pull request #103604 from openshift-cherrypick-robot/cherry-pick-103262-to-enterprise-4.19

[enterprise-4.19] Convert callouts and remove block titles

Author: shdeshpa07

modules/oadp-usecase-backup-odf.adoc

@@ -25,36 +25,41 @@ In this use case, you back up an application by using {oadp-short} and store the
 
 . Create an OBC manifest file to request a NooBaa MCG bucket as shown in the following example:
 +
-.Example OBC
 [source,yaml]
 ----
 apiVersion: objectbucket.io/v1alpha1
 kind: ObjectBucketClaim
 metadata:
-  name: test-obc # <1>
+  name: test-obc
   namespace: openshift-adp
 spec:
   storageClassName: openshift-storage.noobaa.io
-  generateBucketName: test-backup-bucket # <2>
+  generateBucketName: test-backup-bucket
 ----
-<1> The name of the object bucket claim.
-<2> The name of the bucket.
++
+where:
++
+`test-obc`:: Specifies the name of the object bucket claim.
+`test-backup-bucket`:: Specifies the name of the bucket.
 
 . Create the OBC by running the following command:
 +
 [source,terminal]
 ----
-$ oc create -f <obc_file_name> # <1>
+$ oc create -f <obc_file_name>
 ----
-<1> Specify the file name of the object bucket claim manifest.
++
+where:
++
+`<obc_file_name>`:: Specifies the file name of the object bucket claim manifest.
 
 . When you create an OBC, {odf-short} creates a `secret` and a `config map` with the same name as the object bucket claim. The `secret` has the bucket credentials, and the `config map` has information to access the bucket. To get the bucket name and bucket host from the generated config map, run the following command:
 +
 [source,terminal]
 ----
-$ oc extract --to=- cm/test-obc # <1>
+$ oc extract --to=- cm/test-obc
 ----
-<1> `test-obc` is the name of the OBC.
+`test-obc` is the name of the OBC.
 +
 .Example output
 [source,terminal]
@@ -115,7 +120,6 @@ $ oc create secret generic \
 
 . Configure the Data Protection Application (DPA) as shown in the following example:
 +
-.Example DPA
 [source,yaml]
 ----
 apiVersion: oadp.openshift.io/v1alpha1
@@ -133,13 +137,13 @@ spec:
         - aws
         - openshift
         - csi
-      defaultSnapshotMoveData: true # <1>
+      defaultSnapshotMoveData: true
   backupLocations:
     - velero:
         config:
           profile: "default"
           region: noobaa
-          s3Url: https://s3.openshift-storage.svc # <2>
+          s3Url: https://s3.openshift-storage.svc
           s3ForcePathStyle: "true"
           insecureSkipTLSVerify: "true"
         provider: aws
@@ -148,12 +152,15 @@ spec:
           key: cloud
           name:  cloud-credentials
         objectStorage:
-          bucket: <bucket_name> # <3>
+          bucket: <bucket_name>
           prefix: oadp
 ----
-<1> Set to true to use the {oadp-short} Data Mover to enable movement of Container Storage Interface (CSI) snapshots to a remote object storage.
-<2> This is the S3 URL of {odf-short} storage.
-<3> Specify the bucket name.
++
+where:
++
+`defaultSnapshotMoveData`:: Set to `true` to use the {oadp-short} Data Mover to enable movement of Container Storage Interface (CSI) snapshots to a remote object storage.
+`s3Url`:: Specifies the S3 URL of {odf-short} storage.
+`<bucket_name>`:: Specifies the bucket name.
 
 . Create the DPA by running the following command:
 +
@@ -170,7 +177,6 @@ $ oc get dpa -o yaml
 ----
 +
 .Example output
-+
 [source,yaml]
 ----
 apiVersion: v1
@@ -213,7 +219,6 @@ dpa-sample-1   Available   3s               15s   true
 
 . Configure a backup CR as shown in the following example:
 +
-.Example backup CR
 [source,yaml]
 ----
 apiVersion: velero.io/v1
@@ -223,9 +228,12 @@ metadata:
   namespace: openshift-adp
 spec:
   includedNamespaces:
-  - <application_namespace> # <1>
+  - <application_namespace>
 ----
-<1> Specify the namespace for the application to back up.
++
+where:
++
+`<application_namespace>`:: Specifies the namespace for the application to back up.
 
 . Create the backup CR by running the following command:
 +

modules/oadp-usecase-include-ca-cert-backup.adoc

@@ -26,20 +26,22 @@ To prevent a `certificate signed by unknown authority` error, you must include a
 
 . Create an OBC manifest to request a NooBaa bucket as shown in the following example:
 +
-.Example `ObjectBucketClaim` CR
 [source,yaml]
 ----
 apiVersion: objectbucket.io/v1alpha1
 kind: ObjectBucketClaim
 metadata:
-  name: test-obc # <1>
+  name: test-obc
   namespace: openshift-adp
 spec:
   storageClassName: openshift-storage.noobaa.io
-  generateBucketName: test-backup-bucket # <2>
+  generateBucketName: test-backup-bucket
 ----
-<1> Specifies the name of the object bucket claim.
-<2> Specifies the name of the bucket.
++
+where:
++
+`test-obc`:: Specifies the name of the object bucket claim.
+`test-backup-bucket`:: Specifies the name of the bucket.
 
 . Create the OBC by running the following command:
 +
@@ -52,9 +54,9 @@ $ oc create -f <obc_file_name>
 +
 [source,terminal]
 ----
-$ oc extract --to=- cm/test-obc # <1>
+$ oc extract --to=- cm/test-obc
 ----
-<1> The name of the OBC is `test-obc`.
+`test-obc` is the name of the OBC.
 +
 .Example output
 [source,terminal]
@@ -115,7 +117,6 @@ $ oc get cm/openshift-service-ca.crt \
 ----
 +
 .Example output
-+
 [source,terminal]
 ----
 LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0...
@@ -124,7 +125,6 @@ LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0...
 
 . Configure the `DataProtectionApplication` CR manifest file with the bucket name and CA certificate as shown in the following example:
 +
-.Example `DataProtectionApplication` CR
 [source,yaml]
 ----
 apiVersion: oadp.openshift.io/v1alpha1
@@ -150,20 +150,23 @@ spec:
           region: noobaa
           s3Url: https://s3.openshift-storage.svc
           s3ForcePathStyle: "true"
-          insecureSkipTLSVerify: "false" # <1>
+          insecureSkipTLSVerify: "false"
         provider: aws
         default: true
         credential:
           key: cloud
           name:  cloud-credentials
         objectStorage:
-          bucket: <bucket_name> # <2>
+          bucket: <bucket_name>
           prefix: oadp
-          caCert: <ca_cert> # <3>
+          caCert: <ca_cert>
 ----
-<1> The `insecureSkipTLSVerify` flag can be set to either `true` or `false`. If set to "true", SSL/TLS security is disabled. If set to `false`, SSL/TLS security is enabled.
-<2> Specify the name of the bucket extracted in an earlier step.
-<3> Copy and paste the `Base64` encoded certificate from the previous step.
++
+where:
++
+`insecureSkipTLSVerify`:: Specifies whether SSL/TLS security is enabled. If set to `true`, SSL/TLS security is disabled. If set to `false`, SSL/TLS security is enabled.
+`<bucket_name>`:: Specifies the name of the bucket extracted in an earlier step.
+`<ca_cert>`:: Specifies the `Base64` encoded certificate from the previous step.
 
 . Create the `DataProtectionApplication` CR by running the following command:
 +
@@ -180,7 +183,6 @@ $ oc get dpa -o yaml
 ----
 +
 .Example output
-+
 [source,yaml]
 ----
 apiVersion: v1
@@ -223,7 +225,6 @@ dpa-sample-1   Available   3s               15s   true
 
 . Configure the `Backup` CR by using the following example:
 +
-.Example `Backup` CR
 [source,yaml]
 ----
 apiVersion: velero.io/v1
@@ -233,9 +234,12 @@ metadata:
   namespace: openshift-adp
 spec:
   includedNamespaces:
-  - <application_namespace> # <1>
+  - <application_namespace>
 ----
-<1> Specify the namespace for the application to back up.
++
+where:
++
+`<application_namespace>`:: Specifies the namespace for the application to back up.
 
 . Create the `Backup` CR by running the following command:
 +

modules/oadp-usecase-restore.adoc

@@ -18,23 +18,25 @@ Restore a backup of an application by using {oadp-short} to a new target namespa
 
 . Create a restore CR as shown in the following example:
 +
-.Example restore CR
 [source,yaml]
 ----
 apiVersion: velero.io/v1
 kind: Restore
 metadata:
-  name: test-restore # <1>
+  name: test-restore
   namespace: openshift-adp
 spec:
-  backupName: <backup_name> # <2>
+  backupName: <backup_name>
   restorePVs: true
   namespaceMapping:
-    <application_namespace>: test-restore-application # <3>
+    <application_namespace>: test-restore-application
 ----
-<1> The name of the restore CR.
-<2> Specify the name of the backup.
-<3> `namespaceMapping` maps the source application namespace to the target application namespace. Specify the application namespace that you backed up. `test-restore-application` is the target namespace where you want to restore the backup.
++
+where:
++
+`test-restore`:: Specifies the name of the restore CR.
+`<backup_name>`:: Specifies the name of the backup.
+`<application_namespace>`:: Specifies the target namespace to restore to. `namespaceMapping` maps the source application namespace to the target application namespace. `test-restore-application` is the name of target namespace where you want to restore the backup.
 
 . Apply the restore CR by running the following command:
 +
@@ -67,7 +69,6 @@ $ oc get pvc,svc,deployment,secret,configmap
 ----
 +
 .Example output
-+
 [source,terminal]
 ----
 NAME                          STATUS   VOLUME                                     

modules/oadp-using-legacy-aws-plugin.adoc

@@ -25,7 +25,6 @@ Depending on the backup storage location you choose, you can use either the `leg
 
 . Configure the `DataProtectionApplication` CR to use the `legacy-aws` Velero plugin as shown in the following example:
 +
-.Example `DataProtectionApplication` CR
 [source,yaml]
 ----
 apiVersion: oadp.openshift.io/v1alpha1
@@ -40,16 +39,16 @@ spec:
       uploaderType: kopia
     velero:
       defaultPlugins:
-        - legacy-aws # <1>
+        - legacy-aws
         - openshift
         - csi
-      defaultSnapshotMoveData: true 
+      defaultSnapshotMoveData: true
   backupLocations:
     - velero:
         config:
           profile: "default"
           region: noobaa
-          s3Url: https://s3.openshift-storage.svc 
+          s3Url: https://s3.openshift-storage.svc
           s3ForcePathStyle: "true"
           insecureSkipTLSVerify: "true"
         provider: aws
@@ -58,11 +57,14 @@ spec:
           key: cloud
           name:  cloud-credentials
         objectStorage:
-          bucket: <bucket_name> # <2>
+          bucket: <bucket_name>
           prefix: oadp
 ----
-<1> Use the `legacy-aws` plugin.
-<2> Specify the bucket name.
++
+where:
++
+`legacy-aws`:: Specifies to use the `legacy-aws` plugin.
+`<bucket_name>`:: Specifies the bucket name.
 
 . Create the `DataProtectionApplication` CR by running the following command:
 +
@@ -79,7 +81,6 @@ $ oc get dpa -o yaml
 ----
 +
 .Example output
-+
 [source,yaml]
 ----
 apiVersion: v1
@@ -110,10 +111,11 @@ metadata:
 +
 [source,terminal]
 ----
-$ oc get backupstoragelocations.velero.io -n openshift-adp 
+$ oc get backupstoragelocations.velero.io -n openshift-adp
 ----
 +
-.Example output
+You should see an output similar to the following example:
++
 [source,terminal]
 ----
 NAME           PHASE       LAST VALIDATED   AGE   DEFAULT
@@ -122,7 +124,6 @@ dpa-sample-1   Available   3s               15s   true
 
 . Configure a `Backup` CR as shown in the following example:
 +
-.Example backup CR
 [source,yaml]
 ----
 apiVersion: velero.io/v1
@@ -132,9 +133,12 @@ metadata:
   namespace: openshift-adp
 spec:
   includedNamespaces:
-  - <application_namespace> # <1>
+  - <application_namespace>
 ----
-<1> Specify the namespace for the application to back up.
++
+where:
++
+`<application_namespace>`:: Specifies the namespace for the application to back up.
 
 . Create the `Backup` CR by running the following command:
 +
@@ -149,7 +153,7 @@ $ oc apply -f <backup_cr_filename>
 +
 [source,terminal]
 ----
-$ oc describe backups.velero.io test-backup -n openshift-adp 
+$ oc describe backups.velero.io test-backup -n openshift-adp
 ----
 +
 .Example output