Merge pull request #78934 from shdeshpa07/OADP-1443-credentials-dpa

OADP-1443 - updated dpa for oadp 1.2 and 1.3 for volume snapshot credential

Author: jeana-redhat

modules/oadp-installing-dpa-1-2-and-earlier.adoc

@@ -61,35 +61,39 @@ spec:
   configuration:
     velero:
       defaultPlugins:
-        - openshift <1>
+        - openshift # <1>
         - aws
-      resourceTimeout: 10m <2>
+      resourceTimeout: 10m # <2>
     restic:
-      enable: true <3>
+      enable: true # <3>
       podConfig:
-        nodeSelector: <node_selector> <4>
+        nodeSelector: <node_selector> # <4>
   backupLocations:
     - name: default
       velero:
         provider: {provider}
         default: true
         objectStorage:
-          bucket: <bucket_name> <5>
-          prefix: <prefix> <6>
+          bucket: <bucket_name> # <5>
+          prefix: <prefix> # <6>
         config:
           region: <region>
           profile: "default"
-          s3ForcePathStyle: "true" <7>
-          s3Url: <s3_url> <8>
+          s3ForcePathStyle: "true" # <7>
+          s3Url: <s3_url> # <8>
         credential:
           key: cloud
-          name: {credentials} <9>
-  snapshotLocations: <10>
+          name: {credentials} # <9>
+  snapshotLocations: # <10>
     - velero:
         provider: {provider}
         config:
-          region: <region> <11>
+          region: <region> # <11>
           profile: "default"
+        credential:
+          key: cloud
+          name: {credentials} # <12>
+          
 ----
 <1> The `openshift` plugin is mandatory.
 <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.
@@ -102,6 +106,7 @@ spec:
 <9> 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.
 <10> Specify a snapshot location, unless you use CSI snapshots or Restic to back up PVs.
 <11> The snapshot location must be in the same region as the PVs.
+<12> 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 snapshot location. If your backup and snapshot locations use different credentials, create separate profiles in the `credentials-velero` file.
 endif::[]
 ifdef::installing-oadp-azure[]
 +
@@ -117,35 +122,38 @@ spec:
     velero:
       defaultPlugins:
         - azure
-        - openshift <1>
-      resourceTimeout: 10m <2>
+        - openshift # <1>
+      resourceTimeout: 10m # <2>
     restic:
-      enable: true <3>
+      enable: true # <3>
       podConfig:
-        nodeSelector: <node_selector> <4>
+        nodeSelector: <node_selector> # <4>
   backupLocations:
     - velero:
         config:
-          resourceGroup: <azure_resource_group> <5>
-          storageAccount: <azure_storage_account_id> <6>
-          subscriptionId: <azure_subscription_id> <7>
+          resourceGroup: <azure_resource_group> # <5>
+          storageAccount: <azure_storage_account_id> # <6>
+          subscriptionId: <azure_subscription_id> # <7>
           storageAccountKeyEnvVar: AZURE_STORAGE_ACCOUNT_ACCESS_KEY
         credential:
           key: cloud
-          name: {credentials}  <8>
+          name: {credentials}  # <8>
         provider: {provider}
         default: true
         objectStorage:
-          bucket: <bucket_name> <9>
-          prefix: <prefix> <10>
-  snapshotLocations: <11>
+          bucket: <bucket_name> # <9>
+          prefix: <prefix> # <10>
+  snapshotLocations: # <11>
     - velero:
         config:
           resourceGroup: <azure_resource_group>
           subscriptionId: <azure_subscription_id>
           incremental: "true"
         name: default
         provider: {provider}
+        credential:
+          key: cloud
+          name: {credentials} # <12>
 ----
 <1> The `openshift` plugin is mandatory.
 <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.
@@ -158,6 +166,7 @@ spec:
 <9> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
 <10> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
 <11> You do not need to specify a snapshot location if you use CSI snapshots or Restic to back up PVs.
+<12> 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.
 endif::[]
 ifdef::installing-oadp-gcp[]
 +
@@ -173,29 +182,32 @@ spec:
     velero:
       defaultPlugins:
         - gcp
-        - openshift <1>
-      resourceTimeout: 10m <2>
+        - openshift # <1>
+      resourceTimeout: 10m # <2>
     restic:
-      enable: true <3>
+      enable: true # <3>
       podConfig:
-        nodeSelector: <node_selector> <4>
+        nodeSelector: <node_selector> # <4>
   backupLocations:
     - velero:
         provider: {provider}
         default: true
         credential:
-          key: cloud <5>
-          name: {credentials} <6>
+          key: cloud # <5>
+          name: {credentials} # <6>
         objectStorage:
-          bucket: <bucket_name> <7>
-          prefix: <prefix> <8>
-  snapshotLocations: <9>
+          bucket: <bucket_name> # <7>
+          prefix: <prefix> # <8>
+  snapshotLocations: # <9>
     - velero:
         provider: {provider}
         default: true
         config:
           project: <project>
-          snapshotLocation: us-west1 <10>
+          snapshotLocation: us-west1 # <10>
+        credential:
+          key: cloud
+          name: {credentials} # <11>
 ----
 <1> The `openshift` plugin is mandatory.
 <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.
@@ -207,6 +219,7 @@ spec:
 <8> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
 <9> Specify a snapshot location, unless you use CSI snapshots or Restic to back up PVs.
 <10> The snapshot location must be in the same region as the PVs.
+<11> 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 snapshot location.
 endif::[]
 ifdef::installing-oadp-mcg[]
 +
@@ -222,28 +235,28 @@ spec:
     velero:
       defaultPlugins:
         - aws
-        - openshift <1>
-      resourceTimeout: 10m <2>
+        - openshift # <1>
+      resourceTimeout: 10m # <2>
     restic:
-      enable: true <3>
+      enable: true # <3>
       podConfig:
-        nodeSelector: <node_selector> <4>
+        nodeSelector: <node_selector> # <4>
   backupLocations:
     - velero:
         config:
           profile: "default"
           region: minio
-          s3Url: <url> <5>
+          s3Url: <url> # <5>
           insecureSkipTLSVerify: "true"
           s3ForcePathStyle: "true"
         provider: {provider}
         default: true
         credential:
           key: cloud
-          name: {credentials} <6>
+          name: {credentials} # <6>
         objectStorage:
-          bucket: <bucket_name> <7>
-          prefix: <prefix> <8>
+          bucket: <bucket_name> # <7>
+          prefix: <prefix> # <8>
 ----
 <1> The `openshift` plugin is mandatory.
 <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.
@@ -267,25 +280,25 @@ spec:
   configuration:
     velero:
       defaultPlugins:
-        - kubevirt <1>
-        - gcp <2>
-        - csi <3>
-        - openshift <4>
-      resourceTimeout: 10m <5>
+        - kubevirt # <1>
+        - gcp # <2>
+        - csi # <3>
+        - openshift # <4>
+      resourceTimeout: 10m # <5>
     restic:
-      enable: true <6>
+      enable: true # <6>
       podConfig:
-        nodeSelector: <node_selector> <7>
+        nodeSelector: <node_selector> # <7>
   backupLocations:
     - velero:
-        provider: {provider} <8>
+        provider: {provider} # <8>
         default: true
         credential:
           key: cloud
-          name: <default_secret> <9>
+          name: <default_secret> # <9>
         objectStorage:
-          bucket: <bucket_name> <10>
-          prefix: <prefix> <11>
+          bucket: <bucket_name> # <10>
+          prefix: <prefix> # <11>
 ----
 <1> Optional: The `kubevirt` plugin is used with {VirtProductName}.
 <2> Specify the default plugin for the backup provider, for example, `gcp`, if appropriate.