anldisr/etcdctl

etcdctl Docker镜像文档

镜像概述

本镜像包含etcdctl工具，这是etcd分布式键值存储系统的官方命令行客户端。etcdctl用于与etcd集群交互，执行各类管理操作，适用于容器化环境中对etcd集群进行便捷管理。

核心功能与特性

• 键值操作：支持设置、获取、删除、更新键值对，以及前缀查询、范围查询等
• 集群管理：添加、移除集群成员，查看成员状态
• 健康检查：检查etcd集群及节点健康状态
• 快照功能：创建集群数据快照、从快照恢复数据
• 事务支持：执行条件性键值操作
• Lease管理：创建和管理键的租约，实现自动过期功能
• 多API版本支持：兼容etcd v2和v3 API

使用场景

• etcd集群日常运维与管理
• 自动化脚本中与etcd集群交互（如CI/CD流程）
• 容器化环境中临时执行etcd操作
• 开发环境中快速测试etcd功能

使用方法

基本使用（Docker Run）

bash
# 查看etcdctl版本
docker run --rm etcdctl --version

# 连接到etcd集群获取键值（示例）
docker run --rm etcdctl \
  --endpoints=https://etcd-node1:2379,https://etcd-node2:2379 \
  --cacert=/etc/etcd/certs/ca.crt \
  --cert=/etc/etcd/certs/client.crt \
  --key=/etc/etcd/certs/client.key \
  get /my/key

环境变量配置

可通过环境变量简化命令参数：

常用命令示例

键值操作

bash
# 设置键值
docker run --rm -e ETCD_ENDPOINTS=http://etcd:2379 etcdctl put /message "Hello etcd"

# 获取键值
docker run --rm -e ETCD_ENDPOINTS=http://etcd:2379 etcdctl get /message

# 删除键
docker run --rm -e ETCD_ENDPOINTS=http://etcd:2379 etcdctl del /message

集群管理

bash
# 查看集群成员
docker run --rm -e ETCD_ENDPOINTS=http://etcd:2379 etcdctl member list

# 检查集群健康状态
docker run --rm -e ETCD_ENDPOINTS=http://etcd:2379 etcdctl endpoint health

快照操作

bash
# 创建快照（需挂载本地目录存储快照文件）
docker run --rm -v $(pwd):/snapshots -e ETCD_ENDPOINTS=http://etcd:2379 etcdctl snapshot save /snapshots/etcd-snapshot.db

# 恢复快照
docker run --rm -v $(pwd):/snapshots etcdctl snapshot restore /snapshots/etcd-snapshot.db --data-dir=/snapshots/etcd-data

Docker Compose 示例

yaml
version: '3'
services:
  etcdctl:
    image: etcdctl
    environment:
      - ETCDCTL_API=3
      - ETCD_ENDPOINTS=http://etcd:2379
    volumes:
      - ./certs:/etc/etcd/certs  # 挂载证书目录（如需要）
    command: get /service/config  # 执行具体操作

注意事项

• 确保etcd集群端点可从容器网络访问
• 使用TLS加密时，需通过-v挂载证书文件到容器内对应路径
• 生产环境中建议固定etcdctl版本，避免API兼容性问题
• 执行快照恢复等敏感操作时，需确保etcd集群处于离线状态