oadp

Back up and restore Cloud Pak for Data clusters with the OpenShift® APIs for Data Protection (oadp) utility.

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 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.12+. The OADP 1.3 operator is available on x86_64, ppc64le, and s390x hardware.
  • The cpdbr-velero-plugin is available on x86_64, ppc64le, and s390x hardware.
  • Ceph® CSI snapshots are available for OCS 4.12+.
Client

Prerequisites

Client

  1. Before you run any cpd-cli commands, download the cpd-cli 14.1.3 command-line utility for your operating system and IBM® Software Hub edition. For more information, see Installing the IBM Software Hub command-line interface (cpd-cli).

  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 you instantiate a Velero instance.

Security and roles

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

Commands