Merge pull request #49967 from mburke5678/OADP_714_Incorrect_information_around_includedResources_field

OADP_714_Incorrect_information_around_includedResources_field

Author: mburke5678

modules/oadp-creating-backup-cr.adoc

@@ -22,7 +22,8 @@ You back up Kubernetes images, internal images, and persistent volumes (PVs) by
 
 .Procedure
 
-. Retrieve the `backupStorageLocations` CRs:
+. Retrieve the `backupStorageLocations` CRs by entering the following command:
+
 +
 [source,terminal]
 ----
@@ -52,7 +53,9 @@ spec:
   hooks: {}
   includedNamespaces:
   - <namespace> <1>
-  storageLocation: <velero_sample_1> <2>
+  includedResources: [] <2>
+  excludedResources: [] <3>
+  storageLocation: <velero-sample-1> <4>
   ttl: 720h0m0s
   labelSelector: <3>
   - matchLabels:
@@ -70,9 +73,9 @@ spec:
       app=<label_3>
 ----
 <1> Specify an array of namespaces to back up.
-<2> Specify the name of the `backupStorageLocations` CR.
-<3> Optional. You can configure the backup to include only the resources with all the labels that you specify in this field. Note that the `labelSelector` and `orlabelSelectors` fields are mutually exclusive. You can use only one of them.
-<4> Optional. You can configure the backup to include the resources with any of the labels that you specify in this field. Note that the `orlabelSelectors` and `labelSelector` fields are mutually exclusive. You can use only one of them.
+<2> Optional: Specify an array of resources to include in the backup. Resources might be shortcuts (for example, 'po' for 'pods') or fully-qualified. If unspecified, all resources are included.
+<3> Optional: Specify an array of resources to exclude from the backup. Resources might be shortcuts (for example, 'po' for 'pods') or fully-qualified.
+<4> Specify the name of the `backupStorageLocations` CR.
 
 . Verify that the status of the `Backup` CR is `Completed`:
 +

modules/oadp-creating-backup-hooks.adoc

@@ -27,32 +27,34 @@ spec:
       - name: <hook_name>
         includedNamespaces:
         - <namespace> <1>
-        excludedNamespaces:
+        excludedNamespaces: <2>
         - <namespace>
-        includedResources:
-        - pods <2>
-        excludedResources: []
-        labelSelector: <3>
+        includedResources: []
+        - pods <3>
+        excludedResources: [] <4>
+        labelSelector: <5>
           matchLabels:
             app: velero
             component: server
-        pre: <4>
+        pre: <6>
           - exec:
-              container: <container> <5>
+              container: <container> <7>
               command:
-              - /bin/uname <6>
+              - /bin/uname <8>
               - -a
-              onError: Fail <7>
-              timeout: 30s <8>
-        post: <9>
+              onError: Fail <9>
+              timeout: 30s <10>
+        post: <11>
 ...
 ----
-<1> Array of namespaces to which the hook applies. If this value is not specified, the hook applies to all namespaces.
-<2> Currently, pods are the only supported resource.
-<3> Optional: This hook only applies to objects matching the label selector.
-<4> Array of hooks to run before the backup.
-<5> Optional: If the container is not specified, the command runs in the first container in the pod.
-<6> Array of commands that the hook runs.
-<7> Allowed values for error handling are `Fail` and `Continue`. The default is `Fail`.
-<8> Optional: How long to wait for the commands to run. The default is `30s`.
-<9> This block defines an array of hooks to run after the backup, with the same parameters as the pre-backup hooks.
+<1> Optional: You can specify namespaces to which the hook applies. If this value is not specified, the hook applies to all namespaces.
+<2> Optional: You can specify namespaces to which the hook does not apply.
+<3> Currently, pods are the only supported resource that hooks can apply to.
+<4> Optional: You can specify resources to which the hook does not apply.
+<5> Optional: This hook only applies to objects matching the label. If this value is not specified, the hook applies to all namespaces.
+<6> Array of hooks to run before the backup.
+<7> Optional: If the container is not specified, the command runs in the first container in the pod.
+<8> This is the entrypoint for the init container being added.
+<9> Allowed values for error handling are `Fail` and `Continue`. The default is `Fail`.
+<10> Optional: How long to wait for the commands to run. The default is `30s`.
+<11> This block defines an array of hooks to run after the backup, with the same parameters as the pre-backup hooks.

modules/oadp-creating-restore-cr.adoc

@@ -28,7 +28,7 @@ metadata:
   namespace: openshift-adp
 spec:
   backupName: <backup> <1>
-  existingResourcePolicy: <policy> <2>
+  includedResources: [] <2>
   excludedResources:
   - nodes
   - events
@@ -39,18 +39,16 @@ spec:
   restorePVs: true
 ----
 <1> Name of the `Backup` CR.
-<2> Optional. This field accepts two values:
-* `none`: The restore process does not affect existing resources.
-* `update`: The restore process replaces existing resources with their backup versions.
+<2> Optional. Specify an array of resources to include in the restore process. Resources might be shortcuts (for example, 'po' for 'pods') or fully-qualified. If unspecified, all resources are included.
 
-. Verify that the status of the `Restore` CR is `Completed`:
+. Verify that the status of the `Restore` CR is `Completed` by entering the following command:
 +
 [source,terminal]
 ----
 $ oc get restore -n openshift-adp <restore> -o jsonpath='{.status.phase}'
 ----
 
-. Verify that the backup resources have been restored:
+. Verify that the backup resources have been restored by entering the following command:
 +
 [source,terminal]
 ----

modules/oadp-creating-restore-hooks.adoc

@@ -53,23 +53,25 @@ spec:
               command:
               - /bin/ash
               - -c
+            timeout: <4>
         - exec:
-            container: <container> <4>
+            container: <container> <5>
             command:
-            - /bin/bash <5>
+            - /bin/bash <6>
             - -c
             - "psql < /backup/backup.sql"
-            waitTimeout: 5m <6>
-            execTimeout: 1m <7>
-            onError: Continue <8>
+            waitTimeout: 5m <7>
+            execTimeout: 1m <8>
+            onError: Continue <9>
 ----
 <1> Optional: Array of namespaces to which the hook applies. If this value is not specified, the hook applies to all namespaces.
-<2> Currently, pods are the only supported resource.
+<2> Currently, pods are the only supported resource that hooks can apply to.
 <3> Optional: This hook only applies to objects matching the label selector.
-<4> Optional: If the container is not specified, the command runs in the first container in the pod.
-<5> Array of commands that the hook runs.
-<6> Optional: If the `waitTimeout` is not specified, the restore waits indefinitely. You can specify how long to wait for a container to start and for preceding hooks in the container to complete. The wait timeout starts when the container is restored and might require time for the container to pull the image and mount the volumes.
-<7> Optional: How long to wait for the commands to run. The default is `30s`.
-<8> Allowed values for error handling are `Fail` and `Continue`:
+<4> Optional: Timeout specifies the maximum amount of time Velero waits for `initContainers` to complete.
+<5> Optional: If the container is not specified, the command runs in the first container in the pod.
+<6> This is the entrypoint for the init container being added.
+<7> Optional: How long to wait for a container to become ready. This should be long enough for the container to start and for any preceding hooks in the same container to complete. If not set, the restore process waits indefinitely.
+<8> Optional: How long to wait for the commands to run. The default is `30s`.
+<9> Allowed values for error handling are `Fail` and `Continue`:
 ** `Continue`: Only command failures are logged.
 ** `Fail`: No more restore hooks run in any container in any pod. The status of the `Restore` CR will be `PartiallyFailed`.