Gremlin Kubernetes Client (Go) 镜像文档

镜像概述与主要用途

Gremlin Kubernetes Client (Go) 是Gremlin提供的基于Go语言实现的轻量级Kubernetes客户端工具。该镜像旨在简化与Kubernetes集群的交互过程，深度兼容Kubernetes API，支持执行混沌工程实验、管理集群资源及查询集群状态，帮助用户测试系统弹性并提升分布式应用的可靠性。

核心功能与特性

核心功能

• Kubernetes API交互：全面支持Kubernetes核心资源（Pod、Deployment、Service等）的查询、创建、更新与删除操作。
• 混沌工程支持：集成Gremlin混沌工程能力，可执行故障注入（如网络延迟、CPU压力、节点故障等）以验证集群容错能力。
• 资源管理自动化：支持通过命令行或配置文件批量管理集群资源，简化运维流程。

关键特性

• Go语言原生实现：轻量级且性能高效，适合嵌入自动化脚本或Go应用中。
• 跨版本兼容：兼容Kubernetes 1.16+集群API版本，适配主流Kubernetes环境。
• 灵活配置：支持通过环境变量或命令行参数自定义行为，兼容标准kubeconfig文件。
• 低资源占用：镜像体积小，运行时资源消耗低，适合边缘环境或资源受限场景。

使用场景与适用范围

典型使用场景

• 混沌工程实验：向Kubernetes集群注入故障（如网络分区、Pod终止），测试应用弹性与恢复能力。
• 集群运维自动化：管理员通过命令行快速执行集群资源巡检、部署更新或故障排查。
• CI/CD流程集成：嵌入持续集成/部署管道，在应用发布前自动验证集群兼容性。
• 开发调试辅助：Go语言开发者与Kubernetes集群交互时，快速验证API调用逻辑。

适用人群与环境

• 混沌工程实践者、Kubernetes集群管理员、云原生应用开发者
• 测试/预发环境的弹性测试、故障演练场景
• 需要轻量级Kubernetes客户端的自动化脚本或边缘计算环境

使用方法与配置说明

前提条件

• 已安装Docker环境
• 本地或远程Kubernetes集群可访问，且拥有有效的kubeconfig文件（通常位于~/.kube/config）
• 执行混沌工程操作时需提供Gremlin API密钥（从Gremlin控制台获取）

基础使用命令

1. 启动客户端并查询集群信息

挂载本地kubeconfig文件以连接集群，执行基础查询命令：

docker run --rm -v $HOME/.kube/config:/root/.kube/config gremlin/k8s-client-go:latest get nodes

2. 执行混沌工程故障注入

注入网络延迟故障至目标Deployment（持续60秒，延迟500ms）：

docker run --rm \
  -v $HOME/.kube/config:/root/.kube/config \
  -e GREMLIN_API_KEY="your-gremlin-api-key" \
  gremlin/k8s-client-go:latest \
  gremlin *** network latency \
    --target deployment/my-app \
    --duration 60s \
    --latency 500ms

环境变量配置

常用命令参考

注意事项

• 权限控制：挂载的kubeconfig文件需包含执行目标操作的足够权限（如集群管理员或特定RBAC角色）。
• 环境隔离：混沌工程操作建议在测试/预发环境执行，避免影响生产服务。
• 版本兼容：客户端版本需与目标Kubernetes集群API版本匹配（可通过--version参数查看客户端API版本）。
• 资源清理：使用--rm参数确保容器退出后自动清理，避免残留临时文件。