cpd-cli oadp

The OpenShift® APIs for Data Protection (oadp) utility provides backup and restore features for Cloud Pak for Data clusters.

Extended description

oadp is a command line interface (CLI) utility for IBM® Cloud Pak for Data that can run backup and restore between Cloud Pak for Data clusters.

The oadp backup utility requires the following components.

  • oadp/Velero (Red Hat® OpenShift API for Data Protection) and its default plug-ins.
  • The custom Velero plug-in cpdbr-velero-plugin.
  • The cpd-cli oadp CLI, which is included as a part of the cpd-cli utility.

OADP, Velero, and the default openshift-velero-plugin are open source projects that are used to backup Kubernetes resources and data volumes on OpenShift. The custom cpdbr-velero-plugin implements more Velero backup and restore actions for OpenShift-specific resource handling. The cpd-cli oadp command runs backup and restore operations by calling Velero client APIs (similar to the Velero CLI). In addition, the command starts backup and restore hooks to quiesce and unquiesce services.

System requirements

Cloud Pak for Data cluster
  • OADP is available for OCP 4.6+. The OADP 0.5.x Community Operator and OADP 1.0 Operator are available for Linux x86_64.
  • The cpdbr-velero-plugin is available for Linux x86_64 and ppc64le.
  • Ceph CSI snapshots are available for OCS 4.6+.
Client

Prerequisites

Client

  1. Before you run any cpd-cli commands, ensure that you downloaded the cpd-cli 11.3.0 command line utility for your operating system and Cloud Pak for Data edition from: https://github.com/IBM/cpd-cli/releases.

  2. The Red Hat OpenShift client oc is included in the PATH and has access to the Cloud Pak for Data cluster.
  3. podman must be installed on a client system with access to the cluster. podman is required to install the cpdbr-velero-plugin.
  4. When Cloud Pak for Data is installed on NFS, the NFS storage must be configured with no_root_squash.
Object storage
  1. Access to object storage is required. It is used by OADP/Velero to store docker images, Kubernetes resource definitions, and restic backups.
  2. A bucket must be created in object storage. The bucket name is specified in the Velero custom resource when instantiating a Velero instance.

Security and roles

The cpd-cli oadp command requires cluster administrator or similar roles.

Commands

Command Description
backup Work with Cloud Pak for Data backups.
backup create Create a snapshot of the entire Cloud Pak for Data instance (when installed on Ceph Container Storage Interface (CSI) volumes) or create a Restic backup of an entire Cloud Pak for Data instance on an S3-compatible object store.
backup delete Delete a snapshot or Restic backup.
backup list View a list of existing volume backups and check that backups are available and completed with no errors.
backup logs View backup logs.
backup posthooks Run backup post-hooks.
backup prehooks Run backup pre-hooks.
backup status Check the backup status.
backup-location Work with backup storage locations.
backup-location create Create a backup storage location.
backup-location delete Delete a backup storage location.
backup-location list List backup storage locations.
checkpoint Work with Cloud Pak for Data checkpoint.
checkpoint create Create a Cloud Pak for Data checkpoint.
checkpoint list List Cloud Pak for Data checkpoints.
checkpoint reset Reset Cloud Pak for Data checkpoint.
client Work with client-related commands.
client config Work with client-related configuration commands.
client config get Retrieve configuration values.
client config set Set configuration values.
install Install the Cloud Pak for Data Openshift APIs for Data Protection (OADP) backup REST service (cdpbr-api).
reset Reset the oadp utility.
restore Work with Cloud Pak for Data restores.
restore create Restore a snapshot of the entire Cloud Pak for Data instance (when installed on Ceph Container Storage Interface (CSI) volumes) or restore a Restic backup of an entire Cloud Pak for Data instance on an S3-compatible object store.
restore delete Delete a snapshot or Restic restore.
restore list View a list of existing volume restores and check that restores are available and completed with no errors.
restore logs View restore logs.
restore posthooks Run restore post-hooks.
restore preworkloadhooks Run restore pre-workload hooks.
restore status Check the restore status.
snapshot-location Work with snapshot locations.
snapshot-location create Create a volume snapshot location.
snapshot-location list List volume snapshot locations.
uninstall Uninstall the Cloud Pak for Data Openshift APIs for Data Protection (OADP) backup REST service (cdpbr-api).
version Display the oadp command version information.