How to Install and Use zkdash: A Zookeeper Management UI Guide

zkdash

zkdash is a web‑based management interface for Zookeeper that can also serve as a configuration management front‑end for projects based on Zookeeper, such as QConf.

zkdash Interface Overview

Installation and Running

Installation steps:

Install and run MySQL.

Install Python 2.7.

Download zkdash:

git clone https://github.com/ireaderlab/zkdash.git

Install dependencies:

cd zkdash
pip install -r requirements.txt

Configure the configuration file: Modify the ./conf/conf.yml file in the current directory as needed; detailed explanations are provided later.

Synchronize the database schema:

cd zkdash
python ./bin/syncdb.py

Note: The database uses MySQL; configure the connection information before creating tables.

Run the application:

cd zkdash
python init.py -port=8888

Note: On first run, you need to add the monitored Zookeeper cluster IP information in the Zookeeper management menu.

Configuration File Details

Database configuration (DATABASE):

db: database name

host: IP address

port: port number

user: username

passwd: password

Global configuration:

USE_QCONF: whether to obtain Zookeeper data via QConf (enabling this can improve the response speed of tree‑structured configuration display).

Using zkdash with QConf

Feedback server address: http://ip:port/api/v1/feedback (the Agent’s synchronization status view depends on this feedback information).

Important Notes

When adding a new node, you must first specify its parent node and can only add nodes level by level.

If you enable QConf to fetch Zookeeper data, the Zookeeper cluster name in the Zookeeper management menu must match the IDC name in the QConf client Agent configuration file.