Cloudera Docs

Create, restore, and manage backups of Control Plane

The Backup and Restore Manager in the CDP Private Cloud Data Services Management Console helps you to backup and restore Kubernetes namespaces and resources on Embedded Container Service (ECS) and OpenShift Container Platform (OCP). You can view logs to troubleshoot an issue, and delete the backups if necessary. Alternatively, you can use CDP CLI to accomplish these tasks.

The following sections show how to create a backup of the Kubernetes namespaces and resources in the Control Plane, restore a backup, delete a backup, view logs for an event, and how to use CDP CLI commands to create and restore a backup.

Creating backup of Control Plane

The Backup and Restore Manager in the CDP Private Cloud Data Services Management Console helps you to back up Kubernetes namespaces and resources on Embedded Container Service (ECS) and OpenShift Container Platform (OCP). This topic shows how to create a backup of the Kubernetes namespaces and resources in the Control Plane.

Ensure that the following prerequisites are complete:
  • You must have the PowerUser role.
  • For OCP, ensure that a VolumeSnapshotClass is installed with a CSI driver that matches the CSI driver for the storage class used.
When you create a backup of the Control Plane, Data Recovery Service (DRS) initiates the backup event or job for the chosen backup entity, assigns an ID called backupCrn to the backup event, and creates a backup of the persistent volume claim (PVC) snapshots of the Control Plane namespaces and the backup event's PVC. CRN or Customer Resource Number is the Cloudera-specific identifier provided for an event or job.
  1. Go to the CDP Private Cloud Data Services Management Console > Dashboard > Backup Overview section.
    The sample image shows the View Details option in the Backup Overview section on the Management Console Dashboard page.
  2. Click Create Backup in the Backup Overview section to create the first backup.
    The sample image shows the Create Backup option to create the first backup in the Backup Overview section.
  3. Enter a unique Backup Name and choose the Backup Entity that you want to back up in the Create Backup modal window, and then click Create.
    The sample image shows the Create Backup modal window where you enter a backup name, choose the backup entity, and click create to create a backup.
  4. DRS initiates the backup event and generates a backupCRN which is an automatically assigned ID for the backup event.
    The backup event appears in the Backup Overview section.
    The sample image shows the columns that appear when backups are available in the Backup Overview section.
  5. Click View Details. The Backup and Restore Manager page appears.
    The sample image shows the backup CRN as CRN on the Backups tab in Backup and Restore Manager.
  6. The backupCRN appears as a CRN on the Backup and Restore Manager page that you can click to view the backup event details.
    The sample image shows the backup CRN as CRN on the Backups tab in Backup and Restore Manager.
  7. For subsequent backups, click New Backup on the Backup and Restore Manager page.
    The sample image shows the backup CRN as CRN on the Backups tab in Backup and Restore Manager.
  8. Click the CRN to view more details about it on the Backup [***BACKUP NAME***] modal window. For example, the following image shows the Backup cp-backup2 modal window.
    The sample image shows the backup CRN as CRN on the Backups tab in Backup and Restore Manager.

Restoring a backup of Control Plane

The Backup and Restore Manager in the CDP Private Cloud Data Services Management Console helps you to restore Kubernetes namespaces and resources on Embedded Container Service (ECS) and OpenShift Container Platform (OCP). When you start the restore a backup, Data Recovery Service (DRS) initiates the restore event based on the chosen backup, assigns an ID called restoreCrn to the restore event, deletes the existing resources and data, and restores the resources and data from the backup.

Ensure that the following prerequisites are complete:
  • You must have the PowerUser role.
  • For OCP, ensure that a VolumeSnapshotClass is installed with a CSI driver that matches the CSI driver for the storage class used.
  1. Go to the CDP Private Cloud Data Services Management Console > Dashboard > Backup Overview section.
  2. Click View Details.
    The sample image shows the backup CRN as CRN on the Backups tab in Backup and Restore Manager.
  3. Go to the Backup and Restore Manager > Backups tab.
  4. Click Actions > Restore, and then click OK in the Restore modal window to acknowledge that you want to restore the backup.
    The sample image shows the Restore option on the Backup details modal window.
    The sample image shows the modal window where you acknowledge to restore the backup.
  5. Alternatively, click the CRN of the required backup, click Restore on the Backup [***NAME OF BACKUP***] modal window, and then click OK to acknowledge that you want to restore the backup.
    The sample image shows the Restore option on the Backup details modal window.
  6. Go to the Restores tab to view the CRN for the restore event and other details about the restore event.
    The sample image shows the Restore Details modal window after you click the CRN for a restore event on the Restores tab.
  7. Click the CRN for a restore event to see its details on the Restore Details modal window.
    The sample image shows the Restore Details modal window after you click the CRN for a restore event on the Restores tab.

Deleting a backup of Control Plane

The Backup and Restore Manager in the CDP Private Cloud Data Services Management Console helps you to backup and restore Kubernetes namespaces and resources on Embedded Container Service (ECS) and OpenShift Container Platform (OCP). You can delete the backups, if necessary.

You must have the PowerUser role.
  1. Go to the CDP Private Cloud Data Services Management Console > Dashboard > Backup Overview section.
  2. Click View Details.
    The sample image shows the backup CRN as CRN on the Backups tab in Backup and Restore Manager.
  3. Go to the Backup and Restore Manager > Backups tab.
  4. Click Actions > Delete, and then click OK in the Delete modal window to acknowledge that you want to delete the backup.
    The sample image shows the Restore Details modal window after you click the CRN for a restore event on the Restores tab.
    The sample image shows the Restore Details modal window after you click the CRN for a restore event on the Restores tab.
  5. Alternatively, click the CRN of the required backup. Click Delete on the Backup [***NAME OF BACKUP***] modal window, and then click OK to acknowledge that you want to delete the backup.
    The sample image shows the Restore Details modal window after you click the CRN for a restore event on the Restores tab.

Viewing logs of a backup of Control Plane

The Backup and Restore Manager in the CDP Private Cloud Data Services Management Console helps you to backup and restore Kubernetes namespaces and resources on Embedded Container Service (ECS) and OpenShift Container Platform (OCP). You can view the logs of backups to use during troubleshooting issues.

You must have the PowerUser role.
  1. Go to the CDP Private Cloud Data Services Management Console > Dashboard > Backup Overview section.
  2. Click View Details.
    The sample image shows the backup CRN as CRN on the Backups tab in Backup and Restore Manager.
  3. Go to the Backup and Restore Manager > Backups tab.
  4. Click Actions > Logs for the required backup.
    The sample image shows the Restore Details modal window after you click the CRN for a restore event on the Restores tab.
  5. Click the Logs tab on the modal window.
    The sample image shows the Restore Details modal window after you click the CRN for a restore event on the Restores tab.
  6. Alternatively, you can click the CRN for a backup event on the Backups tab, or click the CRN for a restore event on the Restores tab to open the modal window to view the logs for the event.

Using CDP CLI to back up Control Plane and restoring it

You can use CDP CLI commands to back up and restore Control Plane.

Ensure that the following prerequisites are complete:
  • You must have the PowerUser role.
  • For OCP, ensure that a VolumeSnapshotClass is installed with a CSI driver that matches the CSI driver for the storage class used.

To set up a CDP client to run the CDP CLI commands, see CDP Private Cloud CLI.

The following sample CDP CLI options show how to create a backup, restore or delete it, and monitor the progress of the events:
  1. Login to the CDP CLI setup.
  2. Create a backup of Control Plane using the create-backup CDP CLI option.
    The following sample snippet creates a backup named Backup 2.
    cdp.sh --form-factor private --endpoint-url https://console-cp1.apps.shared-os-01.kcloud.cloudera.com drscp create-backup --backup-name "Backup 2"
  3. Track the progress of the current status of the specified backupCrn (backup event) using the describe-backup CDP CLI option.
    The following sample snippet output shows the current status of the crn:altus:drs:us-west-1:18be-4c75-8c7f-f32e697dba4a:backup:91193c4f-45f0-949c-13e232f14c9e backupCrn.
    cdp.sh --no-verify-tls --endpoint-url https://console-cdp.apps.drs31-1.vpc.cloudera.com --no-verify-tls --form-factor private drscp describe-backup --backup-crn crn:altus:drs:us-west-1:18be-4c75-8c7f-f32e697dba4a:backup:91193c4f-45f0-949c-13e232f14c9e
  4. List all the backups using the list-backup CDP CLI option.
    The following sample snippet output lists all the available backups.
    cdp.sh --no-verify-tls --endpoint-url https://console-cdp.apps.lh-lp1-1.vpc.cloudera.com --no-verify-tls --form-factor private drscp list-backup
  5. Restore a specific backup, using its CRN, with the restore-backup CDP CLI option.
    The following sample snippet restores the backup of crn:altus:drs:us-west-1:88d84e3c-4c3e-9903-6c388a689690:backup:aebe-96d7-b79d10b64183 CRN.
    cdp.sh --form-factor private --no-verify-tls --endpoint-url https://console-ocp1.apps.shared-os-01.kcloud.cloudera.com drscp restore-backup --backup-crn crn:altus:drs:us-west-1:88d84e3c-4c3e-9903-6c388a689690:backup:aebe-96d7-b79d10b64183
  6. Track the current status of the specified restoreCrn (restore event) using the describe-restore CDP CLI option.
    The following sample snippet output shows the current status of the crn:altus:drs:us-west-1:a70c917a-4be8-927c-d36f3f7db2de:restore:c3b34532-4391-b62d-3f471fae5a40 restoreCrn:
    cdp.sh --form-factor private --no-verify-tls --endpoint-url https://console-cp1.apps.shared-os-01.kcloud.cloudera.com drscp describe-restore --restore-crn crn:altus:drs:us-west-1:a70c917a-4be8-927c-d36f3f7db2de:restore:c3b34532-4391-b62d-3f471fae5a40
Explore all the available CDP CLI options to backup and restore Control Plane and CDW in CDP CLI options for Control Plane namespaces and CDP CLI options for Cloudera Data Warehouse (CDW).