ZooKeeper: Because Coordinating Distributed Systems is a Zoo

ZooKeeper is a high-performance coordination service for distributed applications. It exposes common services - such as naming, configuration management, synchronization, and group services - in a simple interface so you don't have to write them from scratch. You can use it off-the-shelf to implement consensus, group management, leader election, and presence protocols. And you can build on it for your own, specific needs.

The following documents describe concepts and procedures to get you started using ZooKeeper. If you have more questions, please ask the mailing list or browse the archives.

• ZooKeeper Overview Technical Overview Documents for Client Developers, Administrators, and Contributors
  • Overview - a bird's eye view of ZooKeeper, including design concepts and architecture
  • Getting Started - a tutorial-style guide for developers to install, run, and program to ZooKeeper
  • Release Notes - new developer and user facing features, improvements, and incompatibilities
• Developers Documents for Developers using the ZooKeeper Client API
  • API Docs - the technical reference to ZooKeeper Client APIs
  • Programmer's Guide - a client application developer's guide to ZooKeeper
  • ZooKeeper Use Cases - a series of use cases using the ZooKeeper.
  • ZooKeeper Java Example - a simple Zookeeper client application, written in Java
  • Barrier and Queue Tutorial - sample implementations of barriers and queues
  • ZooKeeper Recipes - higher level solutions to common problems in distributed applications
• Administrators & Operators Documents for Administrators and Operations Engineers of ZooKeeper Deployments
  • Administrator's Guide - a guide for system administrators and anyone else who might deploy ZooKeeper
  • Quota Guide - a guide for system administrators on Quotas in ZooKeeper.
  • Snapshot and Restore Guide - a guide for system administrators on take snapshot and restore ZooKeeper.
  • JMX - how to enable JMX in ZooKeeper
  • Hierarchical Quorums - a guide on how to use hierarchical quorums
  • Oracle Quorum - the introduction to Oracle Quorum increases the availability of a cluster of 2 ZooKeeper instances with a failure detector.
  • Observers - non-voting ensemble members that easily improve ZooKeeper's scalability
  • Dynamic Reconfiguration - a guide on how to use dynamic reconfiguration in ZooKeeper
  • ZooKeeper CLI - a guide on how to use the ZooKeeper command line interface
  • ZooKeeper Tools - a guide on how to use a series of tools for ZooKeeper
  • ZooKeeper Monitor - a guide on how to monitor the ZooKeeper
  • Audit Logging - a guide on how to configure audit logs in ZooKeeper Server and what contents are logged.
• Contributors Documents for Developers Contributing to the ZooKeeper Open Source Project
  • ZooKeeper Internals - assorted topics on the inner workings of ZooKeeper
• Miscellaneous ZooKeeper Documentation
  • Wiki
  • FAQ