[DOCS-13426] Fix confusion with startBalancer and activeWindows Created: 19/Feb/20  Updated: 30/Oct/23  Resolved: 16/Jun/21

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Improvement Priority: Major - P3
Reporter: Nic Cottrell Assignee: Andrew Feierabend (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 2 years, 34 weeks ago
Epic Link: DOCSP-11701
Story Points: 2

 Description   

Description

The docs for setting up a balancing window include a note:

> Do not use the sh.startBalancer() method when you have set an activeWindow.

I believe this is because it's not necessary to call startBalancer again as step 3 already does this via sh.setBalancerState( true ) (see code)

For deployments where the balancer has accidentally been disabled via sh.setBalancerState( false )}, the only way to re-enable the balancer is to run {{sh.startBalancer(). We've confirmed that this does not force the balancer to start outside the window.

Proposed changes

1. Remove the comment Do not use the sh.startBalancer() method when you have set an activeWindow. or replace with As the balancer was activated in step 3, you do not need to call sh.startBalancer() again

1. Add something like If the balancer has been disabled for maintenance, you can re-enable it again with sh.startBalancer() and it will activate again only at the next window.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

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



 Comments   
Comment by Githook User [ 16/Jun/21 ]

Author:

{'name': 'andf-mongodb', 'email': 'andrew.feierabend@mongodb.com', 'username': 'andf-mongodb'}

Message: DOCS-13426 clarify startBalancer for activeWindow
Branch: v4.0
https://github.com/mongodb/docs/commit/ba12037aa620a60b2243f305b44b34e4d9a3f47a

Comment by Githook User [ 16/Jun/21 ]

Author:

{'name': 'andf-mongodb', 'email': 'andrew.feierabend@mongodb.com', 'username': 'andf-mongodb'}

Message: DOCS-13426 clarify startBalancer for activeWindow
Branch: v4.2
https://github.com/mongodb/docs/commit/e26dfe56fec290db29c9ff668c05cb7ee564b9dc

Comment by Githook User [ 16/Jun/21 ]

Author:

{'name': 'andf-mongodb', 'email': 'andrew.feierabend@mongodb.com', 'username': 'andf-mongodb'}

Message: DOCS-13426 clarify startBalancer for activeWindow
Branch: v4.4
https://github.com/mongodb/docs/commit/ee9658adca3e3ad4f79d7110a872486ff5462565

Comment by Githook User [ 16/Jun/21 ]

Author:

{'name': 'andf-mongodb', 'email': 'andrew.feierabend@mongodb.com', 'username': 'andf-mongodb'}

Message: DOCS-13426 clarify startBalancer for activeWindow
Branch: master
https://github.com/mongodb/docs/commit/ef155f3f16c06156041061f0cba5dc50f80ac8df

Comment by Ravind Kumar (Inactive) [ 19/Feb/20 ]

> We've confirmed that this does not force the balancer to start outside the window.

This was confirmed for 3.6 -> 4.4? Just confirming, if so this is a simple change.

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