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 API example + diagrams to shard allocation awareness docs #108390

Merged
merged 5 commits into from May 8, 2024

Conversation

shainaraskas
Copy link
Contributor

@shainaraskas shainaraskas commented May 7, 2024

Based on customer feedback, adds an example cluster update settings API call inline for the shard allocation awareness docs. To address concerns about how to use zones in clusters overall, I added a note to the Resilience in larger clusters guidance. could consider adding diagrams to that resilience doc down the line as a part of the suggested architectures work.

Also adds diagrams so the relationship between shards and nodes given a specific node attribute is clearer.

platform docs reviewers: I kinda made these diagrams up. what do you think?

Changed pages

@shainaraskas shainaraskas added >docs General docs changes Team:Docs Meta label for docs team v8.14.0 v8.13.3 v8.15.0 v8.13.4 labels May 7, 2024
Copy link

github-actions bot commented May 7, 2024

Documentation preview:

@shainaraskas shainaraskas marked this pull request as ready for review May 7, 2024 20:12
@elasticsearchmachine
Copy link
Collaborator

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

@shainaraskas shainaraskas requested a review from a team May 7, 2024 20:12
@shainaraskas shainaraskas added the :Distributed/Allocation All issues relating to the decision making around placing a shard (both master logic & on the nodes) label May 7, 2024
@elasticsearchmachine elasticsearchmachine added the Team:Distributed Meta label for distributed team label May 7, 2024
@elasticsearchmachine
Copy link
Collaborator

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

@shainaraskas shainaraskas requested a review from a team May 7, 2024 20:14
Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

Looks good, thanks @shainaraskas. I left a few tiny nits.

docs/reference/high-availability/cluster-design.asciidoc Outdated Show resolved Hide resolved
if you want Elasticsearch to distribute shards across different racks, you might
set an awareness attribute called `rack_id` in each node's `elasticsearch.yml`
config file.
. In each node's `elasticsearch.yml` config file, specify the location of each node
Copy link
Contributor

Choose a reason for hiding this comment

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

You can specify the location of each node with a custom node attribute by setting a value in elasticsearch.yml or using the -E command line argument. I agree that it'd be good to mention that the setting goes in elasticsearch.yml, but the first sentence in this paragraph should really apply to both methods.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks @DaveCTurner! I've restructured this step to take your feedback into consideration:

image

Copy link
Member

@chriscressman chriscressman left a comment

Choose a reason for hiding this comment

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

LGTM and diagrams are clear 💯

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

LGTM thanks @shainaraskas

@shainaraskas shainaraskas merged commit 9d9f23c into elastic:main May 8, 2024
5 checks passed
markjhoy pushed a commit to markjhoy/elasticsearch that referenced this pull request May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed/Allocation All issues relating to the decision making around placing a shard (both master logic & on the nodes) >docs General docs changes Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team v8.13.3 v8.13.4 v8.14.0 v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants