rightscale/zookeeper

镜像概述

本镜像基于官方ZooKeeper镜像（https://hub.docker.com/_/zookeeper 及 https://github.com/31z4/zookeeper-docker）修改而来，增加了对自动清理配置选项的支持，并通过自定义entrypoint脚本实现从consul/vault获取环境变量的功能。主要用于需要自动清理ZooKeeper数据且需外部配置管理的场景。

核心功能和特性

• 扩展自动清理配置：支持通过环境变量ZOO_AUTOPURGE_RETAIN_COUNT和ZOO_AUTOPURGE_PURGE_INTERVAL配置ZooKeeper自动清理功能
• 外部配置集成：自定义entrypoint脚本可从consul/vault获取并填充环境变量，便于配置集中管理
• 兼容性：保持与官方ZooKeeper镜像的核心功能和使用方式兼容，易于迁移和集成

使用场景和适用范围

• 生产环境中需要定期清理ZooKeeper事务日志和快照的场景
• 需要通过consul或vault进行配置管理的分布式系统
• 对ZooKeeper数据自动清理策略有自定义需求的应用

使用方法和配置说明

环境变量配置

基础环境变量（同官方ZooKeeper镜像）

• ZOO_MY_ID：当前ZooKeeper节点ID（集群模式必填，1-255）
• ZOO_SERVERS：集群节点配置，格式为server.1=host1:2888:3888;2181 server.2=host2:2888:3888;2181 ...

新增自动清理环境变量

• ZOO_AUTOPURGE_RETAIN_COUNT：自动清理时保留的快照数量，默认值为3
• ZOO_AUTOPURGE_PURGE_INTERVAL：自动清理间隔（小时），默认值为0（表示禁用自动清理）

Docker运行示例

单机模式（带自动清理配置）

bash
docker run -d \
  --name zookeeper \
  -p 2181:2181 \
  -e ZOO_AUTOPURGE_RETAIN_COUNT=5 \
  -e ZOO_AUTOPURGE_PURGE_INTERVAL=24 \
  docker.xuanyuan.run/your-image-name:tag

集群模式示例（3节点）

bash
# 节点1
docker run -d \
  --name zk1 \
  -p 2181:2181 \
  -e ZOO_MY_ID=1 \
  -e ZOO_SERVERS="server.1=zk1:2888:3888;2181 server.2=zk2:2888:3888;2181 server.3=zk3:2888:3888;2181" \
  -e ZOO_AUTOPURGE_RETAIN_COUNT=10 \
  -e ZOO_AUTOPURGE_PURGE_INTERVAL=12 \
  docker.xuanyuan.run/your-image-name:tag

# 节点2和节点3配置类似，仅需修改ZOO_MY_ID为2和3

Docker Compose示例

yaml
version: '3'
services:
  zookeeper:
    image: docker.xuanyuan.run/your-image-name:tag
    container_name: zookeeper
    ports:
      - "2181:2181"
      - "2888:2888"
      - "3888:3888"
    environment:
      ZOO_MY_ID: 1
      ZOO_SERVERS: "server.1=zookeeper:2888:3888;2181"
      ZOO_AUTOPURGE_RETAIN_COUNT: 5
      ZOO_AUTOPURGE_PURGE_INTERVAL: 24
    volumes:
      - zk-data:/data
      - zk-datalog:/datalog

volumes:
  zk-data:
  zk-datalog:

注意事项

• 启用自动清理功能时，需确保ZOO_AUTOPURGE_PURGE_INTERVAL设置为大于0的整数（单位：小时）
• 从consul/vault获取环境变量需确保容器可访问对应服务，具体配置需根据实际环境调整
• 集群模式下，所有节点的ZOO_SERVERS配置必须一致，且节点间网络互通