Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Specify the patch version for soft pause feature. #3984

Merged
merged 2 commits into from
Jun 27, 2024
Merged

Doc: Specify the patch version for soft pause feature. #3984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa3928e
doc: specify patch version for soft pause feature in management-api.md.
rodrigo-lourenco-lopes Jun 26, 2024
5f2d05b
doc: specify patch version for soft pause feature in backup-and-resto…
rodrigo-lourenco-lopes Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion versioned_docs/version-8.2/self-managed/backup-restore/backup-and-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

```
Expand Down
2 changes: 2 additions & 0 deletions ...ned_docs/version-8.2/self-managed/zeebe-deployment/operations/management-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion ...ersion-8.3/self-managed/operational-guides/backup-restore/backup-and-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

```
Expand Down
2 changes: 2 additions & 0 deletions ...ned_docs/version-8.3/self-managed/zeebe-deployment/operations/management-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion ...ersion-8.4/self-managed/operational-guides/backup-restore/backup-and-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

```
Expand Down
2 changes: 2 additions & 0 deletions ...ned_docs/version-8.4/self-managed/zeebe-deployment/operations/management-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

</TabItem>
</Tabs>
2 changes: 1 addition & 1 deletion ...ersion-8.5/self-managed/operational-guides/backup-restore/backup-and-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

```
Expand Down
2 changes: 2 additions & 0 deletions ...ned_docs/version-8.5/self-managed/zeebe-deployment/operations/management-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

</TabItem>
</Tabs>
Loading