From aa3928ee31f21cf6e22f48dc959dcb3297180d02 Mon Sep 17 00:00:00 2001 From: rodrigolourencolopes Date: Wed, 26 Jun 2024 14:19:44 +0200 Subject: [PATCH 1/2] doc: specify patch version for soft pause feature in management-api.md. --- .../self-managed/zeebe-deployment/operations/management-api.md | 2 ++ .../self-managed/zeebe-deployment/operations/management-api.md | 2 ++ .../self-managed/zeebe-deployment/operations/management-api.md | 2 ++ .../self-managed/zeebe-deployment/operations/management-api.md | 2 ++ 4 files changed, 8 insertions(+) diff --git a/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/management-api.md b/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/management-api.md index 6cc829d7ad..fcd7d9983e 100644 --- a/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/management-api.md +++ b/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/management-api.md @@ -40,6 +40,8 @@ POST actuator/exporting/pause?soft=true When all partitions soft pause exporting, a successful response is received. If the request fails, some partitions may have soft paused exporting. Therefore, either retry until success or revert the partial soft pause by resuming the export. +The soft pause feature is only available from 8.2.27 onwards. + ### Resume exporting After exporting is paused, it must eventually be resumed. Otherwise, the cluster could become unavailable. To resume exporting, send the following request to the gateway's management endpoint: diff --git a/versioned_docs/version-8.3/self-managed/zeebe-deployment/operations/management-api.md b/versioned_docs/version-8.3/self-managed/zeebe-deployment/operations/management-api.md index 9160750f26..8c147f46b4 100644 --- a/versioned_docs/version-8.3/self-managed/zeebe-deployment/operations/management-api.md +++ b/versioned_docs/version-8.3/self-managed/zeebe-deployment/operations/management-api.md @@ -40,6 +40,8 @@ POST actuator/exporting/pause?soft=true When all partitions soft pause exporting, a successful response is received. If the request fails, some partitions may have soft paused exporting. Therefore, either retry until success or revert the partial soft pause by resuming the export. +The soft pause feature is only available from 8.3.11 onwards. + ### Resume exporting After exporting is paused, it must eventually be resumed. Otherwise, the cluster could become unavailable. To resume exporting, send the following request to the gateway's management endpoint: diff --git a/versioned_docs/version-8.4/self-managed/zeebe-deployment/operations/management-api.md b/versioned_docs/version-8.4/self-managed/zeebe-deployment/operations/management-api.md index dba45392ef..56f6e2d754 100644 --- a/versioned_docs/version-8.4/self-managed/zeebe-deployment/operations/management-api.md +++ b/versioned_docs/version-8.4/self-managed/zeebe-deployment/operations/management-api.md @@ -59,5 +59,7 @@ POST actuator/exporting/pause?soft=true When all partitions soft pause exporting, a successful response is received. If the request fails, some partitions may have soft paused exporting. Therefore, either retry until success or revert the partial soft pause by resuming the export. +The soft pause feature is only available from 8.4.7 onwards. + diff --git a/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/management-api.md b/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/management-api.md index 6c4e083beb..c146caeb46 100644 --- a/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/management-api.md +++ b/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/management-api.md @@ -59,5 +59,7 @@ POST actuator/exporting/pause?soft=true When all partitions soft pause exporting, a successful response is received. If the request fails, some partitions may have soft paused exporting. Therefore, either retry until success or revert the partial soft pause by resuming the export. +The soft pause feature is only available from 8.5.1 onwards. + From 5f2d05b288b479804ffde5a543cb7f32357424c5 Mon Sep 17 00:00:00 2001 From: rodrigolourencolopes Date: Wed, 26 Jun 2024 14:32:44 +0200 Subject: [PATCH 2/2] doc: specify patch version for soft pause feature in backup-and-restore.md. --- .../self-managed/backup-restore/backup-and-restore.md | 2 +- .../operational-guides/backup-restore/backup-and-restore.md | 2 +- .../operational-guides/backup-restore/backup-and-restore.md | 2 +- .../operational-guides/backup-restore/backup-and-restore.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) 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 index a603dda074..c8b4b0106e 100644 --- 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 @@ -37,7 +37,7 @@ To back up a Camunda 8 cluster, execute the following sequential steps: 4. Wait until the backup `x` of Optimize is complete. See [how to monitor an Optimize backup](/self-managed/backup-restore/optimize-backup.md). 5. Wait until the backup `x` of Operate is complete. See [how to monitor an Operate backup](/self-managed/backup-restore/operate-tasklist-backup.md). 6. Wait until the backup `x` of Tasklist is complete. See [how to monitor a Tasklist backup](/self-managed/backup-restore/operate-tasklist-backup.md). -7. Soft pause exporting in Zeebe. See [Zeebe management API](/self-managed/zeebe-deployment/operations/management-api.md). +7. Soft pause exporting in Zeebe (this feature is only available from 8.2.27, otherwise use Pause exporting). See [Zeebe management API](/self-managed/zeebe-deployment/operations/management-api.md). 8. Take a backup `x` of the exported Zeebe records in Elasticsearch using the Elasticsearch Snapshots API. ``` diff --git a/versioned_docs/version-8.3/self-managed/operational-guides/backup-restore/backup-and-restore.md b/versioned_docs/version-8.3/self-managed/operational-guides/backup-restore/backup-and-restore.md index 520c7d6a73..e764a26a0f 100644 --- a/versioned_docs/version-8.3/self-managed/operational-guides/backup-restore/backup-and-restore.md +++ b/versioned_docs/version-8.3/self-managed/operational-guides/backup-restore/backup-and-restore.md @@ -37,7 +37,7 @@ To back up a Camunda 8 cluster, execute the following sequential steps: 4. Wait until the backup `x` of Optimize is complete. See [how to monitor an Optimize backup](/self-managed/operational-guides/backup-restore/optimize-backup.md). 5. Wait until the backup `x` of Operate is complete. See [how to monitor an Operate backup](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md). 6. Wait until the backup `x` of Tasklist is complete. See [how to monitor a Tasklist backup](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md). -7. Soft pause exporting in Zeebe. See [Zeebe management API](/self-managed/zeebe-deployment/operations/management-api.md). +7. Soft pause exporting in Zeebe (this feature is only available from 8.3.11, otherwise use Pause exporting). See [Zeebe management API](/self-managed/zeebe-deployment/operations/management-api.md). 8. Take a backup `x` of the exported Zeebe records in Elasticsearch using the Elasticsearch Snapshots API. ``` diff --git a/versioned_docs/version-8.4/self-managed/operational-guides/backup-restore/backup-and-restore.md b/versioned_docs/version-8.4/self-managed/operational-guides/backup-restore/backup-and-restore.md index 520c7d6a73..003120a160 100644 --- a/versioned_docs/version-8.4/self-managed/operational-guides/backup-restore/backup-and-restore.md +++ b/versioned_docs/version-8.4/self-managed/operational-guides/backup-restore/backup-and-restore.md @@ -37,7 +37,7 @@ To back up a Camunda 8 cluster, execute the following sequential steps: 4. Wait until the backup `x` of Optimize is complete. See [how to monitor an Optimize backup](/self-managed/operational-guides/backup-restore/optimize-backup.md). 5. Wait until the backup `x` of Operate is complete. See [how to monitor an Operate backup](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md). 6. Wait until the backup `x` of Tasklist is complete. See [how to monitor a Tasklist backup](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md). -7. Soft pause exporting in Zeebe. See [Zeebe management API](/self-managed/zeebe-deployment/operations/management-api.md). +7. Soft pause exporting in Zeebe (this feature is only available from 8.4.7, otherwise use Pause exporting). See [Zeebe management API](/self-managed/zeebe-deployment/operations/management-api.md). 8. Take a backup `x` of the exported Zeebe records in Elasticsearch using the Elasticsearch Snapshots API. ``` diff --git a/versioned_docs/version-8.5/self-managed/operational-guides/backup-restore/backup-and-restore.md b/versioned_docs/version-8.5/self-managed/operational-guides/backup-restore/backup-and-restore.md index f8dd184b1c..bb388bdb0b 100644 --- a/versioned_docs/version-8.5/self-managed/operational-guides/backup-restore/backup-and-restore.md +++ b/versioned_docs/version-8.5/self-managed/operational-guides/backup-restore/backup-and-restore.md @@ -38,7 +38,7 @@ To back up a Camunda 8 cluster, execute the following sequential steps: 4. Wait until the backup `x` of Optimize is complete. See [how to monitor an Optimize backup](/self-managed/operational-guides/backup-restore/optimize-backup.md). 5. Wait until the backup `x` of Operate is complete. See [how to monitor an Operate backup](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md). 6. Wait until the backup `x` of Tasklist is complete. See [how to monitor a Tasklist backup](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md). -7. Soft pause exporting in Zeebe. See [Zeebe management API](self-managed/zeebe-deployment/operations/management-api.md). +7. Soft pause exporting in Zeebe (this feature is only available from 8.5.1, otherwise use Pause exporting). See [Zeebe management API](self-managed/zeebe-deployment/operations/management-api.md). 8. Take a backup `x` of the exported Zeebe records in Elasticsearch using the Elasticsearch Snapshots API. ```