colovu/zookeeper

ZooKeeper

针对 ZooKeeper 应用的 Docker 镜像，用于提供 ZooKeeper 服务。

详细信息可参照：3.6.1官方说明

版本信息

• 3.6、latest
• 3.5

镜像信息

• 镜像地址：
  • Aliyun仓库：registry.cn-shenzhen.aliyuncs.com/colovu/zookeeper:3.6
  • DockerHub：colovu/zookeeper:3.6
• 依赖镜像：colovu/openjre:8

后续相关命令行默认使用https://hub.docker.com%E9%95%9C%E5%83%8F%E6%9C%8D%E5%8A%A1%E5%99%A8%E5%81%9A%E8%AF%B4%E6%98%8E

快速启动

Docker 快速启动命令

shell
$ docker run -d -e ALLOW_ANONYMOUS_LOGIN=yes colovu/zookeeper:3.6

Docker-Compose 快速启动命令

shell
# 从 Gitee 下载 Compose 文件
$ curl -sSL -o docker-compose.yml https://gitee.com/colovu/docker-zookeeper/raw/master/docker-compose.yml

# 从 Github 下载 Compose 文件
$ curl -sSL -o docker-compose.yml https://raw.githubusercontent.com/colovu/docker-zookeeper/master/docker-compose.yml

# 创建并启动容器
$ docker-compose up -d

默认对外声明

端口

• 2181：Zookeeper 业务客户端访问端口
• 2888：Follower 通讯端口（跟随者端口）
• 3888：Election 通讯端口（选举端口）
• 8080：AdminServer 端口（管理界面端口）

数据卷

镜像默认提供以下数据卷定义，默认数据分别存储在自动生成的应用名对应zookeeper子目录中：

shell
/var/log                # 日志输出（应用日志，非数据日志）；自动创建子目录zookeeper
/srv/conf               # 配置文件；自动创建子目录zookeeper
/srv/data               # 数据文件；自动创建子目录zookeeper
/srv/datalog            # 数据操作日志文件；自动创建子目录zookeeper

如需持久化存储数据，需在宿主机建立本地目录，并在初始化容器时进行映射。宿主机目录中若不存在对应Zookeeper子目录或数据文件，容器初始化时会自动创建。

容器配置

初始化ZooKeeper容器时，若配置文件zoo.cfg不存在，可通过命令行设置环境变量修改默认参数，示例：

shell
$ docker run -d -e "ZOO_INIT_LIMIT=10" --name zookeeper colovu/zookeeper

常规配置参数

常用环境变量：

• ALLOW_ANONYMOUS_LOGIN：默认值：no。是否允许***连接。若未设置ZOO_ENABLE_AUTH，则必须设为yes
• ZOO_LISTEN_ALLIPS_ENABLED：默认值：no。是否默认监听所有IP
• ZOO_TICK_TIME：默认值：2000。设置tickTime（基础时间单位，微秒），用于心跳、超时控制（如Session最小超时为2个Ticks）
• ZOO_INIT_LIMIT：默认值：10。设置initLimit（ticks为单位），控制从服务器与Leader连接及同步时间，数据量大时可增大
• ZOO_SYNC_LIMIT：默认值：5。设置syncLimit（ticks为单位），控制从服务器同步数据时间，差距过大将被剔除
• ZOO_MAX_CLIENT_CNXNS：默认值：60。设置maxClientCnxns，每个客户端允许的同时连接数（Socket层，按IP识别）
• ZOO_STANDALONE_ENABLED：默认值：false。启用Standalone模式。参考standaloneEnabled。3.5.0新增，控制服务器工作模式（Standalone/Distributed），启动后不可切换。设为false支持后续动态扩展
• ZOO_ADMINSERVER_ENABLED：默认值：true。是否启用管理服务器。参考admin.enableServer。3.5.0新增，内置Jetty服务器提供HTTP访问端口支持四字命令，默认8080端口，访问方式：http://localhost:8080/commands/[command name]
• ZOO_AUTOPURGE_PURGEINTERVAL：默认值：0。自动清理触发周期（小时），设为正整数启用快照及日志自动清理，0则禁用。参考autoPurge.purgeInterval
• ZOO_AUTOPURGE_SNAPRETAINCOUNT：默认值：3。自动清理时保留的最新快照/日志数量，其他将被清除，最小值3。参考autoPurge.snapRetainCount
• ZOO_4LW_COMMANDS_WHITELIST：默认值：srvr, mntr。四字命令白名单（逗号分隔），需设置才生效。参考4lw.commands.whitelist

可选配置参数

无需特殊需求时可使用默认值：

• ENV_DEBUG：默认值：false。是否输出容器调试信息，可设为1、true、yes
• ZOO_PORT_NUMBER：默认值：2181。客户端访问端口
• ZOO_MAX_CNXNS：默认值：0。服务器最大连接数，0为无限制
• ZOO_LOG4J_PROP：默认值：INFO,CONSOLE。日志输出级别及方式。级别：ALL, DEBUG, INFO, WARN, ERROR, FATAL, OFF, TRACE；方式（可多个，逗号分隔）：CONSOLE、ROLLINGFILE、TRACEFILE
• ZOO_RECONFIG_ENABLED：默认值：no。是否启用动态重新配置功能
• ZOO_ENABLE_PROMETHEUS_METRICS：默认值：no。是否输出Prometheus指标
• ZOO_PROMETHEUS_METRICS_PORT_NUMBER：默认值：7000。Prometheus指标输出端口
• ZOO_ENABLE_AUTH：默认值：no。是否启用认证（SASL/Digest-MD5加密）
• ZOO_CLIENT_USER：默认值：无。客户端认证用户名
• ZOO_CLIENT_PASSWORD：默认值：无。客户端认证密码
• ZOO_CLIENT_PASSWORD_FILE：默认值：无。客户端密码存储文件（容器内绝对路径）
• ZOO_SERVER_USERS：默认值：无。服务端用户列表（多用户用逗号、分号、空格分隔）
• ZOO_SERVER_PASSWORDS：默认值：无。服务端用户密码列表（多密码用逗号、分号、空格分隔，如：pass4user1, pass4user2）
• ZOO_SERVER_PASSWORDS_FILE：默认值：无。服务端密码存储文件（容器内绝对路径，格式同ZOO_SERVER_PASSWORDS）
• JVMFLAGS：默认值：无。JVM启动参数
• HEAP_SIZE：默认值：1024。Java堆大小（MB，Xmx与Xms），若JVMFLAGS已设置则忽略

集群配置参数

可通过以下参数配置ZooKeeper集群：

ZOO_SERVER_ID

默认值：1。服务器唯一ID（1~255）。若宿主机路径映射/srv/data且存在myid文件（容器内路径/srv/data/zookeeper/myid），则该参数失效。

ZOO_SERVERS

默认值：server.1=0.0.0.0:2888:3888。集群服务器列表，格式server.id=host:port:port（如server.2=192.168.0.1:2888:3888），多服务器用空格或逗号分隔。若宿主机路径映射/srv/conf且存在zoo.cfg文件（容器内路径/srv/conf/zookeeper/zoo.conf），则该参数失效，需手动修改配置文件并重启容器。

格式说明：server.X=A:B:C

• server.：固定关键字
• X：服务器ID（集群内唯一）
• A：IP地址或主机名
• B：与Leader通讯端口
• C：选举端口

更多信息参考 Zookeeper Dynamic Reconfiguration。

TLS配置参数

证书加密传输相关配置：

• ZOO_TLS_CLIENT_ENABLE：启用/禁用TLS，默认值：no
• ZOO_TLS_PORT_NUMBER：TLS传输端口，默认值：3181
• ZOO_TLS_CLIENT_KEYSTORE_FILE：客户端密钥库文件
• ZOO_TLS_CLIENT_KEYSTORE_PASSWORD：客户端密钥库密码
• ZOO_TLS_CLIENT_TRUSTSTORE_FILE：客户端信任库文件
• ZOO_TLS_CLIENT_TRUSTSTORE_PASSWORD：客户端信任库密码
• ZOO_TLS_QUORUM_ENABLE：启用/禁用Quorum TLS，默认值：no
• ZOO_TLS_QUORUM_KEYSTORE_FILE：Quorum密钥库文件
• ZOO_TLS_QUORUM_KEYSTORE_PASSWORD：Quorum密钥库密码
• ZOO_TLS_QUORUM_TRUSTSTORE_FILE：Quorum信任库文件
• ZOO_TLS_QUORUM_TRUSTSTORE_PASSWORD：Quorum信任库密码

安全

用户及密码

默认禁用无密码访问，生产环境建议使用用户名密码控制；测试时可启用***访问：

shell
ALLOW_ANONYMOUS_LOGIN=yes

通过ZOO_ENABLE_AUTH启用基于SASL/Digest-MD5的认证，需同时设置用户名密码。启用后，zkCli.sh需通过. /usr/local/bin/entrypoint.sh使用默认密码认证。

命令行示例：

shell
$ docker run -d -e ZOO_ENABLE_AUTH=yes \
	-e ZOO_SERVER_USERS=user1,user2 \
	-e ZOO_SERVER_PASSWORDS=pass4user1,pass4user2 \
	-e ZOO_CLIENT_USER=user1 \
	-e ZOO_CLIENT_PASSWORD=pass4user1 \
	colovu/zookeeper

Docker Compose配置示例：

yaml
services:
  zookeeper:
    ...
    environment:
      - ZOO_ENABLE_AUTH=yes
      - ZOO_SERVER_USERS=user1,user2
      - ZOO_SERVER_PASSWORDS=pass4user1,pass4user2
      - ZOO_CLIENT_USER=user1
      - ZOO_CLIENT_PASSWORD=pass4user1
    ...

容器安全

默认使用non-root用户运行应用以增强安全性，应用仅能操作指定路径及数据，适合生产环境。如需切换为root运行，启动命令中增加-u root。

注意事项

• 容器中应用启动参数不可配置为后台运行，否则容器会在启动后自动退出。

更新记录

• 3.6、latest
• 3.5

本文原始来源 https://github.com/colovu @ https://github.com