zookeeper README

The project's README from github.com/apache/zookeeper. As one markdown file: README.md.

Apache ZooKeeper GitHub Actions CI Travis CI Maven Central License

https://zookeeper.apache.org/

For the latest information about Apache ZooKeeper, please visit our website at:

https://zookeeper.apache.org

and our wiki, at:

https://cwiki.apache.org/confluence/display/ZOOKEEPER

Packaging/release artifacts

Either downloaded from https://zookeeper.apache.org/releases.html or found in zookeeper-assembly/target directory after building the project with maven.

apache-zookeeper-[version].tar.gz

    Contains all the source files which can be built by running:
    mvn clean install

    To generate an aggregated apidocs for zookeeper-server and zookeeper-jute:
    mvn javadoc:aggregate
    (generated files will be at target/site/apidocs)

apache-zookeeper-[version]-bin.tar.gz

    Contains all the jar files required to run ZooKeeper
    Full documentation can also be found in the docs folder

As of version 3.5.5, the parent, zookeeper and zookeeper-jute artifacts are deployed to the central repository after the release is voted on and approved by the Apache ZooKeeper PMC:

https://repo1.maven.org/maven2/org/apache/zookeeper/zookeeper

Contributing

We always welcome new contributors to the project! See How to Contribute for details on how to submit patches as pull requests and other aspects of our contribution workflow.

zookeeper (apache/zookeeper)

Searching Database…

12.8K ·GitHub
What is this?Apache ZooKeeper is an open-source Java service for coordinating distributed systems — its repo topics cover coordination, consensus, configuration management, service discovery and a distributed key-value store.
Is it a server I deploy, or a library I add to my Java project?Both shapes are official: releases include a bin tarball with all the jars required to run ZooKeeper, and the zookeeper artifacts are published to Maven Central for use as a dependency.
How do I get it running?Download the apache-zookeeper-[version]-bin.tar.gz release from the project website, or build from source with Maven — the assembled packages end up in zookeeper-assembly/target.
What do I need installed to build or run it?A JDK and Maven: it is a Java project assembled with mvn clean install, while the bin tarball already bundles the jars needed to run it.
Where can I run it — is it tied to a particular OS?No: it is plain Java shipped as OS-agnostic tar.gz archives, so it runs anywhere a JVM is available — Linux servers, macOS or Windows.
Is ZooKeeper still an actively maintained project?Yes — the Apache project is not archived, runs GitHub Actions pipelines for CI, end-to-end tests, scripts and its website, and takes part in Hacktoberfest.
What are similar projects?nacos, cassandra, CMAK, nebula, tikv, apollo, spring-cloud-alibaba, etcd
Creator
apache
Size
156.8 MB
Stars
12.8K
Updated
CommitOct 05
Age
17y
Commits · 90 Days