This document contains information about deploying, administering and maintaining BookKeeper. It also discusses best practices and common problems.
Running a BookKeeper instance
A typical BookKeeper installation comprises a set of bookies and a set of ZooKeeper replicas. The exact number of bookies depends on the quorum mode, desired throughput, and number of clients using this installation simultaneously. The minimum number of bookies is three for self-verifying (stores a message authentication code along with each entry) and four for generic (does not store a message authentication code with each entry), and there is no upper limit on the number of bookies. Increasing the number of bookies will, in fact, enable higher throughput.
For performance, we require each server to have at least two disks. It is possible to run a bookie with a single disk, but performance will be significantly lower in this case.
For ZooKeeper, there is no constraint with respect to the number of replicas. Having a single machine running ZooKeeper in standalone mode is sufficient for BookKeeper. For resilience purposes, it might be a good idea to run ZooKeeper in quorum mode with multiple servers. Please refer to the ZooKeeper documentation for detail on how to configure ZooKeeper with multiple replicas.
Starting and Stopping Bookies
To start a bookie, execute the following command:
The configuration parameters can be set in bookkeeper-server/conf/bk_server.conf.
The important parameters are:
To stop a bookie running in the background, execute the following command:
From time to time, we may make changes to the filesystem layout of the bookie, which are incompatible with previous versions of bookkeeper and require that directories used with previous versions are upgraded. If you upgrade your bookkeeper software, and an upgrade is required, then the bookie will fail to start and print an error such as:
BookKeeper provides a utility for upgrading the filesystem.
The upgrade application takes 3 possible switches,
To format the bookie metadata in Zookeeper, execute the following command once:
To format the bookie local filesystem data, execute the following command on each bookie node:
By default, the user will be prompted to confirm the format operation if old data exists.
BookKeeper uses slf4j for logging, with the log4j bindings enabled by default. To enable logging from a bookie, create a log4j.properties file and point the environment variable BOOKIE_LOG_CONF to the configuration file. The path to the log4j.properties file must be absolute.
Missing disks or directories
Replacing disks or removing directories accidentally can cause a bookie to fail while trying to read a ledger fragment which the ledger metadata has claimed exists on the bookie. For this reason, when a bookie is started for the first time, it's disk configuration is fixed for the lifetime of that bookie. Any change to the disk configuration of the bookie, such as a crashed disk or an accidental configuration change, will result in the bookie being unable to start with the following error:
If the change was the result of an accidental configuration change, the change can be reverted and the bookie can be restarted. However, if the change cannot be reverted, such as is the case when you want to add a new disk or replace a disk, the bookie must be wiped and then all its data re-replicated onto it. To do this, do the following:
The mechanism to prevent the bookie from starting up in the case of configuration changes exists to prevent the following silent failures:
Full or failing disks
A bookie can go into read-only mode if it detects problems with its disks. In read-only mode, the bookie will serve read requests, but will not allow any writes. Any ledger currently writing to the bookie will replace the bookie in its ensemble. No new ledgers will select the read-only bookie for writing.
The bookie goes into read-only mode in the following conditions.
Important parameters are:
Running Autorecovery nodes
To run autorecovery nodes, we execute the following command in every Bookie node:
Configuration parameters for autorecovery can be set in bookkeeper-server/conf/bk_server.conf.
Important parameters are:
Disabling Autorecovery during maintenance
It is useful to disable autorecovery during maintenance, for example, to avoid a Bookie's data being unnecessarily rereplicated when it is only being taken down for a short period to update the software, or change the configuration.
To disable autorecovery, run:
To reenable, run:
Autorecovery enable/disable only needs to be run once for the whole cluster, and not individually on each Bookie in the cluster.
Setting up a test ensemble
Sometimes it is useful to run a ensemble of bookies on your local machine for testing. We provide a utility for doing this. It will set up N bookies, and a zookeeper instance locally. The data on these bookies and of the zookeeper instance are not persisted over restarts, so obviously this should never be used in a production environment. To run a test ensemble of 10 bookies, do the following: