CLI reference for using DRS on Control Plane
You can use the Data Recovery Service (DRS) CDP CLI commands to backup and restore resources and data in the Control Plane of CDP Private Cloud Data Services.
The following table provides the CDP CLI options to backup and restore the Control Plane:
| CDP CLI options | Description |
|---|---|
| create-backup | Creates a backup and archives it as a ZIP file on the same cluster.
The item-name is optional for Control Plane data recovery service. You can provide a unique backup name, so that you can identify the backup easily during restore. When you run this command, the service initiates the backup process and returns the assigned ID or backupCrn for the backup. |
| delete-backup | Deletes the specified backup (backupCrn) permanently. |
| describeAutoBackupPolicy | Describes the automatic backup policy. You can view the DRS automatic backup and the selected periods (hourly, daily, weekly) and its backup retain count. For each control plane, only one automatic-backup cron job can be scheduled in the DRS namespace. |
| describe-backup | Shows the progress of the current status of the specified backupCrn (backup event). |
| describe-restore | Shows the progress of the current status of the specified restoreCrn (restore event). |
| get-logs | Returns logs about the specified backup, restore, or delete job and
automatically creates a diagnostic bundle. You can download the bundle to your machine to analyze an issue or share it with Cloudera Support for further troubleshooting. |
| list-backup-entities | Lists the entities that you can backup, which includes the Control Plane namespace and its corresponding vault namespace (if embedded). |
| list-backups | Lists the successful backup jobs of backupCrn.
You can filter the backup jobs using the NOT_STARTED; IN_PROGRESS; COMPLETED; PARTIALLY_FAILED; and FAILED job states. |
| list-restores | Lists the past restore events. |
| restore-backup | Restores the backup of the specified backupCrn.
During the restore event, the existing Kubernetes resources and data are
deleted and then recreated using the information in the backup. When you run the command, the service initiates the restore event and returns a restoreCrn value. |
| updateAutoBackupPolicy | Creates or updates the current existing automatic backup policy. The
automatic backup cron job starts with the default backup policy first.
You can enable or disable DRS automatic backups. You can also add, delete, and update the period (hourly, daily, weekly), and its backup retain count. |
For more information about the data recovery service CDP CLI options for Control Plane, see CDP CLI drscp.
