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.

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

[DOCS] Add note that write indices are not replicated #82997

Conversation

lockewritesdocs
Copy link
Contributor

@lockewritesdocs lockewritesdocs commented Jan 24, 2022

Adds a note to the CCR docs that write indices are ignored when indices are replicated from a leader to a follower.

Preview link: https://elasticsearch_82997.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/xpack-ccr.html#ccr-update-leader-index

Closes #82679

@lockewritesdocs lockewritesdocs added >docs General docs changes :Distributed Indexing/CCR Issues around the Cross Cluster State Replication features v8.0.0 v8.1.0 v7.16.3 v7.17.1 labels Jan 24, 2022
@lockewritesdocs lockewritesdocs self-assigned this Jan 24, 2022
@elasticmachine elasticmachine added Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team labels Jan 24, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@lockewritesdocs
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs

Copy link
Contributor

@bpintea bpintea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but would have a member of @elastic/es-distributed review it too.

@@ -195,6 +195,10 @@ You can't manually modify a follower index's mappings or aliases. To make
changes, you must update the leader index. Because they are read-only, follower
indices reject writes in all configurations.

NOTE: Although changes to aliases on the leader index are replicated to follower
indices, write indices are ignored. Follower indices can't accept direct writes,
so any indices where `is_write_index` is `true` are not replicated.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so any indices where is_write_index is true are not replicated.

@DaveCTurner, should this be "any indices" or "any index aliases"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indices are replicated, only the information on the alias about is_write_index is not, that flag is always forced to false on the follower.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indices are replicated, only the information on the alias about is_write_index is not, that flag is always forced to false on the follower.

Thanks for the explanation @henningandersen! I updated the note text in 9b5260f -- let me know if that's accurate.

Copy link
Contributor

@henningandersen henningandersen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing this @lockewritesdocs , I think this needs a slight change to be correct.

@@ -195,6 +195,10 @@ You can't manually modify a follower index's mappings or aliases. To make
changes, you must update the leader index. Because they are read-only, follower
indices reject writes in all configurations.

NOTE: Although changes to aliases on the leader index are replicated to follower
indices, write indices are ignored. Follower indices can't accept direct writes,
so any indices where `is_write_index` is `true` are not replicated.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indices are replicated, only the information on the alias about is_write_index is not, that flag is always forced to false on the follower.

Copy link
Contributor

@henningandersen henningandersen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made a suggestion, otherwise LGTM.

docs/reference/ccr/index.asciidoc Outdated Show resolved Hide resolved
@lockewritesdocs lockewritesdocs merged commit 33b72f3 into elastic:master Jan 28, 2022
@lockewritesdocs lockewritesdocs deleted the docs__clarify-ccr-alias-replication branch January 28, 2022 18:24
jtibshirani pushed a commit to jtibshirani/elasticsearch that referenced this pull request Jan 28, 2022
* [DOCS] Add note that write indices are not replicated

* Clarify note about is_write_index

* Clarify leader aliases with is_write_index

Co-authored-by: Henning Andersen <[email protected]>

Co-authored-by: Henning Andersen <[email protected]>
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jan 28, 2022
* [DOCS] Add note that write indices are not replicated

* Clarify note about is_write_index

* Clarify leader aliases with is_write_index

Co-authored-by: Henning Andersen <[email protected]>

Co-authored-by: Henning Andersen <[email protected]>
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jan 28, 2022
* [DOCS] Add note that write indices are not replicated

* Clarify note about is_write_index

* Clarify leader aliases with is_write_index

Co-authored-by: Henning Andersen <[email protected]>

Co-authored-by: Henning Andersen <[email protected]>
lockewritesdocs pushed a commit that referenced this pull request Jan 28, 2022
* [DOCS] Add note that write indices are not replicated

* Clarify note about is_write_index

* Clarify leader aliases with is_write_index

Co-authored-by: Henning Andersen <[email protected]>

Co-authored-by: Henning Andersen <[email protected]>

Co-authored-by: Henning Andersen <[email protected]>
lockewritesdocs pushed a commit that referenced this pull request Jan 28, 2022
* [DOCS] Add note that write indices are not replicated

* Clarify note about is_write_index

* Clarify leader aliases with is_write_index

Co-authored-by: Henning Andersen <[email protected]>

Co-authored-by: Henning Andersen <[email protected]>

Co-authored-by: Henning Andersen <[email protected]>
weizijun added a commit to weizijun/elasticsearch that referenced this pull request Jan 31, 2022
* upstream/master: (100 commits)
  Avoid duplicate _type fields in v7 compat layer (elastic#83239)
  Bump bundled JDK to 17.0.2+8 (elastic#83243)
  [DOCS] Correct header syntax (elastic#83275)
  Add unit tests for indices.recovery.max_bytes_per_sec default values (elastic#83261)
  [DOCS] Add note that write indices are not replicated (elastic#82997)
  Add notes on indexing to kNN search guide (elastic#83188)
  Fix get-snapshot-api :docs:integTest (elastic#83273)
  FilterPathBasedFilter support match fieldname with dot (elastic#83178)
  Fix compilation issues in example-plugins (elastic#83258)
  fix ClusterStateListener javadoc (elastic#83246)
  Speed up Building Indices Lookup in Metadata (elastic#83241)
  Mute whole suite for elastic#82502 (elastic#83252)
  Make PeerFinder log messages happier (elastic#83222)
  [Docs] Add supported _terms_enum field types (elastic#83244)
  Add an aggregator for IPv4 and IPv6 subnets (elastic#82410)
  [CI] Fix 70_time_series/default sort yaml test failures (elastic#83217)
  Update test-failure Issue Template to include "needs:triage" label elastic#83226
  Add an index->step cache to the PolicyStepsRegistry (elastic#82316)
  Improve support for joda datetime to java datetime transition in Painless (elastic#83099)
  Fix joda migration for week based methods in Painless (elastic#83232)
  ...

# Conflicts:
#	x-pack/plugin/rollup/src/main/java/org/elasticsearch/xpack/rollup/v2/TransportRollupAction.java
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Indexing/CCR Issues around the Cross Cluster State Replication features >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v7.16.3 v7.17.1 v8.0.0-rc2 v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Improve documentation on CCR alias replication
6 participants