--- title: Configuring the OpenShift API for Data Protection with AWS S3 compatible storage --- # Configuring the OpenShift API for Data Protection with AWS S3 compatible storage {#installing-oadp-aws} Install the OpenShift API for Data Protection (OADP) with Amazon Web Services (AWS) S3 compatible storage by installing the OADP Operator. The Operator installs Velero 1.16. 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 software catalog sources and mirror the Operator catalog. See *Using Operator Lifecycle Manager in disconnected environments* for details. ## About Amazon Simple Storage Service, Identity and Access Management, and GovCloud {#oadp-s3-and-gov-cloud_installing-oadp-aws} Review Amazon Simple Storage Service (S3), Identity and Access Management (IAM), and AWS GovCloud requirements to configure backup storage with appropriate security controls. This helps you meet federal data security requirements and use correct endpoints. AWS S3 is a storage solution of Amazon for the internet. As an authorized user, you can use this service to store and retrieve any amount of data whenever you want, from anywhere on the web. You securely control access to Amazon S3 and other Amazon services by using the AWS Identity and Access Management (IAM) web service. You can use IAM to manage permissions that control which AWS resources users can access. You use IAM to both authenticate, or verify that a user is who they claim to be, and to authorize, or grant permissions to use resources. AWS GovCloud (US) is an Amazon storage solution developed to meet the stringent and specific data security requirements of the United States Federal Government. AWS GovCloud (US) works the same as Amazon S3 except for the following: - You cannot copy the contents of an Amazon S3 bucket in the AWS GovCloud (US) regions directly to or from another AWS region. - If you use Amazon S3 policies, use the AWS GovCloud (US) Amazon Resource Name (ARN) identifier to unambiguously specify a resource across all of AWS, such as in IAM policies, Amazon S3 bucket names, and API calls. - In AWS GovCloud (US) regions, ARNs have an identifier that is different from the one in other standard AWS regions, `arn:aws-us-gov`. If you need to specify the US-West or US-East region, use one the following ARNs: - For US-West, use `us-gov-west-1`. - For US-East, use `us-gov-east-1`. - For all other standard regions, ARNs begin with: `arn:aws`. - In AWS GovCloud (US) regions, use the endpoints listed in the **AWS GovCloud (US-East)** and **AWS GovCloud (US-West)** rows of the "Amazon S3 endpoints" table. If you are processing export-controlled data, use one of the SSL/TLS endpoints. If you have FIPS requirements, use a FIPS 140-2 endpoint such as `https://s3-fips.us-gov-west-1.amazonaws.com` or `https://s3-fips.us-gov-east-1.amazonaws.com`. - To find other AWS-imposed restrictions, see the AWS documentation. **Additional resources** {._additional-resources} - [Amazon Simple Storage Service endpoints and quotas (AWS documentation)](https://docs.aws.amazon.com/general/latest/gr/s3.html) - [How Amazon Simple Storage Service Differs for AWS GovCloud (US) (AWS documentation)](https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-s3.html#govcloud-S3-diffs) ## Configuring Amazon Web Services {#migration-configuring-aws-s3_installing-oadp-aws} Configure Amazon Web Services (AWS) S3 storage and Identity and Access Management (IAM) credentials for backup storage with OADP. This provides the necessary permissions and storage infrastructure for data protection operations. **Prerequisites** - You must have the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) installed. **Procedure** 1. Set the `BUCKET` variable: ```terminal $ BUCKET= ``` 2. Set the `REGION` variable: ```terminal $ REGION= ``` 3. Create an AWS S3 bucket: ```terminal $ aws s3api create-bucket \ --bucket $BUCKET \ --region $REGION \ --create-bucket-configuration LocationConstraint=$REGION ``` where: `LocationConstraint` : Specifies the bucket configuration location constraint. `us-east-1` does not support `LocationConstraint`. If your region is `us-east-1`, omit `--create-bucket-configuration LocationConstraint=$REGION`. 4. Create an IAM user: ```terminal $ aws iam create-user --user-name velero ``` where: `velero` : Specifies the user name. If 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: ```terminal $ cat > velero-policy.json <, "AccessKeyId": } } ``` 8. Create a `credentials-velero` file: ```terminal $ cat << EOF > ./credentials-velero [default] aws_access_key_id= aws_secret_access_key= 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 {#oadp-about-backup-snapshot-locations_installing-oadp-aws} Review backup location, snapshot location, and secret configuration requirements for the `DataProtectionApplication` custom resource (CR). This helps you understand storage options and credential management for data protection operations. ### Backup locations {#backup-locations_installing-oadp-aws} You can specify one of the following AWS S3-compatible object storage solutions as a backup location: - Multicloud Object Gateway (MCG) - Red Hat Container Storage - Ceph RADOS Gateway; also known as Ceph Object Gateway - Red Hat OpenShift Data Foundation - MinIO Velero backs up OpenShift Container Platform resources, Kubernetes objects, and internal images as an archive file on object storage. ### Snapshot locations {#snapshot-locations_installing-oadp-aws} 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 {#secrets_installing-oadp-aws} 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. > [!IMPORTANT] > 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 {#oadp-creating-default-secret_installing-oadp-aws} 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`. > [!NOTE] > 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. **Procedure** 1. Create a `credentials-velero` file for the backup storage location in the appropriate format for your cloud provider. See the following example: ```terminal [default] aws_access_key_id= aws_secret_access_key= ``` 2. Create a `Secret` custom resource (CR) with the default name: ```terminal $ 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 {#oadp-aws-secrets-for-different-credentials_installing-oadp-aws} 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: ```terminal [backupStorage] aws_access_key_id= aws_secret_access_key= [volumeSnapshot] aws_access_key_id= aws_secret_access_key= ``` 2. Create a `Secret` object with the `credentials-velero` file: ```terminal $ 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: ```yaml apiVersion: oadp.openshift.io/v1alpha1 kind: DataProtectionApplication metadata: name: namespace: openshift-adp spec: ... backupLocations: - name: default velero: provider: aws default: true objectStorage: bucket: prefix: config: region: us-east-1 profile: "backupStorage" credential: key: cloud name: cloud-credentials snapshotLocations: - velero: provider: aws config: region: us-west-2 profile: "volumeSnapshot" ``` ### Creating an OADP SSE-C encryption key for additional data security {#oadp-ssec-encrypted-backups_installing-oadp-aws} Configure server-side encryption with customer-provided keys (SSE-C) to add an additional layer of encryption for backup data stored in Amazon Web Services (AWS) S3. This protects backup data if AWS credentials become exposed. Amazon Web Services (AWS) S3 applies server-side encryption with AWS S3 managed keys (SSE-S3) as the base level of encryption for every bucket in Amazon S3. OpenShift API for Data Protection (OADP) encrypts data by using SSL/TLS, HTTPS, and the `velero-repo-credentials` secret when transferring the data from a cluster to storage. To protect backup data in case of lost or stolen AWS credentials, apply an additional layer of encryption. The velero-plugin-for-aws plugin provides several additional encryption methods. You should review its configuration options and consider implementing additional encryption. You can store your own encryption keys by using server-side encryption with customer-provided keys (SSE-C). This feature provides additional security if your AWS credentials become exposed. > [!WARNING] > Be sure to store cryptographic keys in a secure and safe manner. Encrypted data and backups cannot be recovered if you do not have the encryption key. **Prerequisites** - To make OADP mount a secret that contains your SSE-C key to the Velero pod at `/credentials`, use the following default secret name for AWS: `cloud-credentials`, and leave at least one of the following labels empty: - `dpa.spec.backupLocations[].velero.credential` - `dpa.spec.snapshotLocations[].velero.credential` This is a workaround for a known issue: https://issues.redhat.com/browse/OADP-3971. > [!NOTE] > The following procedure contains an example of a `spec:backupLocations` block that does not specify credentials. This example would trigger an OADP secret mounting. - If you need the backup location to have credentials with a different name than `cloud-credentials`, you must add a snapshot location, such as the one in the following example, that does not contain a credential name. Because the following example does not contain a credential name, the snapshot location will use `cloud-credentials` as its secret for taking snapshots. ```yaml snapshotLocations: - velero: config: profile: default region: provider: aws # ... ``` **Procedure** 1. Create an SSE-C encryption key: 1. Generate a random number and save it as a file named `sse.key` by running the following command: ```terminal $ dd if=/dev/urandom bs=1 count=32 > sse.key ``` 2. Create an OpenShift Container Platform secret: - If you are initially installing and configuring OADP, create the AWS credential and encryption key secret at the same time by running the following command: ```terminal $ oc create secret generic cloud-credentials --namespace openshift-adp --from-file cloud=/openshift_aws_credentials,customer-key=/sse.key ``` - If you are updating an existing installation, edit the values of the `cloud-credential` `secret` block of the `DataProtectionApplication` CR manifest, as in the following example: ```yaml apiVersion: v1 data: cloud: W2Rfa2V5X2lkPSJBS0lBVkJRWUIyRkQ0TlFHRFFPQiIKYXdzX3NlY3JldF9hY2Nlc3Nfa2V5PrUE1mNWVSbTN5K2FpeWhUTUQyQk1WZHBOIgo= customer-key: v+TFIiq6aaXPbj8dhos= kind: Secret # ... ``` 3. Edit the value of the `customerKeyEncryptionFile` attribute in the `backupLocations` block of the `DataProtectionApplication` CR manifest, as in the following example: ```yaml spec: backupLocations: - velero: config: customerKeyEncryptionFile: /credentials/customer-key profile: default # ... ``` > [!WARNING] > You must restart the Velero pod to remount the secret credentials properly on an existing installation. The installation is complete, and you can back up and restore OpenShift Container Platform resources. The data saved in AWS S3 storage is encrypted with the new key, and you cannot download it from the AWS S3 console or API without the additional encryption key. **Verification** To verify that you cannot download the encrypted files without the inclusion of an additional key, create a test file, upload it, and then try to download it. 1. Create a test file by running the following command: ```terminal $ echo "encrypt me please" > test.txt ``` 2. Upload the test file by running the following command: ```terminal $ aws s3api put-object \ --bucket \ --key test.txt \ --body test.txt \ --sse-customer-key fileb://sse.key \ --sse-customer-algorithm AES256 ``` 3. Try to download the file. In either the Amazon web console or the terminal, run the following command: ```terminal $ s3cmd get s3:///test.txt test.txt ``` The download fails because the file is encrypted with an additional key. 4. Download the file with the additional encryption key by running the following command: ```terminal $ aws s3api get-object \ --bucket \ --key test.txt \ --sse-customer-key fileb://sse.key \ --sse-customer-algorithm AES256 \ downloaded.txt ``` 5. Read the file contents by running the following command: ```terminal $ cat downloaded.txt ``` ```terminal encrypt me please ``` #### Downloading a file with an SSE-C encryption key for files backed up by Velero {#oadp-ssec-encrypted-backups-velero_installing-oadp-aws} When you are verifying an SSE-C encryption key, you can also download the file with the additional encryption key for files that were backed up with Velero. **Procedure** - Download the file with the additional encryption key for files backed up by Velero by running the following command: ```terminal $ aws s3api get-object \ --bucket \ --key velero/backups/mysql-persistent-customerkeyencryptionfile4/mysql-persistent-customerkeyencryptionfile4.tar.gz \ --sse-customer-key fileb://sse.key \ --sse-customer-algorithm AES256 \ --debug \ velero_download.tar.gz ``` ## Installing the Data Protection Application {#oadp-installing-dpa_installing-oadp-aws} 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. > [!NOTE] > 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 **Ecosystem** → **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: ```yaml apiVersion: oadp.openshift.io/v1alpha1 kind: DataProtectionApplication metadata: name: namespace: openshift-adp spec: configuration: velero: defaultPlugins: - openshift - aws resourceTimeout: 10m nodeAgent: enable: true uploaderType: kopia podConfig: nodeSelector: backupLocations: - name: default velero: provider: aws default: true objectStorage: bucket: prefix: config: region: profile: "default" s3ForcePathStyle: "true" s3Url: credential: key: cloud name: cloud-credentials snapshotLocations: - name: default velero: provider: aws config: region: profile: "default" credential: key: cloud name: cloud-credentials ``` 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. `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. `s3ForcePathStyle` : Specifies whether to force path style URLs for S3 objects (Boolean). Not Required for AWS S3. Required only for S3 compatible storage. `s3Url` : Specifies the URL of the object store that you are using to store backups. Not required for AWS S3. Required only for S3 compatible storage. `name` : Specifies 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. `snapshotLocations` : Specifies a snapshot location, unless you use CSI snapshots or a File System Backup (FSB) to back up PVs. `region` : 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`, is used. If you specify a custom name, the custom name is used for the snapshot location. If your backup and snapshot locations use different credentials, create separate profiles in the `credentials-velero` file. 4. Click **Create**. **Verification** 1. Verify the installation by viewing the OpenShift API for Data Protection (OADP) resources by running the following command: ```terminal $ oc get all -n openshift-adp ``` ``` 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 8443/TCP 2m8s service/openshift-adp-velero-metrics-svc ClusterIP 172.30.10.0 8085/TCP 8h NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE daemonset.apps/node-agent 3 3 3 3 3 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 ``` 2. Verify that the `DataProtectionApplication` (DPA) is reconciled by running the following command: ```terminal $ oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}' ``` ```yaml {"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: ```terminal $ oc get backupstoragelocations.velero.io -n openshift-adp ``` ```yaml NAME PHASE LAST VALIDATED AGE DEFAULT dpa-sample-1 Available 1s 3d16h true ``` ## Changing the default backup storage location in a DPA {#oadp-changing-default-bsl_installing-oadp-aws} Understand why the `default` field of the `backupLocations` object in a `DataProtectionApplication` (DPA) does not change the default `BackupStorageLocation` (BSL) when you configure multiple backup locations. This helps you to identify the root cause and apply the correct workaround. When a DPA includes multiple backup locations, updating the `default` field to change the default BSL does not take effect. After you set `default: true` on a different BSL and set `default: false` on the previously default BSL, the `oc get bsl` command shows that the original BSL remains the default. Root cause : The OADP Operator sets the `default` field on a BSL resource only during initial creation of the DPA. On subsequent reconciliations, the Operator preserves the default BSL. This behavior is intentional. Velero independently manages the `default` field on BSL resources. If the OADP Operator overwrites this field on every reconciliation, it conflicts with Velero, causing a race condition where both controllers compete over the value. To prevent this conflict, the Operator checks whether the BSL already exists. If it exists, the Operator preserves the current `default` value instead of applying the value from the DPA specification. Workaround : To change the default BSL, delete and re-create the DPA. Deleting and re-creating the DPA ensures that the BSL resources are created from scratch. The new `default` setting is applied during initial creation and re-deployment of the DPA. **Procedure** 1. Delete the existing DPA by running the following command: ```terminal $ oc delete dpa -n openshift-adp ``` Replace `` with the name of the DPA custom resource. 2. Re-create the DPA with the updated default BSL configuration by running the following command: ```terminal $ oc apply -f ``` Replace `` with the file name of the updated DPA custom resource definition. ### Setting Velero CPU and memory resource allocations {#oadp-setting-resource-limits-and-requests_installing-oadp-aws} 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: ```yaml apiVersion: oadp.openshift.io/v1alpha1 kind: DataProtectionApplication metadata: name: spec: # ... configuration: velero: podConfig: nodeSelector: resourceAllocations: limits: cpu: "1" memory: 1024Mi requests: cpu: 200m memory: 256Mi ``` where: `nodeSelector` : Specifies the node selector to be supplied to Velero podSpec. `resourceAllocations` : Specifies the resource allocations listed for average usage. > [!NOTE] > 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. Use the `nodeSelector` field to select which nodes can run the node agent. The `nodeSelector` field is the simplest recommended form of node selection constraint. Any label specified must match the labels on each node. ### Enabling self-signed CA certificates {#oadp-self-signed-certificate_installing-oadp-aws} 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: ```yaml apiVersion: oadp.openshift.io/v1alpha1 kind: DataProtectionApplication metadata: name: spec: # ... backupLocations: - name: default velero: provider: aws default: true objectStorage: bucket: prefix: caCert: config: insecureSkipTLSVerify: "false" # ... ``` where: `caCert` : Specifies the Base64-encoded CA certificate string. `insecureSkipTLSVerify` : Specifies the `insecureSkipTLSVerify` configuration. The 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. ### Using CA certificates with the velero command aliased for Velero deployment {#oadp-using-ca-certificates-with-velero-command-aliased-for-velero-deployment_installing-oadp-aws} You might want to use the Velero CLI without installing it locally on your system by creating an alias for it. **Prerequisites** - You must be logged in to the OpenShift Container Platform cluster as a user with the `cluster-admin` role. - You must have the OpenShift CLI (`oc`) installed. **Procedure** 1. To use an aliased Velero command, run the following command: ```terminal $ alias velero='oc -n openshift-adp exec deployment/velero -c velero -it -- ./velero' ``` 2. Check that the alias is working by running the following command: ```terminal $ velero version ``` ```terminal Client: Version: v1.12.1-OADP Git commit: - Server: Version: v1.12.1-OADP ``` 3. To use a CA certificate with this command, you can add a certificate to the Velero deployment by running the following commands: ```terminal $ CA_CERT=$(oc -n openshift-adp get dataprotectionapplications.oadp.openshift.io -o jsonpath='{.spec.backupLocations[0].velero.objectStorage.caCert}') ``` ```terminal $ [[ -n $CA_CERT ]] && echo "$CA_CERT" | base64 -d | oc exec -n openshift-adp -i deploy/velero -c velero -- bash -c "cat > /tmp/your-cacert.txt" || echo "DPA BSL has no caCert" ``` ```terminal $ velero describe backup --details --cacert /tmp/.txt ``` 4. To fetch the backup logs, run the following command: ```terminal $ velero backup logs --cacert /tmp/ ``` You can use these logs to view failures and warnings for the resources that you cannot back up. 5. If the Velero pod restarts, the `/tmp/your-cacert.txt` file disappears, and you must re-create the `/tmp/your-cacert.txt` file by re-running the commands from the previous step. 6. You can check if the `/tmp/your-cacert.txt` file still exists, in the file location where you stored it, by running the following command: ```terminal $ oc exec -n openshift-adp -i deploy/velero -c velero -- bash -c "ls /tmp/your-cacert.txt" /tmp/your-cacert.txt ``` In a future release of OpenShift API for Data Protection (OADP), we plan to mount the certificate to the Velero pod so that this step is not required. ### Configuring node agents and node labels {#oadp-configuring-node-agents_installing-oadp-aws} The Data Protection Application (DPA) uses the `nodeSelector` field to select which nodes can run the node agent. The `nodeSelector` field is the recommended form of node selection constraint. **Procedure** 1. Run the node agent on any node that you choose by adding a custom label: ```terminal $ oc label node/ node-role.kubernetes.io/nodeAgent="" ``` > [!NOTE] > Any label specified must match the labels on each node. 2. Use the same custom label in the `DPA.spec.configuration.nodeAgent.podConfig.nodeSelector` field, which you used for labeling nodes: ```terminal configuration: nodeAgent: enable: true podConfig: nodeSelector: node-role.kubernetes.io/nodeAgent: "" ``` The following example is an anti-pattern of `nodeSelector` and does not work unless both labels, `node-role.kubernetes.io/infra: ""` and `node-role.kubernetes.io/worker: ""`, are on the node: ```terminal configuration: nodeAgent: enable: true podConfig: nodeSelector: node-role.kubernetes.io/infra: "" node-role.kubernetes.io/worker: "" ``` ## Configuring the backup storage location with a MD5 checksum algorithm {#oadp-configuring-aws-md5sum_installing-oadp-aws} You can configure the Backup Storage Location (BSL) in the Data Protection Application (DPA) to use a MD5 checksum algorithm for both Amazon Simple Storage Service (Amazon S3) and S3-compatible storage providers. The checksum algorithm calculates the checksum for uploading and downloading objects to Amazon S3. You can use one of the following options to set the `checksumAlgorithm` field in the `spec.backupLocations.velero.config.checksumAlgorithm` section of the DPA. - `CRC32` - `CRC32C` - `SHA1` - `SHA256` You can also set the `checksumAlgorithm` field to an empty value to skip the MD5 checksum check. If you do not set a value for the `checksumAlgorithm` field, then the default value is set to `CRC32`. **Prerequisites** - You have installed the OADP Operator. - You have configured Amazon S3, or S3-compatible object storage as a backup location. **Procedure** - Configure the BSL in the DPA as shown in the following example: ```yaml {title="Example Data Protection Application"} apiVersion: oadp.openshift.io/v1alpha1 kind: DataProtectionApplication metadata: name: test-dpa namespace: openshift-adp spec: backupLocations: - name: default velero: config: checksumAlgorithm: "" insecureSkipTLSVerify: "true" profile: "default" region: s3ForcePathStyle: "true" s3Url: credential: key: cloud name: cloud-credentials default: true objectStorage: bucket: prefix: velero provider: aws configuration: velero: defaultPlugins: - openshift - aws - csi ``` where: `checksumAlgorithm` : Specifies the `checksumAlgorithm`. In this example, the `checksumAlgorithm` field is set to an empty value. You can select an option from the following list: `CRC32`, `CRC32C`, `SHA1`, `SHA256`. > [!IMPORTANT] > If you are using Noobaa as the object storage provider, and you do not set the `spec.backupLocations.velero.config.checksumAlgorithm` field in the DPA, an empty value of `checksumAlgorithm` is added to the BSL configuration. > > The empty value is only added for BSLs that are created using the DPA. This value is not added if you create the BSL by using any other method. ## Configuring the DPA with client burst and QPS settings {#oadp-configuring-client-burst-qps_installing-oadp-aws} The burst setting determines how many requests can be sent to the `velero` server before the limit is applied. After the burst limit is reached, the queries per second (QPS) setting determines how many additional requests can be sent per second. You can set the burst and QPS values of the `velero` server by configuring the Data Protection Application (DPA) with the burst and QPS values. You can use the `dpa.configuration.velero.client-burst` and `dpa.configuration.velero.client-qps` fields of the DPA to set the burst and QPS values. **Prerequisites** - You have installed the OADP Operator. **Procedure** - Configure the `client-burst` and the `client-qps` fields in the DPA as shown in the following example: ```yaml {title="Example Data Protection Application"} apiVersion: oadp.openshift.io/v1alpha1 kind: DataProtectionApplication metadata: name: test-dpa namespace: openshift-adp spec: backupLocations: - name: default velero: config: insecureSkipTLSVerify: "true" profile: "default" region: s3ForcePathStyle: "true" s3Url: credential: key: cloud name: cloud-credentials default: true objectStorage: bucket: prefix: velero provider: aws configuration: nodeAgent: enable: true uploaderType: restic velero: client-burst: 500 client-qps: 300 defaultPlugins: - openshift - aws - kubevirt ``` where: `client-burst` : Specifies the `client-burst` value. In this example, the `client-burst` field is set to 500. `client-qps` : Specifies the `client-qps` value. In this example, the `client-qps` field is set to 300. ## Configuring node agent load affinity {#oadp-configuring-node-agent-load-affinity_installing-oadp-aws} You can schedule the node agent pods on specific nodes by using the `spec.podConfig.nodeSelector` object of the `DataProtectionApplication` (DPA) custom resource (CR). See the following example in which you can schedule the node agent pods on nodes with the label `label.io/role: cpu-1` and `other-label.io/other-role: cpu-2`. ```yaml ... spec: configuration: nodeAgent: enable: true uploaderType: kopia podConfig: nodeSelector: label.io/role: cpu-1 other-label.io/other-role: cpu-2 ... ``` You can add more restrictions on the node agent pods scheduling by using the `nodeagent.loadAffinity` object in the DPA spec. **Prerequisites** - You must be logged in as a user with `cluster-admin` privileges. - You have installed the OADP Operator. - You have configured the DPA CR. **Procedure** - Configure the DPA spec `nodegent.loadAffinity` object as shown in the following example. In the example, you ensure that the node agent pods are scheduled only on nodes with the label `label.io/role: cpu-1` and the label `label.io/hostname` matching with either `node1` or `node2`. ```yaml ... spec: configuration: nodeAgent: enable: true loadAffinity: - nodeSelector: matchLabels: label.io/role: cpu-1 matchExpressions: - key: label.io/hostname operator: In values: - node1 - node2 ... ``` where: `loadAffinity` : Specifies the `loadAffinity` object by adding the `matchLabels` and `matchExpressions` objects. `matchExpressions` : Specifies the `matchExpressions` object to add restrictions on the node agent pods scheduling. ## Node agent load affinity guidelines {#oadp-node-agent-load-affinity-guidelines_installing-oadp-aws} Use the following guidelines to configure the node agent `loadAffinity` object in the `DataProtectionApplication` (DPA) custom resource (CR). - Use the `spec.nodeagent.podConfig.nodeSelector` object for simple node matching. - Use the `loadAffinity.nodeSelector` object without the `podConfig.nodeSelector` object for more complex scenarios. - You can use both `podConfig.nodeSelector` and `loadAffinity.nodeSelector` objects, but the `loadAffinity` object must be equal or more restrictive as compared to the `podConfig` object. In this scenario, the `podConfig.nodeSelector` labels must be a subset of the labels used in the `loadAffinity.nodeSelector` object. - You cannot use the `matchExpressions` and `matchLabels` fields if you have configured both `podConfig.nodeSelector` and `loadAffinity.nodeSelector` objects in the DPA. - See the following example to configure both `podConfig.nodeSelector` and `loadAffinity.nodeSelector` objects in the DPA. ```yaml ... spec: configuration: nodeAgent: enable: true uploaderType: kopia loadAffinity: - nodeSelector: matchLabels: label.io/location: 'US' label.io/gpu: 'no' podConfig: nodeSelector: label.io/gpu: 'no' ``` ## Configuring node agent load concurrency {#oadp-configuring-node-agent-load-concurrency_installing-oadp-aws} You can control the maximum number of node agent operations that can run simultaneously on each node within your cluster. You can configure it using one of the following fields of the Data Protection Application (DPA): - `globalConfig`: Defines a default concurrency limit for the node agent across all nodes. - `perNodeConfig`: Specifies different concurrency limits for specific nodes based on `nodeSelector` labels. This provides flexibility for environments where certain nodes might have different resource capacities or roles. **Prerequisites** - You must be logged in as a user with `cluster-admin` privileges. **Procedure** 1. If you want to use load concurrency for specific nodes, add labels to those nodes: ```terminal $ oc label node/ label.io/instance-type='large' ``` 2. Configure the load concurrency fields for your DPA instance: ```yaml configuration: nodeAgent: enable: true uploaderType: kopia loadConcurrency: globalConfig: 1 perNodeConfig: - nodeSelector: matchLabels: label.io/instance-type: large number: 3 ``` where: `globalConfig` : Specifies the global concurrent number. The default value is 1, which means there is no concurrency and only one load is allowed. The `globalConfig` value does not have a limit. `label.io/instance-type` : Specifies the label for per-node concurrency. `number` : Specifies the per-node concurrent number. You can specify many per-node concurrent numbers, for example, based on the instance type and size. The range of per-node concurrent number is the same as the global concurrent number. If the configuration file contains a per-node concurrent number and a global concurrent number, the per-node concurrent number takes precedence. ## Configuring the node agent as a non-root and non-privileged user {#oadp-configuring-node-agent-non-root_installing-oadp-aws} To enhance the node agent security, you can configure the OADP Operator node agent daemonset to run as a non-root and non-privileged user by using the `spec.configuration.velero.disableFsBackup` setting in the `DataProtectionApplication` (DPA) custom resource (CR). By setting the `spec.configuration.velero.disableFsBackup` setting to `true`, the node agent security context sets the root file system to read-only and sets the `privileged` flag to `false`. > [!NOTE] > Setting `spec.configuration.velero.disableFsBackup` to `true` enhances the node agent security by removing the need for privileged containers and enforcing a read-only root file system. > > However, it also disables File System Backup (FSB) with Kopia. If your workloads rely on FSB for backing up volumes that do not support native snapshots, then you should evaluate whether the `disableFsBackup` configuration fits your use case. **Prerequisites** - You have installed the OADP Operator. **Procedure** - Configure the `disableFsBackup` field in the DPA as shown in the following example: ```yaml apiVersion: oadp.openshift.io/v1alpha1 kind: DataProtectionApplication metadata: name: ts-dpa namespace: openshift-adp spec: backupLocations: - velero: credential: key: cloud name: cloud-credentials default: true objectStorage: bucket: prefix: velero provider: gcp configuration: nodeAgent: enable: true uploaderType: kopia velero: defaultPlugins: - csi - gcp - openshift disableFsBackup: true ``` where: `nodeAgent` : Specifies to enable the node agent in the DPA. `disableFsBackup` : Specifies to set the `disableFsBackup` field to `true`. **Verification** 1. Verify that the node agent security context is set to run as non-root and the root file system is `readOnly` by running the following command: ```terminal $ oc get daemonset node-agent -o yaml ``` The example output is as following: ```yaml apiVersion: apps/v1 kind: DaemonSet metadata: ... name: node-agent namespace: openshift-adp ... spec: ... template: metadata: ... spec: containers: ... securityContext: allowPrivilegeEscalation: false capabilities: drop: - ALL privileged: false readOnlyRootFilesystem: true ... nodeSelector: kubernetes.io/os: linux os: name: linux restartPolicy: Always schedulerName: default-scheduler securityContext: runAsNonRoot: true seccompProfile: type: RuntimeDefault serviceAccount: velero serviceAccountName: velero .... ``` where: `allowPrivilegeEscalation` : Specifies that the `allowPrivilegeEscalation` field is false. `privileged` : Specifies that the `privileged` field is false. `readOnlyRootFilesystem` : Specifies that the root file system is read-only. `runAsNonRoot` : Specifies that the node agent is run as a non-root user. ## Configuring repository maintenance {#oadp-configuring-repository-maintenance_installing-oadp-aws} OADP repository maintenance is a background job, you can configure it independently of the node agent pods. This means that you can schedule the repository maintenance pod on a node where the node agent is or is not running. You can use the repository maintenance job affinity configurations in the `DataProtectionApplication` (DPA) custom resource (CR) only if you use Kopia as the backup repository. You have the option to configure the load affinity at the global level affecting all repositories. Or you can configure the load affinity for each repository. You can also use a combination of global and per-repository configuration. **Prerequisites** - You must be logged in as a user with `cluster-admin` privileges. - You have installed the OADP Operator. - You have configured the DPA CR. **Procedure** - Configure the `loadAffinity` object in the DPA spec by using either one or both of the following methods: - Global configuration: Configure load affinity for all repositories as shown in the following example: ```yaml ... spec: configuration: repositoryMaintenance: global: podResources: cpuRequest: "100m" cpuLimit: "200m" memoryRequest: "100Mi" memoryLimit: "200Mi" loadAffinity: - nodeSelector: matchLabels: label.io/gpu: 'no' matchExpressions: - key: label.io/location operator: In values: - US - EU ``` where: `repositoryMaintenance` : Specifies the `repositoryMaintenance` object as shown in the example. `global` : Specifies the `global` object to configure load affinity for all repositories. - Per-repository configuration: Configure load affinity per repository as shown in the following example: ```yaml ... spec: configuration: repositoryMaintenance: myrepositoryname: loadAffinity: - nodeSelector: matchLabels: label.io/cpu: 'yes' ``` where: `myrepositoryname` : Specifies the `repositoryMaintenance` object for each repository. ## Configuring Velero load affinity {#oadp-configuring-velero-load-affinity_installing-oadp-aws} With each OADP deployment, there is one Velero pod and its main purpose is to schedule Velero workloads. To schedule the Velero pod, you can use the `velero.podConfig.nodeSelector` and the `velero.loadAffinity` objects in the `DataProtectionApplication` (DPA) custom resource (CR) spec. Use the `podConfig.nodeSelector` object to assign the Velero pod to specific nodes. You can also configure the `velero.loadAffinity` object for pod-level affinity and anti-affinity. The OpenShift scheduler applies the rules and performs the scheduling of the Velero pod deployment. **Prerequisites** - You must be logged in as a user with `cluster-admin` privileges. - You have installed the OADP Operator. - You have configured the DPA CR. **Procedure** - Configure the `velero.podConfig.nodeSelector` and the `velero.loadAffinity` objects in the DPA spec as shown in the following examples: - `velero.podConfig.nodeSelector` object configuration: ```yaml ... spec: configuration: velero: podConfig: nodeSelector: some-label.io/custom-node-role: backup-core ``` - `velero.loadAffinity` object configuration: ```yaml ... spec: configuration: velero: loadAffinity: - nodeSelector: matchLabels: label.io/gpu: 'no' matchExpressions: - key: label.io/location operator: In values: - US - EU ``` ## Configuring a priority class for node agent and Velero pods {#oadp-configuring-priority-class_installing-oadp-aws} Configure a `priorityClassName` field for the node agent and Velero pods by editing the `DataProtectionApplication` (DPA) custom resource (CR). This helps you ensure that the Kubernetes scheduler prioritizes OADP pods during resource contention. By setting a priority class, you ensure that critical OADP pods are scheduled first after events such as worker node outages, when user workloads might otherwise consume available resources. **Prerequisites** - The OADP Operator is installed. - A DPA CR is configured. - A `PriorityClass` object is created in the cluster. **Procedure** 1. In your DPA CR, configure the `priorityClassName` field for the node agent, Velero, or both, in the `podConfig` object as shown in the following example: ```yaml apiVersion: oadp.openshift.io/v1alpha1 kind: DataProtectionApplication metadata: name: namespace: openshift-adp spec: # ... configuration: nodeAgent: enable: true uploaderType: kopia podConfig: priorityClassName: velero: podConfig: priorityClassName: ``` where: `` : Specifies the name of an existing `PriorityClass` to apply to the pods managed by this `podConfig` object. For example, `system-cluster-critical`. 2. Apply the `DataProtectionApplication` CR by running the following command: ```terminal $ oc apply -f ``` **Verification** 1. Verify that the node agent daemon set pods have the correct priority class by running the following command: ```terminal $ oc get pods -n openshift-adp -l name=node-agent -o jsonpath='{range .items[*]}{.metadata.name}{" "}{.spec.priorityClassName}{"\n"}{end}' ``` ```terminal node-agent-xxxxx node-agent-yyyyy ``` 2. Verify that the Velero deployment pods have the correct priority class by running the following command: ```terminal $ oc get pods -n openshift-adp -l app.kubernetes.io/name=velero -o jsonpath='{range .items[*]}{.metadata.name}{" "}{.spec.priorityClassName}{"\n"}{end}' ``` ```terminal velero-xxxxx ``` ## Overriding the imagePullPolicy setting in the DPA {#oadp-configuring-imagepullpolicy_installing-oadp-aws} In OADP 1.4.0 or earlier, the Operator sets the `imagePullPolicy` field of the Velero and node agent pods to `Always` for all images. In OADP 1.4.1 or later, the Operator first checks if each image has the `sha256` or `sha512` digest and sets the `imagePullPolicy` field accordingly: - If the image has the digest, the Operator sets `imagePullPolicy` to `IfNotPresent`. - If the image does not have the digest, the Operator sets `imagePullPolicy` to `Always`. You can also override the `imagePullPolicy` field by using the `spec.imagePullPolicy` field in the Data Protection Application (DPA). **Prerequisites** - You have installed the OADP Operator. **Procedure** - Configure the `spec.imagePullPolicy` field in the DPA as shown in the following example: ```yaml {title="Example Data Protection Application"} apiVersion: oadp.openshift.io/v1alpha1 kind: DataProtectionApplication metadata: name: test-dpa namespace: openshift-adp spec: backupLocations: - name: default velero: config: insecureSkipTLSVerify: "true" profile: "default" region: s3ForcePathStyle: "true" s3Url: credential: key: cloud name: cloud-credentials default: true objectStorage: bucket: prefix: velero provider: aws configuration: nodeAgent: enable: true uploaderType: kopia velero: defaultPlugins: - openshift - aws - kubevirt - csi imagePullPolicy: Never ``` where: `imagePullPolicy` : Specifies the value for `imagePullPolicy`. In this example, the `imagePullPolicy` field is set to `Never`. ## Enabling CSI in the DataProtectionApplication CR {#oadp-enabling-csi-dpa_installing-oadp-aws} 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: ```yaml apiVersion: oadp.openshift.io/v1alpha1 kind: DataProtectionApplication ... spec: configuration: velero: defaultPlugins: - openshift - csi ``` where: `csi` : Specifies the `csi` default plugin. ## Disabling the node agent in DataProtectionApplication {#oadp-about-disable-node-agent-dpa_installing-oadp-aws} If you are not using `Restic`, `Kopia`, or `DataMover` for your backups, you can disable the `nodeAgent` field in the `DataProtectionApplication` custom resource (CR). Before you disable `nodeAgent`, ensure the OADP Operator is idle and not running any backups. **Procedure** 1. To disable the `nodeAgent`, set the `enable` flag to `false`. See the following example: ```yaml {title="Example DataProtectionApplication CR"} # ... configuration: nodeAgent: enable: false uploaderType: kopia # ... ``` where: `enable` : Enables the node agent. 2. To enable the `nodeAgent`, set the `enable` flag to `true`. See the following example: ```yaml {title="Example DataProtectionApplication CR"} # ... configuration: nodeAgent: enable: true uploaderType: kopia # ... ``` where: `enable` : Enables the node agent. You can set up a job to enable and disable the `nodeAgent` field in the `DataProtectionApplication` CR. For more information, see "Running tasks in pods using jobs". **Additional resources** {._additional-resources} - [Installing the OADP Operator](/openshift-docs-markdown/backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator#oadp-installing-operator-doc) - [Velero 1.16](https://velero.io/docs/v1.16/) - [Using Operator Lifecycle Manager in disconnected environments](/openshift-docs-markdown/disconnected/using-olm#olm-restricted-networks) - [Installing the Data Protection Application with the `kubevirt` and `openshift` plugins](/openshift-docs-markdown/backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt#oadp-installing-dpa_installing-oadp-kubevirt) - [Running tasks in pods using jobs](/openshift-docs-markdown/nodes/jobs/nodes-nodes-jobs#nodes-nodes-jobs)