Document soft pause exporter. (#3720)

* doc: document new soft pause method for the exporter.

These changes also apply to 8.3, 8.4, and 8.5.

* doc: change soft pause definition and move it to its own tab.

docs/self-managed/zeebe-deployment/operations/management-api.md

@@ -23,7 +23,7 @@ Exporting API is used:
 - As a debugging tool.
 - When taking a backup of Camunda 8 (see [backup and restore](/self-managed/operational-guides/backup-restore/backup-and-restore.md)).
 
-<Tabs groupId="exporting" defaultValue="pause" queryString values={[{label: 'Pause exporting', value: 'pause' },{label: 'Resume exporting', value: 'resume' }]} >
+<Tabs groupId="exporting" defaultValue="pause" queryString values={[{label: 'Pause exporting', value: 'pause' },{label: 'Resume exporting', value: 'resume' },{label: 'Soft pause exporting', value: 'softPause' }]} >
 
 <TabItem value="pause">
 
@@ -47,5 +47,17 @@ POST actuator/exporting/resume
 
 When all partitions have resumed exporting, a successful response is received. If the request fails, only some partitions may have resumed exporting. Therefore, it is important to retry until successful.
 
+</TabItem>
+
+<TabItem value="softPause">
+
+Soft pause feature can be used when you want to continue exporting records but do not want to delete those records (log compaction) from zeebe. This is particularly useful during hot backups. How to use this feature for hot backups is documented [here](/self-managed/operational-guides/backup-restore/backup-and-restore.md).
+
+```
+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, it is important to either retry until success or revert the partial soft pause by resuming exporting.
+
 </TabItem>
 </Tabs>

versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/management-api.md

@@ -30,6 +30,16 @@ POST actuator/exporting/pause
 
 When all partitions pause exporting, a successful response is received. If the request fails, some partitions may have paused exporting. Therefore, it is important to either retry until success or revert the partial pause by resuming exporting.
 
+### Soft Pause exporting
+
+Soft pause feature can be used when you want to continue exporting records but do not want to delete those records (log compaction) from zeebe. This is particularly useful during hot backups. How to use this feature for hot backups is documented [here](/self-managed/backup-restore/backup-and-restore.md).
+
+```
+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, it is important to either retry until success or revert the partial soft pause by resuming exporting.
+
 ### 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:

versioned_docs/version-8.3/self-managed/zeebe-deployment/operations/management-api.md

@@ -30,6 +30,16 @@ POST actuator/exporting/pause
 
 When all partitions pause exporting, a successful response is received. If the request fails, some partitions may have paused exporting. Therefore, it is important to either retry until success or revert the partial pause by resuming exporting.
 
+### Soft Pause exporting
+
+Soft pause feature can be used when you want to continue exporting records but do not want to delete those records (log compaction) from zeebe. This is particularly useful during hot backups. How to use this feature for hot backups is documented [here](/self-managed/operational-guides/backup-restore/backup-and-restore.md).
+
+```
+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, it is important to either retry until success or revert the partial soft pause by resuming exporting.
+
 ### 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:

versioned_docs/version-8.4/self-managed/zeebe-deployment/operations/management-api.md

@@ -23,7 +23,7 @@ Exporting API is used:
 - As a debugging tool.
 - When taking a backup of Camunda 8 (see [backup and restore](/self-managed/operational-guides/backup-restore/backup-and-restore.md)).
 
-<Tabs groupId="exporting" defaultValue="pause" queryString values={[{label: 'Pause exporting', value: 'pause' },{label: 'Resume exporting', value: 'resume' }]} >
+<Tabs groupId="exporting" defaultValue="pause" queryString values={[{label: 'Pause exporting', value: 'pause' },{label: 'Resume exporting', value: 'resume' },{label: 'Soft pause exporting', value: 'softPause' }]} >
 
 <TabItem value="pause">
 
@@ -47,5 +47,17 @@ POST actuator/exporting/resume
 
 When all partitions have resumed exporting, a successful response is received. If the request fails, only some partitions may have resumed exporting. Therefore, it is important to retry until successful.
 
+</TabItem>
+
+<TabItem value="softPause">
+
+Soft pause feature can be used when you want to continue exporting records but do not want to delete those records (log compaction) from zeebe. This is particularly useful during hot backups. How to use this feature for hot backups is documented [here](/self-managed/operational-guides/backup-restore/backup-and-restore.md).
+
+```
+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, it is important to either retry until success or revert the partial soft pause by resuming exporting.
+
 </TabItem>
 </Tabs>

versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/management-api.md

@@ -23,7 +23,7 @@ Exporting API is used:
 - As a debugging tool.
 - When taking a backup of Camunda 8 (see [backup and restore](/self-managed/operational-guides/backup-restore/backup-and-restore.md)).
 
-<Tabs groupId="exporting" defaultValue="pause" queryString values={[{label: 'Pause exporting', value: 'pause' },{label: 'Resume exporting', value: 'resume' }]} >
+<Tabs groupId="exporting" defaultValue="pause" queryString values={[{label: 'Pause exporting', value: 'pause' },{label: 'Resume exporting', value: 'resume' },{label: 'Soft pause exporting', value: 'softPause' }]} >
 
 <TabItem value="pause">
 
@@ -47,5 +47,17 @@ POST actuator/exporting/resume
 
 When all partitions have resumed exporting, a successful response is received. If the request fails, only some partitions may have resumed exporting. Therefore, it is important to retry until successful.
 
+</TabItem>
+
+<TabItem value="softPause">
+
+Soft pause feature can be used when you want to continue exporting records but do not want to delete those records (log compaction) from zeebe. This is particularly useful during hot backups. How to use this feature for hot backups is documented [here](/self-managed/operational-guides/backup-restore/backup-and-restore.md).
+
+```
+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, it is important to either retry until success or revert the partial soft pause by resuming exporting.
+
 </TabItem>
 </Tabs>