Configuring the OpenShift API for Data Protection with Amazon Web Services

You install the OpenShift API for Data Protection (OADP) with Amazon Web Services (AWS) by installing the OADP Operator. The Operator installs Velero 1.12.

Starting from OADP 1.0.4, all OADP 1.0.z versions can only be used as a dependency of the MTC Operator and are not available as a standalone Operator.

You configure AWS for Velero, create a default Secret, and then install the Data Protection Application. For more details, see Installing the OADP Operator.

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.

Configuring Amazon Web Services

You configure Amazon Web Services (AWS) for the OpenShift API for Data Protection (OADP).

Prerequisites

  • You must have the AWS CLI installed.

Procedure

  1. Set the BUCKET variable:

    1. $ BUCKET=<your_bucket>

  2. Set the REGION variable:

    1. $ REGION=<your_region>

  3. Create an AWS S3 bucket:

    1. $ aws s3api create-bucket \
    2.     --bucket $BUCKET \
    3.     --region $REGION \
    4.     --create-bucket-configuration LocationConstraint=$REGION (1)
    1us-east-1 does not support a LocationConstraint. If your region is us-east-1, omit —create-bucket-configuration LocationConstraint=$REGION.

  4. Create an IAM user:

    1. $ aws iam create-user --user-name velero (1)
    1If you want to use Velero to back up multiple clusters with multiple S3 buckets, create a unique user name for each cluster.

  5. Create a velero-policy.json file:

    1. $ cat > velero-policy.json <<EOF
    2. {
    3.     "Version": "2012-10-17",
    4.     "Statement": [
    5.         {
    6.             "Effect": "Allow",
    7.             "Action": [
    8.                 "ec2:DescribeVolumes",
    9.                 "ec2:DescribeSnapshots",
    10.                 "ec2:CreateTags",
    11.                 "ec2:CreateVolume",
    12.                 "ec2:CreateSnapshot",
    13.                 "ec2:DeleteSnapshot"
    14.             ],
    15.             "Resource": "*"
    16.         },
    17.         {
    18.             "Effect": "Allow",
    19.             "Action": [
    20.                 "s3:GetObject",
    21.                 "s3:DeleteObject",
    22.                 "s3:PutObject",
    23.                 "s3:AbortMultipartUpload",
    24.                 "s3:ListMultipartUploadParts"
    25.             ],
    26.             "Resource": [
    27.                 "arn:aws:s3:::${BUCKET}/*"
    28.             ]
    29.         },
    30.         {
    31.             "Effect": "Allow",
    32.             "Action": [
    33.                 "s3:ListBucket",
    34.                 "s3:GetBucketLocation",
    35.                 "s3:ListBucketMultipartUploads"
    36.             ],
    37.             "Resource": [
    38.                 "arn:aws:s3:::${BUCKET}"
    39.             ]
    40.         }
    41.     ]
    42. }
    43. EOF

  6. Attach the policies to give the velero user the minimum necessary permissions:

    1. $ aws iam put-user-policy \
    2.   --user-name velero \
    3.   --policy-name velero \
    4.   --policy-document file://velero-policy.json

  7. Create an access key for the velero user:

    1. $ aws iam create-access-key --user-name velero

    Example output

    1. {
    2.   "AccessKey": {
    3.         "UserName": "velero",
    4.         "Status": "Active",
    5.         "CreateDate": "2017-07-31T22:24:41.576Z",
    6.         "SecretAccessKey": <AWS_SECRET_ACCESS_KEY>,
    7.         "AccessKeyId": <AWS_ACCESS_KEY_ID>
    8.   }
    9. }

  8. Create a credentials-velero file:

    1. $ cat << EOF > ./credentials-velero
    2. [default]
    3. aws_access_key_id=<AWS_ACCESS_KEY_ID>
    4. aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>
    5. EOF

    You use the credentials-velero file to create a Secret object for AWS 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 AWS S3-compatible object storage, such as Multicloud Object Gateway 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 File System Backup (FSB), you do not need to specify a snapshot location because FSB 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.

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 -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 profiles for different credentials

If your backup and snapshot locations use different credentials, you create separate profiles in the credentials-velero file.

Then, you create a Secret object and specify the profiles in the DataProtectionApplication custom resource (CR).

Procedure

  1. Create a credentials-velero file with separate profiles for the backup and snapshot locations, as in the following example:

    1. [backupStorage]
    2. aws_access_key_id=<AWS_ACCESS_KEY_ID>
    3. aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>
    5. [volumeSnapshot]
    6. aws_access_key_id=<AWS_ACCESS_KEY_ID>
    7. aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>

  2. Create a Secret object with the credentials-velero file:

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

  3. Add the profiles 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.     - name: default
    10.       velero:
    11.         provider: aws
    12.         default: true
    13.         objectStorage:
    14.           bucket: <bucket_name>
    15.           prefix: <prefix>
    16.         config:
    17.           region: us-east-1
    18.           profile: "backupStorage"
    19.         credential:
    20.           key: cloud
    21.           name: cloud-credentials
    22.   snapshotLocations:
    23.     - name: default
    24.       velero:
    25.         provider: aws
    26.         config:
    27.           region: us-west-2
    28.           profile: "volumeSnapshot"

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.         nodeSelector: <node selector> (1)
    11.         resourceAllocations: (2)
    12.           limits:
    13.             cpu: "1"
    14.             memory: 1024Mi
    15.           requests:
    16.             cpu: 200m
    17.             memory: 256Mi
    1Specify the node selector to be supplied to Velero podSpec.
    2The resourceAllocations listed are for average usage.

Kopia is an option in OADP 1.3 and later releases. You can use Kopia for file system backups, and Kopia is your only option for Data Mover cases with the built-in Data Mover.

Kopia is more resource intensive than Restic, and you might need to adjust the CPU and memory requirements accordingly.

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 Base64-encoded CA certificate string.
    2The insecureSkipTLSVerify configuration can be set to either “true” or “false”. If set to “true”, SSL/TLS security is disabled. If set to “false”, SSL/TLS security is enabled.

Installing the Data Protection Application 1.2 and earlier

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.

  • If the backup and snapshot locations use different credentials, you must create a Secret with the default name, cloud-credentials, which contains separate profiles for the backup and snapshot location credentials.

    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.

    Velero creates a secret named velero-repo-credentials in the OADP namespace, which contains a default backup repository password. You can update the secret with your own password encoded as base64 before you run your first backup targeted to the backup repository. The value of the key to update is Data[repository-password].

    After you create your DPA, the first time that you run a backup targeted to the backup repository, Velero creates a backup repository whose secret is velero-repo-credentials, which contains either the default password or the one you replaced it with. If you update the secret password after the first backup, the new password will not match the password in velero-repo-credentials, and therefore, Velero will not be able to connect with the older backups.

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.         - openshift (1)
    11.         - aws
    12.       resourceTimeout: 10m (2)
    13.     restic:
    14.       enable: true (3)
    15.       podConfig:
    16.         nodeSelector: <node_selector> (4)
    17.   backupLocations:
    18.     - name: default
    19.       velero:
    20.         provider: aws
    21.         default: true
    22.         objectStorage:
    23.           bucket: <bucket_name> (5)
    24.           prefix: <prefix> (6)
    25.         config:
    26.           region: <region>
    27.           profile: "default"
    28.         credential:
    29.           key: cloud
    30.           name: cloud-credentials (7)
    31.   snapshotLocations: (8)
    32.     - name: default
    33.       velero:
    34.         provider: aws
    35.         config:
    36.           region: <region> (9)
    37.           profile: "default"
    1The openshift plugin is mandatory.
    2Specify 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.
    3Set this value to false if you want to disable the Restic installation. Restic deploys a daemon set, which means that Restic pods run on each working node. In OADP version 1.2 and later, you can configure Restic for backups by adding spec.defaultVolumesToFsBackup: true to the Backup CR. In OADP version 1.1, add spec.defaultVolumesToRestic: true to the Backup CR.
    4Specify on which nodes Restic is available. By default, Restic runs on all nodes.
    5Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
    6Specify a prefix for Velero backups, for example, velero, if the bucket is used for multiple purposes.
    7Specify the name of the Secret object that you created. If you do not specify this value, the default name, cloud-credentials, is used. If you specify a custom name, the custom name is used for the backup location.
    8Specify a snapshot location, unless you use CSI snapshots or Restic to back up PVs.
    9The snapshot location must be in the same region as the PVs.

  4. Click Create.

Verifying the installation

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

    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/restic-9cq4q                                         1/1     Running   0          94s
    4. pod/restic-m4lts                                         1/1     Running   0          94s
    5. pod/restic-pv4kr                                         1/1     Running   0          95s
    6. pod/velero-588db7f655-n842v                              1/1     Running   0          95s
    8. NAME                                                       TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
    9. service/oadp-operator-controller-manager-metrics-service   ClusterIP   172.30.70.140    <none>        8443/TCP   2m8s
    11. NAME                    DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
    12. daemonset.apps/restic   3         3         3       3            3           <none>          96s
    14. NAME                                                READY   UP-TO-DATE   AVAILABLE   AGE
    15. deployment.apps/oadp-operator-controller-manager    1/1     1            1           2m9s
    16. deployment.apps/velero                              1/1     1            1           96s
    18. NAME                                                           DESIRED   CURRENT   READY   AGE
    19. replicaset.apps/oadp-operator-controller-manager-67d9494d47    1         1         1       2m9s
    20. replicaset.apps/velero-588db7f655                              1         1         1       96s

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

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

    Example output

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

  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:

    1. $ oc get backupStorageLocation -n openshift-adp

    Example output

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

Installing the Data Protection Application 1.3

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.

  • If the backup and snapshot locations use different credentials, you must create a Secret with the default name, cloud-credentials, which contains separate profiles for the backup and snapshot location credentials.

    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 (1)
    6. spec:
    7.   configuration:
    8.     velero:
    9.       defaultPlugins:
    10.         - openshift (2)
    11.         - aws
    12.       resourceTimeout: 10m (3)
    13.     nodeAgent: (4)
    14.       enable: true (5)
    15.       uploaderType: kopia (6)
    16.       podConfig:
    17.         nodeSelector: <node_selector> (7)
    18.   backupLocations:
    19.     - name: default
    20.       velero:
    21.         provider: aws
    22.         default: true
    23.         objectStorage:
    24.           bucket: <bucket_name> (8)
    25.           prefix: <prefix> (9)
    26.         config:
    27.           region: <region>
    28.           profile: "default"
    29.         credential:
    30.           key: cloud
    31.           name: cloud-credentials (10)
    32.   snapshotLocations: (11)
    33.     - name: default
    34.       velero:
    35.         provider: aws
    36.         config:
    37.           region: <region> (12)
    38.           profile: "default"
    1The default namespace for OADP is openshift-adp. The namespace is a variable and is configurable.
    2The openshift plugin is mandatory.
    3Specify 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.
    4The administrative agent that routes the administrative requests to servers.
    5Set this value to true if you want to enable nodeAgent and perform File System Backup.
    6Enter 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.
    7Specify the nodes on which Kopia or Restic are available. By default, Kopia or Restic run on all nodes.
    8Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
    9Specify a prefix for Velero backups, for example, velero, if the bucket is used for multiple purposes.
    10Specify the name of the Secret object that you created. If you do not specify this value, the default name, cloud-credentials, is used. If you specify a custom name, the custom name is used for the backup location.
    11Specify a snapshot location, unless you use CSI snapshots or a File System Backup (FSB) to back up PVs.
    12The snapshot location must be in the same region as the PVs.

  4. Click Create.

Verifying the installation

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

    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/node-agent-9cq4q                                     1/1     Running   0          94s
    4. pod/node-agent-m4lts                                     1/1     Running   0          94s
    5. pod/node-agent-pv4kr                                     1/1     Running   0          95s
    6. pod/velero-588db7f655-n842v                              1/1     Running   0          95s
    8. NAME                                                       TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
    9. service/oadp-operator-controller-manager-metrics-service   ClusterIP   172.30.70.140    <none>        8443/TCP   2m8s
    10. service/openshift-adp-velero-metrics-svc                   ClusterIP   172.30.10.0      <none>        8085/TCP   8h
    12. NAME                        DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
    13. daemonset.apps/node-agent    3         3         3       3            3           <none>          96s
    15. NAME                                                READY   UP-TO-DATE   AVAILABLE   AGE
    16. deployment.apps/oadp-operator-controller-manager    1/1     1            1           2m9s
    17. deployment.apps/velero                              1/1     1            1           96s
    19. NAME                                                           DESIRED   CURRENT   READY   AGE
    20. replicaset.apps/oadp-operator-controller-manager-67d9494d47    1         1         1       2m9s
    21. replicaset.apps/velero-588db7f655                              1         1         1       96s

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

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

    Example output

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

  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:

    1. $ oc get backupStorageLocation -n openshift-adp

    Example output

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

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)
    1Add the csi default plugin.