[DOCS-14542] Server: Update tables for resharding-related donor, recipient, and coordinator states Created: 08/Jun/21  Updated: 13/Nov/23  Resolved: 21/Jul/21

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 5.0.0-rc4, 5.1.0-rc0, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Max Hirschhorn Assignee: Naomi Pentrel (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Backports
backported by DOCS-14597 [SERVER] [Backport v5.0] Resharding d... Closed
Documented
documents SERVER-57952 Resharding donor shards cannot comple... Closed
Related
is related to DOCS-14084 Investigate changes in SERVER-52773: ... Closed
is related to DOCS-14193 Investigate changes in SERVER-50978: ... Closed
is related to DOCS-14195 Investigate changes in SERVER-51021: ... Closed
is related to DOCS-14197 Investigate changes in SERVER-50976: ... Closed
Participants:
Days since reply: 2 years, 29 weeks ago
Epic Link: DOCSP-9747
Story Points: 3

 Description   

Description

The Sharding team's work on the resharding project after DOCS-14197, DOCS-14195, DOCS-14193, and DOCS-14084 were originally completed has led to some of the donor, recipient, and coordinators either being renamed or removed altogether. The following is a summary of the changes with references to the code and documentation:

Donor states
  • The "preparing-to-mirror" state was renamed to "preparing-to-block-writes". The meaning changed slightly from before where the donor shard is now only about to prevent new incoming write operations to the collection being resharded and isn't actually preventing them yet. (see also SERVER-57952)
  • The "mirroring" state was renamed to "blocking-writes".
  • The "dropping" state was removed.
  • The numeric value for some of the states were reassigned - (5) is "error", (6) is "blocking-writes", and (7) is "done".

https://github.com/mongodb/mongo/blob/5bea2fccdf860e9119712d39b7d2da788fe63708/src/mongo/s/resharding/common_types.idl#L54-L64
https://docs.mongodb.com/v5.0/reference/command/serverStatus/#mongodb-serverstatus-serverstatus.shardingStatistics.resharding.donorState
https://docs.mongodb.com/v5.0/reference/operator/aggregation/currentOp/#mongodb-data--currentOp.donorState

Recipient states
  • An "awaiting-fetch-timestamp" was added. Recipients start in this state while waiting for all donor shards to transition into the "donating-initial-data" state.
  • The "steady-state" state was removed. It was effectively folded in with the "applying" state. The "Recipient shard data is not yet consistent with donor shard data, but will be when the steady state is reached." line can probably be removed.
  • The "renaming" state was removed.
  • The numeric value for some of the states were reassigned.

https://github.com/mongodb/mongo/blob/5bea2fccdf860e9119712d39b7d2da788fe63708/src/mongo/s/resharding/common_types.idl#L66-L77
https://docs.mongodb.com/v5.0/reference/command/serverStatus/#mongodb-serverstatus-serverstatus.shardingStatistics.resharding.recipientState
https://docs.mongodb.com/v5.0/reference/operator/aggregation/currentOp/#mongodb-data--currentOp.recipientState

Coordinator states
  • The "mirroring" state was renamed to "blocking-writes".
  • The "renaming" state was removed.
  • The "error" state was renamed to "aborting". In addition to this being due to unrecoverable error during the resharding operation, the coordinator will also report "aborting" if the user had manually canceled the resharding operation with the abortReshardCollection command.
  • The "committed" state was renamed to "committing".
  • The "done" state should be removed from the documentation. Unlike the donor's and recipient's "done" state, the coordinator never writes down or returns "done" to the user. CoordinatorStateEnum::kDone is used to trigger the coordinator state document to be removed.
  • The numeric value for some of the states were reassigned - (6) is "aborting" and (7) is "committing".

https://github.com/mongodb/mongo/blob/5bea2fccdf860e9119712d39b7d2da788fe63708/src/mongo/s/resharding/common_types.idl#L40-L52
https://docs.mongodb.com/v5.0/reference/command/serverStatus/#mongodb-serverstatus-serverstatus.shardingStatistics.resharding.coordinatorState
https://docs.mongodb.com/v5.0/reference/operator/aggregation/currentOp/#mongodb-data--currentOp.coordinatorState

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 21/Jul/21 ]

Author:

{'name': 'Naomi Pentrel', 'email': '5212232+npentrel@users.noreply.github.com', 'username': 'npentrel'}

Message: DOCS-14542: Update resharding related states
Branch: master
https://github.com/mongodb/docs/commit/e4bf5f8cfc657839c0c52365e10ba909b4f35d53

Comment by Max Hirschhorn [ 23/Jun/21 ]

Updated the description to account for how we recently reintroduced "preparing-to-block-writes" as part of SERVER-57952.

Comment by Jason Price [ 08/Jun/21 ]

jeffrey.allenHey Jeff, just assigning this to you as pretty much a test for my first triaged ticket. Feel free to remove the assignment. Cheers, Jason.

Generated at Thu Feb 08 08:10:37 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.