Chapter 7. Installing the Data Protection Application

Procedure

1. Click Operators Installed Operators and select the OADP Operator.
2. Under Provided APIs, click Create instance in the DataProtectionApplication box.

3. Click YAML View and update the parameters of the DataProtectionApplication manifest:

   apiVersion: oadp.openshift.io/v1alpha1
   kind: DataProtectionApplication
   metadata:
     name: <dpa_sample>
     namespace: <OPERATOR_INSTALL_NS>
   spec:
     configuration:
       velero:
         defaultPlugins:
           - gcp
           - openshift
         resourceTimeout: 10m
       nodeAgent:
         enable: true
         uploaderType: kopia
         podConfig:
           nodeSelector: <node_selector>
     backupLocations:
       - velero:
           provider: gcp
           default: true
           credential:
             key: cloud
             name: cloud-credentials-gcp
           objectStorage:
             bucket: <bucket_name>
             prefix: <prefix>
     snapshotLocations:
       - velero:
           provider: gcp
           default: true
           config:
             project: <project>
             snapshotLocation: us-west1
           credential:
             key: cloud
             name: cloud-credentials-gcp
     backupImages: true

   Copy to Clipboard Toggle word wrap

   where:

   namespace

   Specifies the default namespace for OADP which is openshift-adp. The namespace is a variable and is configurable.

   openshift

   Specifies that the openshift plugin is mandatory.

   resourceTimeout

   Specifies how many minutes to wait for several Velero resources such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability, before timeout occurs. The default is 10m.

   nodeAgent

   Specifies the administrative agent that routes the administrative requests to servers.

   enable

   Set this value to true if you want to enable nodeAgent and perform File System Backup.

   uploaderType

   Specifies the uploader type. Enter kopia or restic as your uploader. You cannot change the selection after the installation. For the Built-in DataMover you must use Kopia. The nodeAgent deploys a daemon set, which means that the nodeAgent pods run on each working node. You can configure File System Backup by adding spec.defaultVolumesToFsBackup: true to the Backup CR.

   nodeSelector

   Specifies the nodes on which Kopia or Restic are available. By default, Kopia or Restic run on all nodes.

   key

   Specifies the secret key that contains credentials. For Google workload identity federation cloud authentication use service_account.json.

   name

   Specifies the secret name that contains credentials. If you do not specify this value, the default name, cloud-credentials-gcp, is used.

   bucket

   Specifies a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.

   prefix

   Specifies a prefix for Velero backups, for example, velero, if the bucket is used for multiple purposes.

   snapshotLocations

   Specifies a snapshot location, unless you use CSI snapshots or Restic to back up PVs.

   snapshotLocation

   Specifies that the snapshot location must be in the same region as the PVs.

   name

   Specifies the name of the Secret object that you created. If you do not specify this value, the default name, cloud-credentials-gcp, is used. If you specify a custom name, the custom name is used for the backup location.

   backupImages

   Specifies that Google workload identity federation supports internal image backup. Set this field to false if you do not want to use image backup.

4. Click Create.

Verification

1. Verify the installation by viewing the OpenShift API for Data Protection (OADP) resources by running the following command:

   $ oc get all -n openshift-adp

   Copy to Clipboard Toggle word wrap

   NAME                                                     READY   STATUS    RESTARTS   AGE
   pod/oadp-operator-controller-manager-67d9494d47-6l8z8    2/2     Running   0          2m8s
   pod/node-agent-9cq4q                                     1/1     Running   0          94s
   pod/node-agent-m4lts                                     1/1     Running   0          94s
   pod/node-agent-pv4kr                                     1/1     Running   0          95s
   pod/velero-588db7f655-n842v                              1/1     Running   0          95s
   
   NAME                                                       TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
   service/oadp-operator-controller-manager-metrics-service   ClusterIP   172.30.70.140    <none>        8443/TCP   2m8s
   service/openshift-adp-velero-metrics-svc                   ClusterIP   172.30.10.0      <none>        8085/TCP   8h
   
   NAME                        DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
   daemonset.apps/node-agent    3         3         3       3            3           <none>          96s
   
   NAME                                                READY   UP-TO-DATE   AVAILABLE   AGE
   deployment.apps/oadp-operator-controller-manager    1/1     1            1           2m9s
   deployment.apps/velero                              1/1     1            1           96s
   
   NAME                                                           DESIRED   CURRENT   READY   AGE
   replicaset.apps/oadp-operator-controller-manager-67d9494d47    1         1         1       2m9s
   replicaset.apps/velero-588db7f655                              1         1         1       96s

   Copy to Clipboard Toggle word wrap

2. Verify that the DataProtectionApplication (DPA) is reconciled by running the following command:

   $ oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'

   Copy to Clipboard Toggle word wrap

   {"conditions":[{"lastTransitionTime":"2023-10-27T01:23:57Z","message":"Reconcile complete","reason":"Complete","status":"True","type":"Reconciled"}]}

   Copy to Clipboard Toggle word wrap
3. Verify the type is set to Reconciled.

4. Verify the backup storage location and confirm that the PHASE is Available by running the following command:

   $ oc get backupstoragelocations.velero.io -n openshift-adp

   Copy to Clipboard Toggle word wrap

   NAME           PHASE       LAST VALIDATED   AGE     DEFAULT
   dpa-sample-1   Available   1s               3d16h   true

   Copy to Clipboard Toggle word wrap