Introduce CCR getting started guide#35434
Conversation
This commit introduces a basic getting started guide for cross-cluster replication to the docs. Co-authored-by: "lcawl <lcawley@elastic.co>"
|
Pinging @elastic/es-distributed |
|
@elasticmachine run gradle build tests |
| [float] | ||
| [[ccr-gs-before-you-begin]] | ||
| === Before you begin | ||
| . Install {es} on local and remote clusters. |
There was a problem hiding this comment.
Do we want to expose a version here?
| === Creating a leader index | ||
|
|
||
| Leader indices require special index settings to ensure that the operations that | ||
| need to replicated by the follower from the leader are available when the |
There was a problem hiding this comment.
| need to replicated by the follower from the leader are available when the | |
| need to be replicated by the follower from the leader are available when the |
* master: Add docs for CCR stats API (elastic#35439) Fix the names of CCR stats endpoints in usage API (elastic#35438) Switch to default to no build qualifier (elastic#35415) Clarify S3 repository storage class parameter (elastic#35400) SQL: Fix query translation for scripted queries (elastic#35408) [TEST] Instead of ignoring the ccr downgrade to basic license qa test avoid the assertions that check the log files, because that does not work on Windows. The rest of the test is still useful and should work on Windows CI. Upgrade to Joda 2.10.1 (elastic#35410) HLRest: model role and privileges (elastic#35128)
* master: Address handling of OS pretty name on some OS (elastic#35451) HLRC support for getTask (elastic#35166) upgrade to lucene-8.0.0-snapshot-6d9c714052 (elastic#35428)
| [[ccr-getting-started]] | ||
| == Getting Started | ||
| [[ccr-gs]] | ||
| == Getting Started with Cross-Cluster Replication |
There was a problem hiding this comment.
It would be better for SEO purposes to leave "getting-started" spelled out in this anchor. The subsections can use the abbreviation. Should probably also use the {ccr} attribute in the header.
| - write | ||
| - manage_follow_index | ||
| -------------------------------------------------- | ||
| -- |
There was a problem hiding this comment.
I think you'll also need manage cluster privileges to change the cluster settings.
| -------------------------------------------------- | ||
| ccr_user: | ||
| cluster: | ||
| - read_ccr |
There was a problem hiding this comment.
Should this privilege be added to the list here?: https://www.elastic.co/guide/en/elastic-stack-overview/master/security-privileges.html
| -------------------------------------------------- | ||
| ccr_user: | ||
| cluster: | ||
| - manage_ccr |
There was a problem hiding this comment.
I don't see this manage_ccr privilege documented yet either: https://www.elastic.co/guide/en/elastic-stack-overview/master/security-privileges.html
There was a problem hiding this comment.
Yes, we should add that there.
lcawl
left a comment
There was a problem hiding this comment.
I've left a couple of comments about security privileges, but otherwise LGTM and builds cleanly.
* master: (22 commits) Introduce CCR getting started guide (elastic#35434) Correct typo in BuildPlugin exception message (elastic#35458) Correct implemented interface of ParsedReverseNested (elastic#35455) [ML] Fix find_file_structure NPE with should_trim_fields (elastic#35465) Handle OS pretty name on old OS without OS release (elastic#35453) Register remote cluster compress setting (elastic#35464) [DOCS] Clarify results_index_name description (elastic#35463) [TEST] add missing doc tests for HLRC GetRollupIndexCaps API [HLRC] Add GetRollupIndexCaps API (elastic#35102) Geo: enables coerce support in WKT polygon parser (elastic#35414) [ILM] fix retry so it picks up latest policy and executes async action (elastic#35406) Address handling of OS pretty name on some OS (elastic#35451) HLRC support for getTask (elastic#35166) upgrade to lucene-8.0.0-snapshot-6d9c714052 (elastic#35428) Add docs for CCR stats API (elastic#35439) Fix the names of CCR stats endpoints in usage API (elastic#35438) Switch to default to no build qualifier (elastic#35415) Clarify S3 repository storage class parameter (elastic#35400) SQL: Fix query translation for scripted queries (elastic#35408) [TEST] Instead of ignoring the ccr downgrade to basic license qa test avoid the assertions that check the log files, because that does not work on Windows. The rest of the test is still useful and should work on Windows CI. ...
This commit introduces a basic getting started guide for cross-cluster replication to the docs. Co-authored-by: "lcawl <lcawley@elastic.co>"
This commit introduces a basic getting started guide for cross-cluster replication to the docs. Co-authored-by: "lcawl <lcawley@elastic.co>"
This commit introduces a basic getting started guide for cross-cluster replication to the docs.