nearpod/zookeeper

Apache ZooKeeper Kubernetes StatefulSet 镜像

镜像概述和主要用途

本镜像旨在通过Kubernetes的StatefulSets（有状态集）部署Apache ZooKeeper，提供可靠的分布式协调服务。基于Kubernetes ZooKeeper K8SZK项目启发，适用于需要在Kubernetes环境中构建ZooKeeper集群的场景。

核心功能和特性

• 环境基础：基于Ubuntu 16.04，使用OpenJDK 8u111 JRE和ZooKeeper 3.4.10稳定版
• 安全运行：以非root用户（默认zookeeper）运行ZooKeeper进程
• 标准目录结构：ZooKeeper安装于/opt/zookeeper，配置文件链接至/usr/etc/zookeeper/，可执行文件链接至/usr/bin，数据目录位于/var/lib/zookeeper
• 自动配置生成：通过zkGenConfig.sh脚本根据环境变量生成zoo.cfg、log4j.properties和jvm.env配置文件
• 健康检查：提供zkOk.sh脚本用于存活和就绪探针
• 指标收集：通过zkMetrics.sh脚本输出ZooKeeper运行指标

使用场景和适用范围

• Kubernetes集群中部署ZooKeeper分布式协调服务
• 需要持久化存储保证数据可靠性的场景
• 构建依赖ZooKeeper的分布式应用（如Kafka、Hadoop等）

使用方法和配置说明

限制

1. 不支持动态扩展：ZooKeeper 3.4.10（当前稳定版）无法安全更新集群成员
2. 不支持观察者角色：欢迎贡献相关功能
3. 必须使用持久卷：使用e***yDirs可能导致数据丢失

部署配置

Headless Service（无头服务）

ZooKeeper有状态集需要无头服务控制网络域，示例配置如下：

yaml
apiVersion: v1
kind: Service
metadata:
  name: zk-svc
  labels:
    app: zk-svc
spec:
  ports:
  - port: 2888
    name: server
  - port: 3888
    name: leader-election
  clusterIP: None
  selector:
    app: zk-svc

• server端口（2888）：用于 follower 同步 leader 的事务日志
• leader-election端口（3888）：用于集群 leader 选举

Stateful Set（有状态集）

有状态集配置需与无头服务匹配，并指定副本数。示例配置创建3节点ZooKeeper集群：

注意：由于不支持加权仲裁，必须选择奇数个副本（推荐1、3、5或7个），较大副本数会影响写性能，需谨慎选择。

yaml
apiVersion: apps/v1beta1
kind: StatefulSet
metadata:
  name: zk
spec:
  serviceName: zk-svc
  replicas: 3

容器配置

容器通过环境变量注入配置，zkGenConfig.sh脚本会生成相应配置文件。基础配置示例：

yaml
containers:
  - name: k8szk
    imagePullPolicy: Always
    image: ***-gcr.xuanyuan.run/google_samples/k8szk:v3
    ports:
    - containerPort: 2181
      name: client
    - containerPort: 2888
      name: server
    - containerPort: 3888
      name: leader-election
    env:
    - name: ZK_REPLICAS
      value: "3"
    - name: ZK_CLIENT_PORT
      value: "2181"
    - name: ZK_SERVER_PORT
      value: "2888"
    - name: ZK_ELECTION_PORT
      value: "3888"

副本配置

网络配置

注意：网络配置端口需与容器端口及无头服务配置一致，使用默认值时可省略环境变量。

ZooKeeper时间配置

ZooKeeper会话配置

数据保留配置

注意：ZooKeeper默认不清理旧事务日志和快照，可能导致磁盘占满。可通过以下变量配置自动清理策略。

JVM配置

日志级别配置

健康检查

使用zkOk.sh脚本配置存活和就绪探针：

yaml
readinessProbe:
  exec:
    command:
    - sh
    - -c
    - "zkOk.sh"
  initialDelaySeconds: 15
  timeoutSeconds: 5
livenessProbe:
  exec:
    command:
    - sh
    - -c
    - "zkOk.sh"
  initialDelaySeconds: 15
  timeoutSeconds: 5

存储配置

必须使用持久卷保证数据持久化，示例配置动态申请20GiB存储：

yaml
volumeClaimTemplates:
- metadata:
    name: datadir
    annotations:
      volume.alpha.kubernetes.io/storage-class: anything
  spec:
    accessModes: [ "ReadWriteOnce" ]
    resources:
      requests:
        storage: 20Gi

容器卷挂载配置：

yaml
volumeMounts:
- name: datadir
  mountPath: /var/lib/zookeeper

日志

日志输出固定为标准输出（stdout），符合容器化应用最佳实践，可利用Kubernetes现有日志轮转和保留机制。日志级别通过ZK_LOG_LEVEL环境变量调整。

指标

使用zkMetrics.sh脚本收集ZooKeeper运行指标，可通过Kubernetes定时任务收集：

bash
kubectl exec zk-0 zkMetrics.sh

示例输出：

zk_version	3.4.9-1757313, built on 08/23/2016 06:50 GMT
zk_avg_latency	0
zk_max_latency	0
zk_min_latency	0
zk_packets_received	21
zk_packets_sent	20
zk_num_alive_connections	1
zk_outstanding_requests	0
zk_server_state	follower
zk_znode_count	4
zk_watch_count	0
zk_ephemerals_count	0
zk_approximate_data_size	27
zk_open_file_descriptor_count	39
zk_max_file_descriptor_count	1048576

许可证声明

k8szk项目采用APL 2.0许可。

Copyright 2014 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.