Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-13426

Fix confusion with startBalancer and activeWindows

      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.)

            Assignee:
            andrew.feierabend@mongodb.com Andrew Feierabend (Inactive)
            Reporter:
            nicholas.cottrell@mongodb.com Nic Cottrell
            Votes:
            0 Vote for this issue
            Watchers:
            9 Start watching this issue

              Created:
              Updated:
              Resolved:
              2 years, 44 weeks, 5 days ago