Creating a snapshot of a Cloud Pak for Data instance

If IBM Cloud Pak® for Data is installed on Ceph® Container Storage Interface (CSI) volumes, you can create a snapshot of the entire Cloud Pak for Data instance.

Before you begin

To create snapshots, you must meet the following storage requirements.

  • Red Hat® OpenShift® Data Foundation 4.6
  • Cloud Pak for Data was installed by using OpenShift Data Foundation storage classes

About this task

Permissions that you need for this task
Log on as a user with cluster administrator rights.
Best practice: You can run the commands in this task exactly as written if you set up environment variables. For instructions, see Setting up installation environment variables.

Ensure that you source the environment variables before you run the commands in this task.

When backup commands are run, some pods remain in a Running state. These running pods do not affect the backup process, and you do not need to manually shut them down.

For more information about the OADP backup and restore utility, including a list of commands that you can run, see the cpd-cli oadp reference documentation.

Note: The storage provider that you use to store backups might limit the number of snapshots that you can take per volume. For more information, consult your storage provider documentation.

Procedure

  1. Create a backup of the entire Cloud Pak for Data instance.

    You can specify multiple projects (namespaces) in --include-namespaces, separated by commas (,). All projects that contain the Cloud Pak for Data deployment must be specified in the following command:

    cpd-cli oadp backup create <backup_name> \
    --include-namespaces=${PROJECT_CPD_INSTANCE} \
    --exclude-resources='Event,Event.events.k8s.io' \
    --snapshot-volumes \
    --log-level=debug \
    --verbose
  2. Check the status of the backup:
    cpd-cli oadp backup status <backup_name> \
    --details

    In the output, check that the Phase is Completed, and that the Resource List contains a VolumeSnapshot for each PVC.

  3. To view a list of existing backups, run the following command:
    cpd-cli oadp backup ls
  4. To view backup logs, run the following command:
    cpd-cli oadp backup logs <backup_name>
  5. Optional: To delete a backup for cleanup purposes, run the following command:
    cpd-cli oadp backup delete <backup_name>