Introducing our new CEO Don Johnson - Read More

bitnami/zookeeper

Verified Publisher

By VMware

Updated 1 day ago

Bitnami container image for ZooKeeper

Image
Integration & Delivery
Networking
Security
122

100M+

Bitnami package for Apache ZooKeeper

What is Apache ZooKeeper?

Apache ZooKeeper provides a reliable, centralized register of configuration data and services for distributed applications.

Overview of Apache ZooKeeper Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

docker run --name zookeeper bitnami/zookeeper:latest

Why use Bitnami Images?

  • Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
  • With Bitnami images the latest bug fixes and features are available as soon as possible.
  • Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
  • All our images are based on minideb -a minimalist Debian based container image that gives you a small base container image and the familiarity of a leading Linux distribution- or scratch -an explicitly empty image-.
  • All Bitnami images available in Docker Hub are signed with Notation. Check this post to know how to verify the integrity of the images.
  • Bitnami container images are released on a regular basis with the latest distribution packages available.

Looking to use Apache ZooKeeper in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

How to deploy Apache ZooKeeper in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami Apache ZooKeeper Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.

Only latest stable branch maintained in the free Bitnami catalog

Starting December 10th 2024, only the latest stable branch of any container will receive updates in the free Bitnami catalog. To access up-to-date releases for all upstream-supported branches, consider upgrading to Bitnami Premium. Previous versions already released will not be deleted. They are still available to pull from DockerHub.

Please check the Bitnami Premium page in our partner Arrow Electronics for more information.

Supported tags and respective Dockerfile links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

You can see the equivalence between the different tags by taking a look at the tags-info.yaml file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml.

Subscribe to project updates by watching the bitnami/containers GitHub repo.

Get this image

The recommended way to get the Bitnami Apache ZooKeeper Docker Image is to pull the prebuilt image from the Docker Hub Registry.

docker pull bitnami/zookeeper:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

docker pull bitnami/zookeeper:[TAG]

If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build command. Remember to replace the APP, VERSION and OPERATING-SYSTEM path placeholders in the example command below with the correct values.

git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .

Persisting your data

If you remove the container all your data and configurations will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

Note! If you have already started using Apache ZooKeeper, follow the steps on backing up and restoring to pull the data from your running container down to your host.

The image exposes a volume at /bitnami/zookeeper for the Apache ZooKeeper data. For persistence you can mount a directory at this location from your host. If the mounted directory is empty, it will be initialized on the first run.

docker run -v /path/to/zookeeper-persistence:/bitnami/zookeeper bitnami/zookeeper:latest

or by modifying the docker-compose.yml file present in this repository:

services:
  zookeeper:
  ...
    volumes:
      - /path/to/zookeeper-persistence:/bitnami/zookeeper
  ...

NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID 1001.

Connecting to other containers

Using Docker container networking, an Apache ZooKeeper server running inside a container can easily be accessed by your application containers.

Containers attached to the same network can communicate with each other using the container name as the hostname.

Using the Command Line

In this example, we will create an Apache ZooKeeper client instance that will connect to the server instance that is running on the same docker network as the client.

Step 1: Create a network

docker network create app-tier --driver bridge

Step 2: Launch the Apache ZooKeeper server instance

Use the --network app-tier argument to the docker run command to attach the Apache ZooKeeper container to the app-tier network.

docker run -d --name zookeeper-server \
    --network app-tier \
    bitnami/zookeeper:latest

Step 3: Launch your Apache ZooKeeper client instance

Finally we create a new container instance to launch the Apache ZooKeeper client and connect to the server created in the previous step:

docker run -it --rm \
    --network app-tier \
    bitnami/zookeeper:latest zkCli.sh -server zookeeper-server:2181  get /
Using a Docker Compose file

When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new bridge network named app-tier. In this example we assume that you want to connect to the Apache ZooKeeper server from your own custom application image which is identified in the following snippet by the service name myapp.

version: '2'

networks:
  app-tier:
    driver: bridge

services:
  zookeeper:
    image: 'bitnami/zookeeper:latest'
    networks:
      - app-tier
  myapp:
    image: 'YOUR_APPLICATION_IMAGE'
    networks:
      - app-tier

IMPORTANT:

  1. Please update the YOUR_APPLICATION_IMAGE placeholder in the above snippet with your application image
  2. In your application container, use the hostname zookeeper to connect to the Apache ZooKeeper server

Launch the containers using:

docker-compose up -d

Configuration

Environment variables

Customizable environment variables

NameDescriptionDefault Value
ZOO_DATA_LOG_DIRZooKeeper directory where data is stored.nil
ZOO_PORT_NUMBERZooKeeper client port.2181
ZOO_SERVER_IDID of the server in the ensemble.1
ZOO_SERVERSComma, space or semi-colon separated list of servers.nil
ZOO_ENABLE_ADMIN_SERVERWhether to enable the ZooKeeper admin server.yes
ZOO_ADMIN_SERVER_PORT_NUMBERZooKeeper admin server port.8080
ZOO_PEER_TYPEZookeeper Node Peer typenil
ZOO_TICK_TIMEBasic time unit in milliseconds used by ZooKeeper for heartbeats.2000
ZOO_INIT_LIMITZooKeeper uses to limit the length of time the ZooKeeper servers in quorum have to connect to a leader10
ZOO_SYNC_LIMITHow far out of date a server can be from a leader.5
ZOO_MAX_CNXNSLimits the total number of concurrent connections that can be made to a ZooKeeper server. Setting it to 0 entirely removes the limit.0
ZOO_MAX_CLIENT_CNXNSLimits the number of concurrent connections that a single client may make to a single member of the ZooKeeper ensemble.60
ZOO_AUTOPURGE_INTERVALThe time interval in hours for which the autopurge task is triggered. Set to a positive integer (1 and above) to enable auto purging of old snapshots and log files.0
ZOO_AUTOPURGE_RETAIN_COUNTWhen auto purging is enabled, ZooKeeper retains the most recent snapshots and the corresponding transaction logs in the dataDir and dataLogDir respectively to this number and deletes the rest. Minimum value is 3.3
ZOO_LOG_LEVELZooKeeper log level. Available levels are: ALL, DEBUG, INFO, WARN, ERROR, FATAL, OFF, TRACE.INFO
ZOO_4LW_COMMANDS_WHITELISTList of whitelisted 4LW commands.srvr, mntr
ZOO_RECONFIG_ENABLEDEnable ZooKeeper Dynamic Reconfiguration.no
ZOO_LISTEN_ALLIPS_ENABLEDListen for connections from its peers on all available IP addresses.no
ZOO_ENABLE_PROMETHEUS_METRICSExpose Prometheus metrics.no
ZOO_PROMETHEUS_METRICS_PORT_NUMBERPort where a Jetty server will expose Prometheus metrics.7000
ZOO_MAX_SESSION_TIMEOUTMaximum session timeout in milliseconds that the server will allow the client to negotiate.40000
ZOO_PRE_ALLOC_SIZEBlock size for transaction log file.65536
ZOO_SNAPCOUNTThe number of transactions recorded in the transaction log before a snapshot can be taken (and the transaction log rolled).100000
ZOO_HC_TIMEOUTTimeout for the Zookeeper healthcheck script (in seconds).5
ZOO_TLS_CLIENT_ENABLEEnable TLS for client communication.false
ZOO_TLS_PORT_NUMBERZookeeper TLS port.3181
ZOO_TLS_CLIENT_KEYSTORE_FILEKeyStore file.nil
ZOO_TLS_CLIENT_KEYSTORE_PASSWORDKeyStore file password.nil
ZOO_TLS_CLIENT_TRUSTSTORE_FILETrustStore file.nil
ZOO_TLS_CLIENT_TRUSTSTORE_PASSWORDTrustStore file password.nil
ZOO_TLS_CLIENT_AUTHSpecifies options to authenticate TLS connections from clients. Available values are: none, want, need.need
ZOO_TLS_QUORUM_ENABLEEnable TLS for quorum communication.false
ZOO_TLS_QUORUM_KEYSTORE_FILEKeyStore file.nil
ZOO_TLS_QUORUM_KEYSTORE_PASSWORDKeyStore file password.nil
ZOO_TLS_QUORUM_TRUSTSTORE_FILETrustStore file.nil
ZOO_TLS_QUORUM_TRUSTSTORE_PASSWORDTrustStore file password.nil
ZOO_TLS_QUORUM_CLIENT_AUTHSpecifies options to authenticate TLS connections from clients. Available values are: none, want, need.need
JVMFLAGSDefault JVMFLAGS for the ZooKeeper process.nil
ZOO_HEAP_SIZESize in MB for the Java Heap options (Xmx and XMs). This env var is ignored if Xmx an Xms are configured via JVMFLAGS.1024
ALLOW_ANONYMOUS_LOGINIf set to true, Allow to accept connections from unauthenticated usersno
ZOO_ENABLE_AUTHEnable ZooKeeper auth. It uses SASL/Digest-MD5.no
ZOO_CLIENT_USERUser that will use ZooKeeper clients to auth.nil
ZOO_SERVER_USERSComma, semicolon or whitespace separated list of user to be created.nil
ZOO_CLIENT_PASSWORDPassword that will use ZooKeeper clients to auth.nil
ZOO_SERVER_PASSWORDSComma, semicolon or whitespace separated list of passwords to assign to users when created. Example: pass4user1, pass4user2, pass4admin.nil
ZOO_ENABLE_QUORUM_AUTHEnable ZooKeeper auth. It uses SASL/Digest-MD5.no
ZOO_QUORUM_LEARNER_USERUser that will be used by the ZooKeeper Quorum Learner to auth with Quorum Servers.nil
ZOO_QUORUM_LEARNER_PASSWORDPassword that will use ZooKeeper Quorum Learner to auth.nil
ZOO_QUORUM_SERVER_USERSComma, semicolon or whitespace separated list of quorum users to be created.nil
ZOO_QUORUM_SERVER_PASSWORDSComma, semicolon or whitespace separated list of passwords to assign to quorum users when created. Example: pass4user1, pass4user2, pass4admin.nil

Read-only environment variables

NameDescriptionValue
ZOO_BASE_DIRZooKeeper installation directory.${BITNAMI_ROOT_DIR}/zookeeper
ZOO_VOLUME_DIRZooKeeper persistence directory./bitnami/zookeeper
ZOO_DATA_DIRZooKeeper directory where data is stored.${ZOO_VOLUME_DIR}/data
ZOO_CONF_DIRZooKeeper configuration directory.${ZOO_BASE_DIR}/conf
ZOO_DEFAULT_CONF_DIRZooKeeper default configuration directory.${ZOO_BASE_DIR}/conf.default
ZOO_CONF_FILEZooKeeper configuration file.${ZOO_CONF_DIR}/zoo.cfg
ZOO_LOG_DIRDirectory where ZooKeeper logs are stored.${ZOO_BASE_DIR}/logs
ZOO_LOG_FILEDirectory where ZooKeeper logs are stored.${ZOO_LOG_DIR}/zookeeper.out
ZOO_BIN_DIRZooKeeper directory for binary executables.${ZOO_BASE_DIR}/bin
ZOO_DAEMON_USERZooKeeper system user.zookeeper
ZOO_DAEMON_GROUPZooKeeper system group.zookeeper

When you start the Apache ZooKeeper image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:

  • For manual execution add a -e option with each variable and value:
docker run --name zookeeper -e ZOO_SERVER_ID=1 bitnami/zookeeper:latest
  • For docker-compose add the variable name and value under the application section in the docker-compose.yml file present in this repository:
services:
  zookeeper:
  ...
    environment:
      - ZOO_SERVER_ID=1
  ...
A

Note: the README for this container is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/containers/blob/main/bitnami/zookeeper/README.md

Docker Pull Command

docker pull bitnami/zookeeper
Bitnami