Skip to main content

Backup and restore

note

This API is subject to change.

You can use the backup feature of Camunda 8 Self-Managed to regularly back up the state of all of its components (Zeebe, Operate, Tasklist, and Optimize) without any downtime. In case of failures that lead to data loss, you can recover the cluster from a backup.

A backup of Camunda 8 consists of a backup of Zeebe, Operate, Tasklist, Optimize, and the backup of exported Zeebe records in Elasticsearch. Since the data of these applications are dependent on each other, it is important that the backup is consistent across all components. Therefore, you must take the backup of a Camunda 8 cluster as a whole. The backups of individual components which are taken independently may not form a consistent recovery point. To ensure a consistent backup, follow the process described below.

Configure backup store​

To take backups, you must first configure backup storage.

Operate, Tasklist, and Optimize use Elasticsearch as backend storage and use the snapshot feature of Elasticsearch for backing up their state. Therefore, you must configure a snapshot repository in Elasticsearch.

Zeebe stores its backup to an external storage and must be configured before the cluster is started. Refer to Zeebe backup configuration for additional information.

Backup process​

The backup of each component and the backup of a Camunda 8 cluster is identified by an id. This means a backup x of Camunda 8 consists of backup x of Zeebe, backup x of Optimize, backup x of Operate, and backup x of Tasklist. The backup id must be an integer and greater than the previous backups.

To back up a Camunda 8 cluster, execute the following sequential steps:

  1. Trigger a backup x of Optimize. See how to take an Optimize backup.
  2. Trigger a backup x of Operate. See how to take an Operate backup.
  3. Trigger a backup x of Tasklist. See how to take a Tasklist backup.
  4. Wait until the backup x of Optimize is complete. See how to monitor an Optimize backup.
  5. Wait until the backup x of Operate is complete. See how to monitor an Operate backup.
  6. Wait until the backup x of Tasklist is complete. See how to monitor a Tasklist backup.
  7. Pause exporting in Zeebe. See Zeebe management API.
  8. Take a backup x of the exported Zeebe records in Elasticsearch using the Elasticsearch Snapshots API.
PUT /_snapshot/my_repository/camunda_zeebe_records_backup_x
{
   "indices": "zeebe-record*",
   "feature_states": ["none"]
}

By default, the indices are prefixed with zeebe-record. If you have configured a different prefix when configuring Elasticsearch exporter in Zeebe, use this instead.

  1. Take a backup x of Zeebe. See how to take a Zeebe backup. Wait until the backup x of the exported Zeebe records is complete and wait until the backup x of Zeebe is completed before proceeding. See how to monitor a Zeebe backup.
  2. Resume exporting in Zeebe. See Zeebe management API.
note

If any of the steps above fail, you may have to restart with a new backup id. Ensure exporting is resumed if the backup process is canceled in the middle of the process.

Restore​

To restore a Camunda 8 cluster from a backup, all components must be restored from their backup corresponding to the same backup id:

  1. Start Zeebe, Operate, Tasklist, and Optimize. (To ensure templates/aliases etc. are created)
  2. Confirm proper configuration (such as shards, replicas count, etc.)
  3. Stop Operate, Tasklist, and Optimize.
  4. Delete all indices.
  5. Restore the state of Operate, Tasklist, and Optimize.
  6. Restore zeebe-records* indices from Elasticsearch snapshot.
  7. Restore Zeebe.
  8. Start Zeebe, Operate, Tasklist, and Optimize.