# zkdash

**Repository Path**: LucasDot/zkdash

## Basic Information

- **Project Name**: zkdash
- **Description**: zookeeper客户端
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-11-17
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# zkdash

zkdash是一个zookeeper的管理界面，也可以作为任何基于zookeeper的配置管理项目比如：Qconf

## 开发规划
todo

### zkdash页面展示

![zkdash_search](docs/images/zkdash_search.png)

![zkdash_snapshot](docs/images/zkdash_snapshot.png)

![zkdash_zookeeper](docs/images/zkdash_zookeeper.png)


### 安装与运行
安装步骤（基于docker）

 - 编译镜像
  
   ```
   docker build -t laughstorm/zkdash:1.0 .
   ```

 - 创建容器
   ```
    docker run -d -p 8888:8888 \
       -e MYSQL_HOST=172.17.0.2 \
       -e MYSQL_PORT=3306 \
       -e MYSQL_USER=root \
       -e MYSQL_PASSWD=root \
       --name zkdash --restart=always \
       laughstorm/zkdash:1.0
   ```

 - 同步数据库表结构
      容器创建成功后，首先创建数据库zkdash，并设置数据库的用户名和密码

      设置完成后进入容器，进行初始化数据库
   ```
 	cd /home/zkdash
 	python ./bin/syncdb.py   # 注意执行路径必须为./bin/syncdb.py
   ```
	说明：数据库使用mysql，创建表结构前请先配置数据库连接信息(创建容器制定的环境变量)


### 配置文件说明
配置说明

数据库配置项(DATABASE)

 - db: 数据库名称
 - host: ip地址
 - port: 端口号
 - user: 用户名
 - passwd: 密码

全局配置项

 - USE_QCONF: 是否通过QConf获取zookeeper数据（使用该项可以提高树形展示配置信息的响应速度）


### 与QConf的搭配使用

 - 反馈服务器地址：http://ip:port/api/v1/feedback（Agent同步状况查看依赖此反馈信息）


### 注意事项
 1. 新增节点需要先指定父节点，并且只能逐级增加
 2. 当设置使用QConf获取zookeeper数据时，zookeeper管理菜单下的zookeeper集群名称需要与QConf
    客户端Agent配置文件的idc名称一致