docs(self-managed): clarify restore steps (#3491)

* docs(self-managed): clarify restore steps * style(formatting): technical review * removed incorrect additional step 9 --------- Co-authored-by: Christina Ausley <[email protected]>
camunda · Mar 27, 2024 · 64fbfcd · 64fbfcd
1 parent e9f7c36
commit 64fbfcd
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 20 deletions.
diff --git a/docs/self-managed/operational-guides/backup-restore/backup-and-restore.md b/docs/self-managed/operational-guides/backup-restore/backup-and-restore.md
@@ -64,7 +64,11 @@ If any of the steps above fail, you may have to restart with a new backup id. En
 
 To restore a Camunda 8 cluster from a backup, all components must be restored from their backup corresponding to the same backup id:
 
-1. Restore the state of [Operate](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/operational-guides/backup-restore/optimize-backup.md).
-2. Restore `zeebe-records*` indices from Elasticsearch snapshot.
-3. Restore [Zeebe](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md).
-4. Start Zeebe, Operate, Tasklist, and Optimize.
+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](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/operational-guides/backup-restore/optimize-backup.md).
+6. Restore `zeebe-records*` indices from Elasticsearch snapshot.
+7. Restore [Zeebe](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md).
+8. Start Zeebe, Operate, Tasklist, and Optimize.
diff --git a/versioned_docs/version-8.1/self-managed/backup-restore/backup-and-restore.md b/versioned_docs/version-8.1/self-managed/backup-restore/backup-and-restore.md
@@ -57,7 +57,11 @@ If any of the steps above fail, you may have to restart with a new backup id. En
 
 To restore a Camunda 8 cluster from a backup, all components must be restored from their backup corresponding to the same backup id:
 
-1. Restore the state of [Operate](/self-managed/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/backup-restore/optimize-backup.md).
-2. Restore `zeebe-records*` indices from Elasticsearch snapshot.
-3. Restore [Zeebe](self-managed/backup-restore/zeebe-backup-and-restore.md).
-4. Start Zeebe, Operate, Tasklist, and Optimize.
+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](/self-managed/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/backup-restore/optimize-backup.md).
+6. Restore `zeebe-records*` indices from Elasticsearch snapshot.
+7. Restore [Zeebe](self-managed/backup-restore/zeebe-backup-and-restore.md).
+8. Start Zeebe, Operate, Tasklist, and Optimize.
diff --git a/versioned_docs/version-8.2/self-managed/backup-restore/backup-and-restore.md b/versioned_docs/version-8.2/self-managed/backup-restore/backup-and-restore.md
@@ -63,7 +63,11 @@ If any of the steps above fail, you may have to restart with a new backup id. En
 
 To restore a Camunda 8 cluster from a backup, all components must be restored from their backup corresponding to the same backup id:
 
-1. Restore the state of [Operate](/self-managed/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/backup-restore/optimize-backup.md).
-2. Restore `zeebe-records*` indices from Elasticsearch snapshot.
-3. Restore [Zeebe](self-managed/backup-restore/zeebe-backup-and-restore.md).
-4. Start Zeebe, Operate, Tasklist, and Optimize.
+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](/self-managed/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/backup-restore/optimize-backup.md).
+6. Restore `zeebe-records*` indices from Elasticsearch snapshot.
+7. Restore [Zeebe](self-managed/backup-restore/zeebe-backup-and-restore.md).
+8. Start Zeebe, Operate, Tasklist, and Optimize.
diff --git a/...ersion-8.3/self-managed/operational-guides/backup-restore/backup-and-restore.md b/...ersion-8.3/self-managed/operational-guides/backup-restore/backup-and-restore.md
@@ -63,7 +63,11 @@ If any of the steps above fail, you may have to restart with a new backup id. En
 
 To restore a Camunda 8 cluster from a backup, all components must be restored from their backup corresponding to the same backup id:
 
-1. Restore the state of [Operate](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/operational-guides/backup-restore/optimize-backup.md).
-2. Restore `zeebe-records*` indices from Elasticsearch snapshot.
-3. Restore [Zeebe](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md).
-4. Start Zeebe, Operate, Tasklist, and Optimize.
+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](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/operational-guides/backup-restore/optimize-backup.md).
+6. Restore `zeebe-records*` indices from Elasticsearch snapshot.
+7. Restore [Zeebe](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md).
+8. Start Zeebe, Operate, Tasklist, and Optimize.
diff --git a/...ersion-8.4/self-managed/operational-guides/backup-restore/backup-and-restore.md b/...ersion-8.4/self-managed/operational-guides/backup-restore/backup-and-restore.md
@@ -63,7 +63,11 @@ If any of the steps above fail, you may have to restart with a new backup id. En
 
 To restore a Camunda 8 cluster from a backup, all components must be restored from their backup corresponding to the same backup id:
 
-1. Restore the state of [Operate](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/operational-guides/backup-restore/optimize-backup.md).
-2. Restore `zeebe-records*` indices from Elasticsearch snapshot.
-3. Restore [Zeebe](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md).
-4. Start Zeebe, Operate, Tasklist, and Optimize.
+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](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/operational-guides/backup-restore/optimize-backup.md).
+6. Restore `zeebe-records*` indices from Elasticsearch snapshot.
+7. Restore [Zeebe](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md).
+8. Start Zeebe, Operate, Tasklist, and Optimize.