You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bookkeeper.apache.org by eo...@apache.org on 2021/01/27 07:43:31 UTC

[bookkeeper] branch master updated: Sync 4.12.0 autorecovery doc to lastest

This is an automated email from the ASF dual-hosted git repository.

eolivelli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git


The following commit(s) were added to refs/heads/master by this push:
     new 3f7da14  Sync 4.12.0 autorecovery doc to lastest
3f7da14 is described below

commit 3f7da147c08cfc5071899bed640c4f3bfe331e1c
Author: Michael Marshall <47...@users.noreply.github.com>
AuthorDate: Wed Jan 27 00:43:23 2021 -0700

    Sync 4.12.0 autorecovery doc to lastest
    
    Descriptions of the changes in this PR:
    
    Copying documentation updates for auto recovery from the `4.12.0` directory to the `latest` directory based on eolivelli's request in https://github.com/apache/bookkeeper/pull/2507.
    
    Reviewers: Enrico Olivelli <eo...@gmail.com>
    
    This closes #2516 from michaeljmarshall/update-latest-documentation
---
 site/docs/latest/admin/autorecovery.md | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/site/docs/latest/admin/autorecovery.md b/site/docs/latest/admin/autorecovery.md
index 4ff881c..5e3a8bc 100644
--- a/site/docs/latest/admin/autorecovery.md
+++ b/site/docs/latest/admin/autorecovery.md
@@ -45,10 +45,11 @@ AutoRecovery is a process that:
 * automatically detects when a {% pop bookie %} in your BookKeeper cluster has become unavailable and then
 * rereplicates all the {% pop ledgers %} that were stored on that bookie.
 
-AutoRecovery can be run in two ways:
+AutoRecovery can be run in three ways:
 
 1. On dedicated nodes in your BookKeeper cluster
 1. On the same machines on which your bookies are running
+1. On a combination of autorecovery nodes and bookie nodes
 
 ## Running AutoRecovery
 
@@ -64,21 +65,24 @@ If you start up AutoRecovery on a machine that is already running a bookie, then
 
 You can also start up AutoRecovery on a fresh machine if you'd like to create a dedicated cluster of AutoRecovery nodes.
 
+Note that if you _only_ want the AutoRecovery process to run on your dedicated AutoRecovery nodes, you must set `autoRecoveryDaemonEnabled` to `false` in the `bookkeeper` configuration. Otherwise,
+bookkeeper nodes will also handle rereplication work.
+
 ## Configuration
 
 There are a handful of AutoRecovery-related configs in the [`bk_server.conf`](../../reference/config) configuration file. For a listing of those configs, see [AutoRecovery settings](../../reference/config#autorecovery-settings).
 
 ## Disable AutoRecovery
 
-You can disable AutoRecovery at any time, for example during maintenance. Disabling AutoRecovery ensures that bookies' data isn't unnecessarily rereplicated when the bookie is only taken down for a short period of time, for example when the bookie is being updated or the configuration if being changed.
+You can disable AutoRecovery for the whole cluster at any time, for example during maintenance. Disabling AutoRecovery ensures that bookies' data isn't unnecessarily rereplicated when the bookie is only taken down for a short period of time, for example when the bookie is being updated or the configuration if being changed.
 
-You can disable AutoRecover using the [`bookkeeper`](../../reference/cli#bookkeeper-shell-autorecovery) CLI tool:
+You can disable AutoRecover for the whole cluster using the [`bookkeeper`](../../reference/cli#bookkeeper-shell-autorecovery) CLI tool:
 
 ```bash
 $ bin/bookkeeper shell autorecovery -disable
 ```
 
-Once disabled, you can reenable AutoRecovery using the [`enable`](../../reference/cli#bookkeeper-shell-autorecovery) shell command:
+Once disabled, you can reenable AutoRecovery for the whole cluster using the [`enable`](../../reference/cli#bookkeeper-shell-autorecovery) shell command:
 
 ```bash
 $ bin/bookkeeper shell autorecovery -enable