Installing and configuring the OpenShift API for Data Protection with Amazon Web Services

    You configure AWS for Velero, create a default , 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.

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

    The OADP Operator installs Velero 1.9.

    Prerequisites

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

    Procedure

    1. In the OKD web console, click OperatorsOperatorHub.

    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 OperatorsInstalled Operators to verify the installation.

    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:

    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. }
    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:

      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.

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

    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.

    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.

    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.

    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>
      4. [volumeSnapshot]
      5. aws_access_key_id=<AWS_ACCESS_KEY_ID>
      6. 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)

    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/v1beta1
      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:
      12. limits:
      13. cpu: "1"
      14. memory: 512Mi
      15. requests:
      16. cpu: 500m
      17. memory: 256Mi
      1Specify the node selector to be supplied to Velero podSpec.

    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/v1beta1
      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. caCert: <base64_encoded_cert_string> (1)
      15. config:
      16. insecureSkipTLSVerify: "false" (2)

    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 OperatorsInstalled 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/v1beta1
      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 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 can configure Restic for backups by adding 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.

    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/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
      7. NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
      8. service/oadp-operator-controller-manager-metrics-service ClusterIP 172.30.70.140 <none> 8443/TCP 2m8s
      9. NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
      10. daemonset.apps/restic 3 3 3 3 3 <none> 96s
      11. NAME READY UP-TO-DATE AVAILABLE AGE
      12. deployment.apps/oadp-operator-controller-manager 1/1 1 1 2m9s
      13. deployment.apps/velero 1/1 1 1 96s
      14. NAME DESIRED CURRENT READY AGE
      15. replicaset.apps/oadp-operator-controller-manager-67d9494d47 1 1 1 2m9s
      16. 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.