backup-restore

Extended description

The backup-restore command is a data backup and restore utility for Cloud Pak for Data that can be used as an augmentation or helper utility to the Cloud Pak for Data add-on services' backup and restore procedure.

Portworx volumes

Portworx snapshots are atomic, point-in-time snapshots. Snapshots can be taken while applications are running, and typically take less time to perform than copying files. During volume restoration, pods cannot reference PVCs. The utility scales down deployments and StatefulSets with PVCs during a restore from snapshot. Any jobs that reference PVCs must be manually cleaned up before restore.

Volumes for any storage class, offline volume backup and restore

For data consistency, the utility quiesces services or scales down deployments and StatefulSets with PVCs before it runs backups or restores. A PersistentVolumeClaim or S3 compatible object storage can be used to store backups.

The backup-restore command supports volume backup and restore only. It does not provide application level backup and restore that re-creates Kubernetes resources (such as ConfigMaps, secrets, PVCs, PVs, pods, deployments, and StatefulSets). A typical use case is backing up and restoring all volumes in the same namespace, if the same Kubernetes objects still exist. Your service might need to provide scripts to handle backup and restore scenarios that are applicable to your service.

Prerequisites

1. Before you run any cpd-cli commands, ensure that you downloaded the cpd-cli 13.0.4 command-line utility for your operating system and Cloud Pak for Data edition. For more information, see Installing the Cloud Pak for Data 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. Set up a shared volume PVC or PV.
4. Set up a Kubernetes secret for repository 1 oc 3.11+.
5. Confirm other prerequisites for snapshot-related commands.
   • Portworx 2.3.4+ (Enterprise)
   • Stork 2.3.2+
6. When Cloud Pak for Data is installed on NFS, the NFS storage must be configured with no_root_squash for volume-backup with restic.

Required permissions

The backup-restore command requires cluster administrator or similar roles that are able to create, read, write, and delete access Stork CRDs and the other Kubernetes resources (such as deployments, StatefulSets, CronJobs, jobs, ReplicaSets, ConfigMaps, secrets, pods, namespaces, PVCs, and PVs).

Commands