c8-backup

A CLI tool to automate backup and restore of Camunda Platform 8 deployments.

Usage

Warning This tool is experimental and not safe for use yet! Running it can result in complete dataloss.

Download a pre-built binary from the latest release or build from sources with shell cargo install c8-backup

Currently, this tool is meant to run locally. It will connect to your current kubernetes context and tries to find C8 components there.

Taking backups

The backup command starts without any additional confirmation and will take the following steps: 1. Take a backup of Operate 2. Pause Zeebe exporting 3. Take a backup of exported Zeebe records 4. Take a backup of Zeebe 5. Resume Zeebe exporting

Resuming exporting is crucial and this command tries to resume exporting if any error occurs while taking a backup but you should manually confirm that exporting resumed, for example by following the log output.

```shell $ c8-backup backup c8backup::backup::backup{} c8backup::backup::trybackup{newbackup=Backup { backupid: "1683126300" }} c8backup::backup::backupoperate{newbackup=Backup { backupid: "1683126300" }} 226ms INFO c8backup::backup Started backup 495ms INFO c8backup::backup Checking again in 5 seconds, backup.state=InProgress 5867ms INFO c8backup::backup Checking again in 5 seconds, backup.state=InProgress 11262ms INFO c8backup::backup Checking again in 5 seconds, backup.state=InProgress 16582ms INFO c8backup::backup Backup completed

c8_backup::backup::pause_exporting{}

c8_backup::backup::backup_zeebe_export{new_backup=Backup { backup_id: "1683126300" }}

c8_backup::backup::backup_zeebe{new_backup=Backup { backup_id: "1683126300" }}
  331ms  INFO c8_backup::backup Started backup
  764ms  INFO c8_backup::backup Checking again in 5 seconds, backup.state=InProgress
  6232ms  INFO c8_backup::backup Backup completed

c8_backup::backup::resume_exporting{}

```

Restoring backups

The restore commands starts without any additional confirmation and will take the following steps: 1. Find the latest backup from Zeebe and Operate 2. Stop Zeebe and Operate 3. Delete all indices from Elasticsearch 4. Restore Elasticsearch indices based on backups 5. Delete all Zeebe data 6. Restore Zeebe data based on backup 7. Start Zeebe and Operate

```shell $ c8-backup restore c8backup::restore::restore{} c8backup::restore::findnewestbackup{} 1461ms INFO c8_backup::restore Using backup 1683126300

c8backup::restore::shutdownapps{} 369ms INFO c8backup::restore Shut down ccs23-dev-operate 424ms INFO c8backup::restore Shut down ccs23-dev-zeebe-gateway 471ms INFO c8_backup::restore Shut down ccs23-dev-zeebe

c8backup::restore::deleteindices{} 534ms INFO c8backup::restore Deleted index operate-incident-8.2.0 861ms INFO c8backup::restore Deleted index operate-import-position-8.2.0 1189ms INFO c8backup::restore Deleted index operate-batch-operation-1.0.0 1443ms INFO c8backup::restore Deleted index operate-event-8.1.0 1731ms INFO c8backup::restore Deleted index operate-decision-1.0.0 2026ms INFO c8backup::restore Deleted index operate-operation-8.2.0 2284ms INFO c8backup::restore Deleted index operate-migration-steps-repository-1.1.0 2607ms INFO c8backup::restore Deleted index operate-variable-8.2.0 2913ms INFO c8backup::restore Deleted index operate-web-session-1.1.0 3242ms INFO c8backup::restore Deleted index operate-decision-instance-8.2.0 3509ms INFO c8backup::restore Deleted index operate-decision-requirements-1.0.0 3825ms INFO c8backup::restore Deleted index operate-process-8.1.8 4112ms INFO c8backup::restore Deleted index operate-list-view-8.1.0 4453ms INFO c8backup::restore Deleted index operate-flownode-instance-8.2.0 4806ms INFO c8backup::restore Deleted index operate-sequence-flow-8.2.0 5074ms INFO c8backup::restore Deleted index operate-metric-1.0.0 5381ms INFO c8backup::restore Deleted index operate-user-1.2.0

c8backup::restore::restoreindices{backup=Backup { id: 1683126300, snapshots: ["camundazeeberecords1683126300", "camundaoperate16831263008.2.3part1of6", "camundaoperate16831263008.2.3part2of6", "camundaoperate16831263008.2.3part3of6", "camundaoperate16831263008.2.3part4of6", "camundaoperate16831263008.2.3part5of6", "camundaoperate16831263008.2.3part6of6"] }} 20316ms INFO c8backup::restore Restored snapshot camundazeeberecords1683126300 22038ms INFO c8backup::restore Restored snapshot camundaoperate16831263008.2.3part1of6 27386ms INFO c8backup::restore Restored snapshot camundaoperate16831263008.2.3part2of6 27915ms INFO c8backup::restore Restored snapshot camundaoperate16831263008.2.3part3of6 37721ms INFO c8backup::restore Restored snapshot camundaoperate16831263008.2.3part4of6 38154ms INFO c8backup::restore Restored snapshot camundaoperate16831263008.2.3part5of6 41046ms INFO c8backup::restore Restored snapshot camundaoperate16831263008.2.3part6of_6

c8backup::restore::deletezeebedata{backup=Backup { id: 1683126300, snapshots: ["camundazeeberecords1683126300", "camundaoperate16831263008.2.3part1of6", "camundaoperate16831263008.2.3part2of6", "camundaoperate16831263008.2.3part3of6", "camundaoperate16831263008.2.3part4of6", "camundaoperate16831263008.2.3part5of6", "camundaoperate16831263008.2.3part6of6"] }} 266ms INFO c8backup::restore Deleting data of data-ccs23-dev-zeebe-0 293ms INFO c8backup::restore Deleting data of data-ccs23-dev-zeebe-1 323ms INFO c8backup::restore Deleting data of data-ccs23-dev-zeebe-2 14185ms INFO c8backup::restore Deleted data of data-ccs23-dev-zeebe-0 16215ms INFO c8backup::restore Deleted data of data-ccs23-dev-zeebe-1 16318ms INFO c8backup::restore Deleted data of data-ccs23-dev-zeebe-2

c8backup::restore::restorezeebedata{backup=Backup { id: 1683126300, snapshots: ["camundazeeberecords1683126300", "camundaoperate16831263008.2.3part1of6", "camundaoperate16831263008.2.3part2of6", "camundaoperate16831263008.2.3part3of6", "camundaoperate16831263008.2.3part4of6", "camundaoperate16831263008.2.3part5of6", "camundaoperate16831263008.2.3part6of6"] }} 131ms INFO c8backup::restore Restoring data of data-ccs23-dev-zeebe-0 162ms INFO c8backup::restore Restoring data of data-ccs23-dev-zeebe-1 194ms INFO c8backup::restore Restoring data of data-ccs23-dev-zeebe-2 22045ms INFO c8backup::restore Restored data of data-ccs23-dev-zeebe-0 23196ms INFO c8backup::restore Restored data of data-ccs23-dev-zeebe-1 23295ms INFO c8backup::restore Restored data of data-ccs23-dev-zeebe-2

c8backup::restore::startapps{} 0ms INFO c8backup::restore Starting apps 27ms INFO c8backup::restore Started ccs23-dev-operate 53ms INFO c8backup::restore Started ccs23-dev-zeebe-gateway 83ms INFO c8backup::restore Started ccs23-dev-zeebe ```

Current Status

Features: - [ ] Take backups - [x] Restore backups - [ ] Dry runs

Components: - [x] Zeebe - [x] Operate - [ ] Tasklist - [ ] Optimize

Deployments: - [x] Remote [Camunda Platform 8 Helm] installation (running locally, connecting through the current kubernetes context). - [ ] Local [Camunda Platform 8 Helm] installation (running as a pod inside the cluster).