Add documentation on remote recovery #39483
Conversation
Tim-Brooks
added
>docs
Tim-Brooks
requested review from
martijnvg,
ywelsch,
jasontedor,
dnhatn and
lcawl
|
Pinging @elastic/es-distributed |
|
@tbrooks8 Were you intending this new page to be added to the existing CCR documentation in the Stack Overview? If so, I added a commit that puts it here: |
| Information about an in-progress remote recovery can be obtained using the | ||
| {ref}/cat-recovery.html[recovery API] on the follower cluster. Remote recoveries are implemented | ||
| using the {ref}/modules-snapshots.html[snapshot and restore] infrastructure. This means that | ||
| on-going remote recoveries will be labelled as type `snapshot` in the recovery api. |
There was a problem hiding this comment.
| on-going remote recoveries will be labelled as type `snapshot` in the recovery api. | |
| on-going remote recoveries are labelled as type `snapshot` in the recovery API. |
There was a problem hiding this comment.
Is there some way to know when the recovery process is complete (other than using the recovery API)?
There was a problem hiding this comment.
The recovery API is the primary. You could probably use the cat indices api to check if the index is green. You can also add a parameter to a follower request to wait until the process is completed. However, that is documented on the put follow request page.
| using the {ref}/modules-snapshots.html[snapshot and restore] infrastructure. This means that | ||
| on-going remote recoveries will be labelled as type `snapshot` in the recovery api. | ||
|
|
||
| The following setting can be used to rate-limit the data transmitted during remote |
There was a problem hiding this comment.
We generally store these types of settings in the Elasticsearch Reference in pages like the ones linked here: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings-xpack.html
I am happy to create that page if you agree.
There was a problem hiding this comment.
Yeah that makes sense.
There was a problem hiding this comment.
Thanks, I've added those changes.
Yes. Thanks. |
This is related to #35975. It adds documentation on the remote recovery process. Additionally, it adds documentation about the various settings that can impact the process.
This is related to #35975. It adds documentation on the remote recovery process. Additionally, it adds documentation about the various settings that can impact the process.
This is related to #35975. It adds documentation on the remote recovery process. Additionally, it adds documentation about the various settings that can impact the process.
* 6.7: (39 commits) Remove beta label from CCR (elastic#39722) Rename retention lease setting (elastic#39719) Add Docker build type (elastic#39378) Use any index specified by .watches for Watcher (elastic#39541) (elastic#39706) Add documentation on remote recovery (elastic#39483) fix typo in synonym graph filter docs Removed incorrect ML YAML tests (elastic#39400) Improved Terms Aggregation documentation (elastic#38892) Fix Fuzziness#asDistance(String) (elastic#39643) Revert "unmute EvilLoggerTests#testDeprecatedSettings (elastic#38743)" Mute TokenAuthIntegTests.testExpiredTokensDeletedAfterExpiration (elastic#39690) Fix security index auto-create and state recovery race (elastic#39582) [DOCS] Sorts security APIs Check for .watches that wasn't upgraded properly (elastic#39609) Assert recovery done in testDoNotWaitForPendingSeqNo (elastic#39595) [DOCS] Updates API in Watcher transform context (elastic#39540) Fixing the custom object serialization bug in diffable utils. (elastic#39544) mute test SQL: Don't allow inexact fields for MIN/MAX (elastic#39563) Update release notes for 6.7.0 ...
This is related to #35975. It adds documentation on the remote recovery
process. Additionally, it adds documentation about the various settings
that can impact the process.