From 851c92de31820bad4eba497272ca8d11e961124d Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Thu, 25 Jul 2024 09:05:47 -0400 Subject: [PATCH 1/2] clarify possible instances of zeebe rollback --- .../zeebe-deployment/operations/update-zeebe.md | 8 ++++++++ .../zeebe-deployment/operations/update-zeebe.md | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/self-managed/zeebe-deployment/operations/update-zeebe.md b/docs/self-managed/zeebe-deployment/operations/update-zeebe.md index 3e92f833a7..9e03ef5eac 100644 --- a/docs/self-managed/zeebe-deployment/operations/update-zeebe.md +++ b/docs/self-managed/zeebe-deployment/operations/update-zeebe.md @@ -163,6 +163,10 @@ If the error is caused by `Cannot upgrade to or from a pre-release version`, Zee This is not permitted because pre-release versions such as alpha releases are considered unstable and do not guarantee compatibility with any other version. If you attempted to update from a normal version to a pre-release version, you can roll back to the previous normal version. +:::note +While in most instances version rollbacks are not supported, in this particular use case a version rollback is possible. +::: + If the log message includes `Snapshot is not compatible with current version`, the rolling update failed and manual recovery is required. :::note @@ -194,6 +198,10 @@ This should resolve automatically once the broker is updated. If this persists, you may want to [force the update](#rolling-update-is-not-completing). +:::note +In this specific case, a rollback is possible because users may restart Zeebe with the "skipped" minor version. [Backup and restore](/self-managed/operational-guides/backup-restore/backup-and-restore.md) is possible, but results in partial data loss of everything following the backup. Therefore, a rollback is preferable in this use case. +::: + ## Offline update See the [update guide](/self-managed/operational-guides/update-guide/introduction.md) for specific instructions per Zeebe version. diff --git a/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/update-zeebe.md b/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/update-zeebe.md index 3e92f833a7..9e03ef5eac 100644 --- a/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/update-zeebe.md +++ b/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/update-zeebe.md @@ -163,6 +163,10 @@ If the error is caused by `Cannot upgrade to or from a pre-release version`, Zee This is not permitted because pre-release versions such as alpha releases are considered unstable and do not guarantee compatibility with any other version. If you attempted to update from a normal version to a pre-release version, you can roll back to the previous normal version. +:::note +While in most instances version rollbacks are not supported, in this particular use case a version rollback is possible. +::: + If the log message includes `Snapshot is not compatible with current version`, the rolling update failed and manual recovery is required. :::note @@ -194,6 +198,10 @@ This should resolve automatically once the broker is updated. If this persists, you may want to [force the update](#rolling-update-is-not-completing). +:::note +In this specific case, a rollback is possible because users may restart Zeebe with the "skipped" minor version. [Backup and restore](/self-managed/operational-guides/backup-restore/backup-and-restore.md) is possible, but results in partial data loss of everything following the backup. Therefore, a rollback is preferable in this use case. +::: + ## Offline update See the [update guide](/self-managed/operational-guides/update-guide/introduction.md) for specific instructions per Zeebe version. From 387ef7c498849d45fb76093dfbb40924e13a8213 Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Fri, 26 Jul 2024 11:21:31 -0400 Subject: [PATCH 2/2] resolve comments --- .../zeebe-deployment/operations/update-zeebe.md | 10 +++------- .../zeebe-deployment/operations/update-zeebe.md | 10 +++------- 2 files changed, 6 insertions(+), 14 deletions(-) diff --git a/docs/self-managed/zeebe-deployment/operations/update-zeebe.md b/docs/self-managed/zeebe-deployment/operations/update-zeebe.md index 9e03ef5eac..5df604da86 100644 --- a/docs/self-managed/zeebe-deployment/operations/update-zeebe.md +++ b/docs/self-managed/zeebe-deployment/operations/update-zeebe.md @@ -160,11 +160,11 @@ Because the update is no longer rolling and all brokers are shut down at the sam If updated brokers log the error message `Failed to install partition` and do not become healthy, look for more details to understand if this is caused by the rolling update. If the error is caused by `Cannot upgrade to or from a pre-release version`, Zeebe detected that either the version you started from or the version you updated to is a pre-release version. + This is not permitted because pre-release versions such as alpha releases are considered unstable and do not guarantee compatibility with any other version. -If you attempted to update from a normal version to a pre-release version, you can roll back to the previous normal version. :::note -While in most instances version rollbacks are not supported, in this particular use case a version rollback is possible. +If you attempted to update from a minor release to a pre-release or alpha version, it is possible to roll back to the previous version of Zeebe. Note that version rollbacks are not supported in most other instances. ::: If the log message includes `Snapshot is not compatible with current version`, the rolling update failed and manual recovery is required. @@ -196,11 +196,7 @@ In that case, it is caused by updated brokers sharing snapshots with not yet upd This should resolve automatically once the broker is updated. ::: -If this persists, you may want to [force the update](#rolling-update-is-not-completing). - -:::note -In this specific case, a rollback is possible because users may restart Zeebe with the "skipped" minor version. [Backup and restore](/self-managed/operational-guides/backup-restore/backup-and-restore.md) is possible, but results in partial data loss of everything following the backup. Therefore, a rollback is preferable in this use case. -::: +If this persists, you can [force the update](#rolling-update-is-not-completing). Alternatively, it is possible to restart Zeebe with the "skipped" minor version. Note that version rollbacks are not supported in most other instances. ## Offline update diff --git a/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/update-zeebe.md b/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/update-zeebe.md index 9e03ef5eac..5df604da86 100644 --- a/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/update-zeebe.md +++ b/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/update-zeebe.md @@ -160,11 +160,11 @@ Because the update is no longer rolling and all brokers are shut down at the sam If updated brokers log the error message `Failed to install partition` and do not become healthy, look for more details to understand if this is caused by the rolling update. If the error is caused by `Cannot upgrade to or from a pre-release version`, Zeebe detected that either the version you started from or the version you updated to is a pre-release version. + This is not permitted because pre-release versions such as alpha releases are considered unstable and do not guarantee compatibility with any other version. -If you attempted to update from a normal version to a pre-release version, you can roll back to the previous normal version. :::note -While in most instances version rollbacks are not supported, in this particular use case a version rollback is possible. +If you attempted to update from a minor release to a pre-release or alpha version, it is possible to roll back to the previous version of Zeebe. Note that version rollbacks are not supported in most other instances. ::: If the log message includes `Snapshot is not compatible with current version`, the rolling update failed and manual recovery is required. @@ -196,11 +196,7 @@ In that case, it is caused by updated brokers sharing snapshots with not yet upd This should resolve automatically once the broker is updated. ::: -If this persists, you may want to [force the update](#rolling-update-is-not-completing). - -:::note -In this specific case, a rollback is possible because users may restart Zeebe with the "skipped" minor version. [Backup and restore](/self-managed/operational-guides/backup-restore/backup-and-restore.md) is possible, but results in partial data loss of everything following the backup. Therefore, a rollback is preferable in this use case. -::: +If this persists, you can [force the update](#rolling-update-is-not-completing). Alternatively, it is possible to restart Zeebe with the "skipped" minor version. Note that version rollbacks are not supported in most other instances. ## Offline update