Improve ShardRoutingState docs #126875
Open
Improve ShardRoutingState docs #126875
+18
−7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DiannaHohensee
added
>non-issue
:Distributed Coordination/Allocation
|
Pinging @elastic/es-distributed-coordination (Team:Distributed Coordination) |
DaveCTurner
reviewed
Apr 16, 2025
server/src/main/java/org/elasticsearch/cluster/routing/ShardRoutingState.java
Outdated
Show resolved
Hide resolved
| * The shard is not assigned to any node; any data which it contains is unavailable to the cluster. | ||
| * | ||
| * A shard transitions from {@link #UNASSIGNED} to {@link #INITIALIZING} when the master wants an assigned data node to create or start | ||
| * recovering this shard copy. A shard may also transition back to {@link #UNASSIGNED} in case of an assignment failure. |
There was a problem hiding this comment.
Really any failure puts it back to UNASSIGNED - the phrase "assignment failure" indicates to me a problem in allocation (the process which assigns shards to nodes) but in fact most unassignments will be due to other failures.
Suggested change
| * recovering this shard copy. A shard may also transition back to {@link #UNASSIGNED} in case of an assignment failure. | |
| * recovering this shard copy. A shard may also transition back to {@link #UNASSIGNED} in case of a failure. |
Comment on lines
+25
to
+26
| * The shard is assigned to a node and the recovery process has begun. The shard data is not yet available on the node initializing the | ||
| * shard. |
There was a problem hiding this comment.
Tiny nitpick: if the shard is in IndexShardState#POST_RECOVERY then it can respond to searches even before it's moved to ShardRoutingState#STARTED in the cluster state.
server/src/main/java/org/elasticsearch/cluster/routing/ShardRoutingState.java
Outdated
Show resolved
Hide resolved
…utingState.java Co-authored-by: David Turner <david.turner@elastic.co>
…utingState.java Co-authored-by: David Turner <david.turner@elastic.co>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@DaveCTurner Improving the class docs in reference to this comment thread.
I want to reference it in the other PR, so I'm committing it separately.