From 2775f7d83bfe54d6ec5686d3328f661eba8f624f Mon Sep 17 00:00:00 2001 From: Giuliano Rodrigues Lima <91879848+grlimacan@users.noreply.github.com> Date: Wed, 11 Dec 2024 15:58:53 +0200 Subject: [PATCH] Apply suggestions from formatting Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../backup-restore/optimize-backup.md | 10 +++++----- .../configuration/system-configuration-platform-7.md | 7 ++++--- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/self-managed/operational-guides/backup-restore/optimize-backup.md b/docs/self-managed/operational-guides/backup-restore/optimize-backup.md index 57eeda29e7..2215873da0 100644 --- a/docs/self-managed/operational-guides/backup-restore/optimize-backup.md +++ b/docs/self-managed/operational-guides/backup-restore/optimize-backup.md @@ -49,7 +49,7 @@ POST actuator/backups ### Response | Code | Description | -| ---------------- |--------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | 202 Accepted | Backup process was successfully initiated. To determine whether backup process was completed refer to the GET API. | | 400 Bad Request | Indicates issues with the request, for example when the `backupId` contains invalid characters. | | 409 Conflict | Indicates that a backup with the same `backupId` already exists. | @@ -92,7 +92,7 @@ GET actuator/backup ### Response | Code | Description | -| ---------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | 200 OK | Backup state could be determined and is returned in the response body (see example below). | | 400 Bad Request | There is an issue with the request, for example the repository name specified in the Optimize configuration does not exist. Refer to returned error message for details. | | 404 Not Found | If a backup ID was specified, no backup with that ID exists. | @@ -153,11 +153,11 @@ DELETE actuator/backups/{backupId} ### Response | Code | Description | -| ---------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | 204 No Content | The delete request for the associated snapshots was submitted to the database successfully. | | 400 Bad Request | There is an issue with the request, for example the repository name specified in the Optimize configuration does not exist. Refer to returned error message for details. | | 500 Server Error | An error occurred, for example the snapshot repository does not exist. Refer to the returned error message for details. | -| 502 Bad Gateway | Optimize has encountered issues while trying to connect to ElasticSearch/OpenSearch. | +| 502 Bad Gateway | Optimize has encountered issues while trying to connect to ElasticSearch/OpenSearch. | ### Example request @@ -167,7 +167,7 @@ curl --request DELETE 'http://localhost:8092/actuator/backups/123456' ## Restore backup -There is no Optimize API to perform the backup restore. Instead, the standard [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/restore-snapshot-api.html) / [OpenSearch](https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot) restore snapshot API can be used. Note that the Optimize versions of your backup snapshots must match the currently running version of Optimize. You can identify the version at which the backup was taken by the version tag included in respective snapshot names; for example, a snapshot with the name`camunda_optimize_123456_3.9.0_part_1_of_2` was taken of Optimize version `3.9.0`. +There is no Optimize API to perform the backup restore. Instead, the standard [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/restore-snapshot-api.html) / [OpenSearch](https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot) restore snapshot API can be used. Note that the Optimize versions of your backup snapshots must match the currently running version of Optimize. You can identify the version at which the backup was taken by the version tag included in respective snapshot names; for example, a snapshot with the name`camunda_optimize_123456_3.9.0_part_1_of_2` was taken of Optimize version `3.9.0`. :::note Optimize must NOT be running while a backup is being restored. diff --git a/optimize/self-managed/optimize-deployment/configuration/system-configuration-platform-7.md b/optimize/self-managed/optimize-deployment/configuration/system-configuration-platform-7.md index 0c83db8e73..4ff8045ac1 100644 --- a/optimize/self-managed/optimize-deployment/configuration/system-configuration-platform-7.md +++ b/optimize/self-managed/optimize-deployment/configuration/system-configuration-platform-7.md @@ -39,7 +39,7 @@ Settings used by Optimize, which are common among all configured engines, such a REST API endpoint locations, timeouts, etc. | YAML path | Default value | Description | -|-----------------------------------------------------------| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| --------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | engine-commons.connection.timeout | 0 | Maximum time in milliseconds without connection to the engine that Optimize should wait until a timeout is triggered. If set to zero, no timeout will be triggered. | | engine-commons.read.timeout | 0 | Maximum time a request to the engine should last before a timeout triggers. A value of zero means to wait an infinite amount of time. | | import.data.activity-instance.maxPageSize | 10000 | Determines the page size for historic activity instance fetching. | @@ -64,7 +64,7 @@ REST API endpoint locations, timeouts, etc. | import.data.user-task-worker.metadata.maxPageSize | 10000 | The max page size when multiple users or groups are iterated during the metadata refresh. | | import.data.user-task-worker.metadata.maxEntryLimit | 100000 | The entry limit of the cache that holds the metadata, if you need more entries you can increase that limit. When increasing the limit, keep in mind to account for that by increasing the JVM heap memory as well. Please refer to the "Adjust Optimize heap size" documentation. | | import.skipDataAfterNestedDocLimitReached | false | Some data can no longer be imported to a given document if its number of nested documents has reached the configured limit. Enable this setting to skip this data during import if the nested document limit has been reached. | -| import.elasticsearchJobExecutorThreadCount\* | 1 | Number of threads being used to process the import jobs per data type that are writing data to elasticsearch. | +| import.elasticsearchJobExecutorThreadCount\* | 1 | Number of threads being used to process the import jobs per data type that are writing data to elasticsearch. | | import.elasticsearchJobExecutorQueueSize\* | 5 | Adjust the queue size of the import jobs per data type that store data to elasticsearch. If the value is too large it might cause memory problems. | | import.handler.backoff.interval | 5000 | Interval in milliseconds which is used for the backoff time calculation. | | import.handler.backoff.max | 15 | Once all pages are consumed, the import scheduler component will start scheduling fetching tasks in increasing periods of time, controlled by "backoff" counter. | @@ -77,4 +77,5 @@ REST API endpoint locations, timeouts, etc. | import.identitySync.cronTrigger | `0 */2 * * *` | Cron expression for when the identity sync should run, defaults to every second hour. You can either use the default Cron (5 fields) or the Spring Cron (6 fields) expression format here.

For details on the format please refer to: | | import.identitySync.maxPageSize | 10000 | The max page size when multiple users or groups are iterated during the import. | | import.identitySync.maxEntryLimit | 100000 | The entry limit of the user/group search cache. When increasing the limit, keep in mind to account for this by increasing the JVM heap memory as well. Please refer to the "Adjust Optimize heap size" documentation on how to configure the heap size. | -*\ Although this parameter includes `ElasticSearch` in its name, it applies to both ElasticSearch and OpenSearch installations. For backward compatibility reasons, the parameter has not been renamed. \ No newline at end of file + +\*\ Although this parameter includes `ElasticSearch` in its name, it applies to both ElasticSearch and OpenSearch installations. For backward compatibility reasons, the parameter has not been renamed. \ No newline at end of file