Merge pull request #91817 from amolnar-rh/TELCODOCS-2209

TELCODOCS-2209#Update the OadpBackupStorageLocationStatus.yaml source CR

Author: mburke5678

modules/ztp-image-based-upgrade-installing-oadp.adoc

@@ -138,7 +138,7 @@ spec:
 .. Extract the following CRs from the `ztp-site-generate` container image and push them to the `source-cr` directory:
 +
 --
-.Example `DataProtectionApplication.yaml` file
+.Example `OadpDataProtectionApplication.yaml` file
 [source,yaml]
 ----
 apiVersion: oadp.openshift.io/v1alpha1
@@ -180,7 +180,7 @@ status:
     type: Reconciled
 ----
 <1> The `spec.configuration.restic.enable` field must be set to `false` for an image-based upgrade because persistent volume contents are retained and reused after the upgrade.
-<2> The bucket defines the bucket name that is created in S3 backend. The prefix defines the name of the subdirectory that will be automatically created in the bucket. The combination of bucket and prefix must be unique for each target cluster to avoid interference between them. To ensure a unique storage directory for each target cluster, you can use the {rh-rhacm} hub template function, for example, `prefix: {{hub .ManagedClusterName hub}}`.
+<2> The bucket defines the bucket name that is created in S3 backend. The prefix defines the name of the subdirectory that will be automatically created in the bucket. The combination of bucket and prefix must be unique for each target cluster to avoid interference between them. To ensure a unique storage directory for each target cluster, you can use the {rh-rhacm-title} hub template function, for example, `prefix: {{hub .ManagedClusterName hub}}`.
 
 .Example `OadpSecret.yaml` file
 [source,yaml]
@@ -201,12 +201,14 @@ type: Opaque
 apiVersion: velero.io/v1
 kind: BackupStorageLocation
 metadata:
+  name: dataprotectionapplication-1 <1>
   namespace: openshift-adp
   annotations:
     ran.openshift.io/ztp-deploy-wave: "100"
 status:
   phase: Available
 ----
+<1> The `name` value in the `BackupStorageLocation` resource must follow the `<DataProtectionApplication.metadata.name>-<index>` pattern. The `<index>` represents the position of the corresponding `backupLocations` entry in the `spec.backupLocations` field in the `DataProtectionApplication` resource. The position starts from `1`. If the `metadata.name` value of the `DataProtectionApplication` resource is changed in the `OadpDataProtectionApplication.yaml` file, update the `metadata.name` field in the `BackupStorageLocation` resource accordingly.
 
 The `OadpBackupStorageLocationStatus.yaml` CR verifies the availability of backup storage locations created by OADP.
 --
@@ -231,14 +233,14 @@ spec:
       policyName: "config-policy"
       data:
         cloud: <your_credentials> <1>
-    - fileName: DataProtectionApplication.yaml
+    - fileName: OadpDataProtectionApplication.yaml <2>
       policyName: "config-policy"
       spec:
         backupLocations:
           - velero:
               config:
                 region: minio
-                s3Url: <your_S3_URL> <2>
+                s3Url: <your_S3_URL> <3>
                 profile: "default"
                 insecureSkipTLSVerify: "true"
                 s3ForcePathStyle: "true"
@@ -248,11 +250,12 @@ spec:
                 key: cloud
                 name: cloud-credentials
               objectStorage:
-                bucket: <your_bucket_name> <3>
-                prefix: <cluster_name> <3>
+                bucket: <your_bucket_name> <4>
+                prefix: <cluster_name> <4>
     - fileName: OadpBackupStorageLocationStatus.yaml
       policyName: "config-policy"
 ----
 <1> Specify your credentials for your S3 storage backend.
-<2> Specify the URL for your S3-compatible bucket.
-<3> The `bucket` defines the bucket name that is created in S3 backend. The `prefix` defines the name of the subdirectory that will be automatically created in the `bucket`. The combination of `bucket` and `prefix` must be unique for each target cluster to avoid interference between them. To ensure a unique storage directory for each target cluster, you can use the {rh-rhacm} hub template function, for example, `prefix: {{hub .ManagedClusterName hub}}`.
+<2> If more than one `backupLocations` entries are defined in the `OadpDataProtectionApplication` CR, ensure that each location has a corresponding `OadpBackupStorageLocation` CR added for status tracking. Ensure that the name of each additional `OadpBackupStorageLocation` CR is overridden with the correct index as described in the example `OadpBackupStorageLocationStatus.yaml` file.
+<3> Specify the URL for your S3-compatible bucket.
+<4> The `bucket` defines the bucket name that is created in S3 backend. The `prefix` defines the name of the subdirectory that will be automatically created in the `bucket`. The combination of `bucket` and `prefix` must be unique for each target cluster to avoid interference between them. To ensure a unique storage directory for each target cluster, you can use the {rh-rhacm-title} hub template function, for example, `prefix: {{hub .ManagedClusterName hub}}`.