Installing and configuring the OpenShift API for Data Protection with Google Cloud Platform

You install the Openshift API for Data Protection (OADP) with Google Cloud Platform (GCP) by installing the OADP Operator. The Operator installs Velero 1.7.

You configure GCP for Velero, create a default Secret, and then install the Data Protection Application.

To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See Using Operator Lifecycle Manager on restricted networks for details.

Installing the OADP Operator

You install the OpenShift API for Data Protection (OADP) Operator on OKD 4.10 by using Operator Lifecycle Manager (OLM).

The OADP Operator installs Velero 1.7.

Prerequisites

  • You must be logged in as a user with cluster-admin privileges.

Procedure

  1. In the OKD web console, click Operators → OperatorHub.

  2. Use the Filter by keyword field to find the OADP Operator.

  3. Select the OADP Operator and click Install.

  4. Click Install to install the Operator in the openshift-adp project.

  5. Click Operators → Installed Operators to verify the installation.

Configuring Google Cloud Platform

You configure Google Cloud Platform (GCP) for the OpenShift API for Data Protection (OADP).

Prerequisites

Procedure

  1. Log in to GCP:

    1. $ gcloud auth login

  2. Set the BUCKET variable:

    1. $ BUCKET=<bucket> (1)
    1Specify your bucket name.

  3. Create the storage bucket:

    1. $ gsutil mb gs://$BUCKET/

  4. Set the PROJECT_ID variable to your active project:

    1. $ PROJECT_ID=$(gcloud config get-value project)

  5. Create a service account:

    1. $ gcloud iam service-accounts create velero \
    2.     --display-name "Velero service account"

  6. List your service accounts:

    1. $ gcloud iam service-accounts list

  7. Set the SERVICE_ACCOUNT_EMAIL variable to match its email value:

    1. $ SERVICE_ACCOUNT_EMAIL=$(gcloud iam service-accounts list \
    2.     --filter="displayName:Velero service account" \
    3.     --format 'value(email)')

  8. Attach the policies to give the velero user the necessary permissions:

    1. $ ROLE_PERMISSIONS=(
    2.     compute.disks.get
    3.     compute.disks.create
    4.     compute.disks.createSnapshot
    5.     compute.snapshots.get
    6.     compute.snapshots.create
    7.     compute.snapshots.useReadOnly
    8.     compute.snapshots.delete
    9.     compute.zones.get
    10. )

  9. Create the velero.server custom role:

    1. $ gcloud iam roles create velero.server \
    2.     --project $PROJECT_ID \
    3.     --title "Velero Server" \
    4.     --permissions "$(IFS=","; echo "${ROLE_PERMISSIONS[*]}")"

  10. Add IAM policy binding to the project:

    1. $ gcloud projects add-iam-policy-binding $PROJECT_ID \
    2.    --member serviceAccount:$SERVICE_ACCOUNT_EMAIL \
    3.    --role projects/$PROJECT_ID/roles/velero.server

  11. Update the IAM service account:

    1. $ gsutil iam ch serviceAccount:$SERVICE_ACCOUNT_EMAIL:objectAdmin gs://${BUCKET}

  12. Save the IAM service account keys to the credentials-velero file in the current directory:

    1. $ gcloud iam service-accounts keys create credentials-velero \
    2.    --iam-account $SERVICE_ACCOUNT_EMAIL

    You use the credentials-velero file to create a Secret object for GCP before you install the Data Protection Application.

About backup and snapshot locations and their secrets

You specify backup and snapshot locations and their secrets in the DataProtectionApplication custom resource (CR).

Backup locations

You specify S3-compatible object storage, such as Multicloud Object Gateway, Noobaa, or Minio, as a backup location.

Velero backs up OKD resources, Kubernetes objects, and internal images as an archive file on object storage.

Snapshot locations

If you use your cloud provider’s native snapshot API to back up persistent volumes, you must specify the cloud provider as the snapshot location.

If you use Container Storage Interface (CSI) snapshots, you do not need to specify a snapshot location because you will create a VolumeSnapshotClass CR to register the CSI driver.

If you use Restic, you do not need to specify a snapshot location because Restic backs up the file system on object storage.

Secrets

If the backup and snapshot locations use the same credentials or if you do not require a snapshot location, you create a default Secret.

If the backup and snapshot locations use different credentials, you create two secret objects:

  • Custom Secret for the backup location, which you specify in the DataProtectionApplication CR.

  • Default Secret for the snapshot location, which is not referenced in the DataProtectionApplication CR.

The Data Protection Application requires a default Secret. Otherwise, the installation will fail.

If you do not want to specify backup or snapshot locations during the installation, you can create a default Secret with an empty credentials-velero file.

Creating a default Secret

You create a default Secret if your backup and snapshot locations use the same credentials or if you do not require a snapshot location.

The default name of the Secret is cloud-credentials-gcp.

The DataProtectionApplication custom resource (CR) requires a default Secret. Otherwise, the installation will fail. If the name of the backup location Secret is not specified, the default name is used.

If you do not want to use the backup location credentials during the installation, you can create a Secret with the default name by using an empty credentials-velero file.

Prerequisites

  • Your object storage and cloud storage, if any, must use the same credentials.

  • You must configure object storage for Velero.

  • You must create a credentials-velero file for the object storage in the appropriate format.

Procedure

  • Create a Secret with the default name:

    1. $ oc create secret generic cloud-credentials-gcp -n openshift-adp --from-file cloud=credentials-velero

The Secret is referenced in the spec.backupLocations.credential block of the DataProtectionApplication CR when you install the Data Protection Application.

Creating secrets for different credentials

If your backup and snapshot locations use different credentials, you must create two Secret objects:

  • Backup location Secret with a custom name. The custom name is specified in the spec.backupLocations block of the DataProtectionApplication custom resource (CR).

  • Snapshot location Secret with the default name, cloud-credentials-gcp. This Secret is not specified in the DataProtectionApplication CR.

Procedure

  1. Create a credentials-velero file for the snapshot location in the appropriate format for your cloud provider.

  2. Create a Secret for the snapshot location with the default name:

    1. $ oc create secret generic cloud-credentials-gcp -n openshift-adp --from-file cloud=credentials-velero

  3. Create a credentials-velero file for the backup location in the appropriate format for your object storage.

  4. Create a Secret for the backup location with a custom name:

    1. $ oc create secret generic <custom_secret> -n openshift-adp --from-file cloud=credentials-velero

  5. Add the Secret with the custom name to the DataProtectionApplication CR, as in the following example:

    1. apiVersion: oadp.openshift.io/v1alpha1
    2. kind: DataProtectionApplication
    3. metadata:
    4.   name: <dpa_sample>
    5.   namespace: openshift-adp
    6. spec:
    7. ...
    8.   backupLocations:
    9.     - velero:
    10.         provider: gcp
    11.         default: true
    12.         credential:
    13.           key: cloud
    14.           name: <custom_secret> (1)
    15.         objectStorage:
    16.           bucket: <bucket_name>
    17.           prefix: <prefix>
    18.   snapshotLocations:
    19.     - velero:
    20.         provider: gcp
    21.         default: true
    22.         config:
    23.           project: <project>
    24.           snapshotLocation: us-west1
    1Backup location Secret with custom name.

Configuring the Data Protection Application

You can configure the Data Protection Application by setting Velero resource allocations or enabling self-signed CA certificates.

Setting Velero CPU and memory resource allocations

You set the CPU and memory resource allocations for the Velero pod by editing the DataProtectionApplication custom resource (CR) manifest.

Prerequisites

  • You must have the OpenShift API for Data Protection (OADP) Operator installed.

Procedure

  • Edit the values in the spec.configuration.velero.podConfig.ResourceAllocations block of the DataProtectionApplication CR manifest, as in the following example:

    1. apiVersion: oadp.openshift.io/v1alpha1
    2. kind: DataProtectionApplication
    3. metadata:
    4.   name: <dpa_sample>
    5. spec:
    6. ...
    7.   configuration:
    8.     velero:
    9.       podConfig:
    10.         resourceAllocations:
    11.           limits:
    12.             cpu: "1" (1)
    13.             memory: 512Mi (2)
    14.           requests:
    15.             cpu: 500m (3)
    16.             memory: 256Mi (4)
    1Specify the value in millicpus or CPU units. Default value is 500m or 1 CPU unit.
    2Default value is 512Mi.
    3Default value is 500m or 1 CPU unit.
    4Default value is 256Mi.

Enabling self-signed CA certificates

You must enable a self-signed CA certificate for object storage by editing the DataProtectionApplication custom resource (CR) manifest to prevent a certificate signed by unknown authority error.

Prerequisites

  • You must have the OpenShift API for Data Protection (OADP) Operator installed.

Procedure

  • Edit the spec.backupLocations.velero.objectStorage.caCert parameter and spec.backupLocations.velero.config parameters of the DataProtectionApplication CR manifest:

    1. apiVersion: oadp.openshift.io/v1alpha1
    2. kind: DataProtectionApplication
    3. metadata:
    4.   name: <dpa_sample>
    5. spec:
    6. ...
    7.   backupLocations:
    8.     - name: default
    9.       velero:
    10.         provider: aws
    11.         default: true
    12.         objectStorage:
    13.           bucket: <bucket>
    14.           prefix: <prefix>
    15.           caCert: <base64_encoded_cert_string> (1)
    16.         config:
    17.           insecureSkipTLSVerify: "false" (2)
    18. ...
    1Specify the Base46-encoded CA certificate string.
    2Must be false to disable SSL/TLS security.

Installing the Data Protection Application

You install the Data Protection Application (DPA) by creating an instance of the DataProtectionApplication API.

Prerequisites

  • You must install the OADP Operator.

  • You must configure object storage as a backup location.

  • If you use snapshots to back up PVs, your cloud provider must support either a native snapshot API or Container Storage Interface (CSI) snapshots.

  • If the backup and snapshot locations use the same credentials, you must create a Secret with the default name, cloud-credentials-gcp.

  • If the backup and snapshot locations use different credentials, you must create two Secrets:

    • Secret with a custom name for the backup location. You add this Secret to the DataProtectionApplication CR.

    • Secret with the default name, cloud-credentials-gcp, for the snapshot location. This Secret is not referenced in the DataProtectionApplication CR.

      If you do not want to specify backup or snapshot locations during the installation, you can create a default Secret with an empty credentials-velero file. If there is no default Secret, the installation will fail.

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:

    1. apiVersion: oadp.openshift.io/v1alpha1
    2. kind: DataProtectionApplication
    3. metadata:
    4.   name: <dpa_sample>
    5.   namespace: openshift-adp
    6. spec:
    7.   configuration:
    8.     velero:
    9.       defaultPlugins:
    10.         - gcp
    11.         - openshift (1)
    12.     restic:
    13.       enable: true (2)
    14.   backupLocations:
    15.     - velero:
    16.         provider: gcp
    17.         default: true
    18.         credential:
    19.           key: cloud
    20.           name: cloud-credentials-gcp (3)
    21.         objectStorage:
    22.           bucket: <bucket_name> (4)
    23.           prefix: <prefix> (5)
    24.   snapshotLocations: (6)
    25.     - velero:
    26.         provider: gcp
    27.         default: true
    28.         config:
    29.           project: <project>
    30.           snapshotLocation: us-west1 (7)
    1The openshift plug-in is mandatory.
    2Set to false if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has Restic pods running. You configure Restic for backups by adding spec.defaultVolumesToRestic: true to the Backup CR.
    3If 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.
    4Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
    5Specify a prefix for Velero backups, for example, velero, if the bucket is used for multiple purposes.
    6You do not need to specify a snapshot location if you use CSI snapshots or Restic to back up PVs.
    7The snapshot location must be in the same region as the PVs.

  4. Click Create.

  5. Verify the installation by viewing the OADP resources:

    1. $ oc get all -n openshift-adp

    Example output

    1. NAME                                                     READY   STATUS    RESTARTS   AGE
    2. pod/oadp-operator-controller-manager-67d9494d47-6l8z8    2/2     Running   0          2m8s
    3. pod/oadp-velero-sample-1-aws-registry-5d6968cbdd-d5w9k   1/1     Running   0          95s
    4. pod/restic-9cq4q                                         1/1     Running   0          94s
    5. pod/restic-m4lts                                         1/1     Running   0          94s
    6. pod/restic-pv4kr                                         1/1     Running   0          95s
    7. pod/velero-588db7f655-n842v                              1/1     Running   0          95s
    9. NAME                                                       TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
    10. service/oadp-operator-controller-manager-metrics-service   ClusterIP   172.30.70.140    <none>        8443/TCP   2m8s
    11. service/oadp-velero-sample-1-aws-registry-svc              ClusterIP   172.30.130.230   <none>        5000/TCP   95s
    13. NAME                    DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
    14. daemonset.apps/restic   3         3         3       3            3           <none>          96s
    16. NAME                                                READY   UP-TO-DATE   AVAILABLE   AGE
    17. deployment.apps/oadp-operator-controller-manager    1/1     1            1           2m9s
    18. deployment.apps/oadp-velero-sample-1-aws-registry   1/1     1            1           96s
    19. deployment.apps/velero                              1/1     1            1           96s
    21. NAME                                                           DESIRED   CURRENT   READY   AGE
    22. replicaset.apps/oadp-operator-controller-manager-67d9494d47    1         1         1       2m9s
    23. replicaset.apps/oadp-velero-sample-1-aws-registry-5d6968cbdd   1         1         1       96s
    24. replicaset.apps/velero-588db7f655                              1         1         1       96s

Enabling CSI in the DataProtectionApplication CR

You enable the Container Storage Interface (CSI) in the DataProtectionApplication custom resource (CR) in order to back up persistent volumes with CSI snapshots.

Prerequisites

  • The cloud provider must support CSI snapshots.

Procedure

  • Edit the DataProtectionApplication CR, as in the following example:

    1. apiVersion: oadp.openshift.io/v1alpha1
    2. kind: DataProtectionApplication
    3. ...
    4. spec:
    5.   configuration:
    6.     velero:
    7.       defaultPlugins:
    8.       - openshift
    9.       - csi (1)
    10.     featureFlags:
    11.     - EnableCSI (2)
    1Add the csi default plug-in.
    2Add the EnableCSI feature flag.