apnic/kube-tools

kube-tools Docker镜像文档

1. 镜像概述和主要用途

kube-tools 是一个集成了多种 Kubernetes 生态系统管理工具的 Docker 镜像，灵感来源于 https://hub.docker.com/r/stefanprodan/kube-tools%E3%80%82%E5%85%B6%E6%A0%B8%E5%BF%83%E7%94%A8%E9%80%94%E6%98%AF%E6%8F%90%E4%BE%9B%E4%B8%80%E4%B8%AA%E7%BB%9F%E4%B8%80%E3%80%81%E4%BE%BF%E6%8D%B7%E7%9A%84%E5%B7%A5%E5%85%B7%E9%9B%86%EF%BC%8C%E7%AE%80%E5%8C%96 Kubernetes 集群的日常管理、应用部署、配置管理及故障排查流程，避免用户在本地或环境中手动安装和维护多个分散的工具。

2. 核心功能和特性

2.1 包含的主要工具

镜像预装了 Kubernetes 生态常用工具，典型包含（具体版本可能随镜像更新调整）：

• kubectl：Kubernetes 集群命令行管理工具，支持集群资源操作、状态查询等。
• helm：Kubernetes 包管理工具，用于 Charts 的打包、部署和管理。
• kustomize：Kubernetes 原生配置管理工具，支持通过基础配置和叠加补丁生成最终部署配置。
• kubectx/kubens：快速切换 Kubernetes 集群上下文（context）和命名空间（namespace）的工具。
• istioctl（可选）：Istio 服务网格管理工具，用于配置、部署和排查 Istio 资源。
• kubeseal：用于加密 Kubernetes Secrets，配合 SealedSecrets 控制器实现安全分发。
• argocd（可选）：GitOps 工具，用于通过 Git 仓库同步 Kubernetes 集群资源。

2.2 其他特性

• 多架构支持：通常支持 amd64、arm64 等主流架构，适配不同运行环境。
• 工具版本同步：定期更新工具版本，确保与最新 Kubernetes 版本兼容性。
• 轻量级基础：基于 Alpine 或 Debian Slim 等轻量级基础镜像，减少镜像体积。

3. 使用场景和适用范围

3.1 开发环境工具统一

开发人员无需在本地安装多个 K8s 工具，直接通过容器运行镜像即可获取完整工具链，避免本地环境配置冲突。

3.2 CI/CD 流水线集成

在 Jenkins、GitLab CI、GitHub Actions 等 CI/CD 流程中，作为执行环境运行 kubectl apply、helm install 等命令，实现应用自动化部署。

3.3 临时集群管理任务

管理员可通过镜像快速启动工具环境，执行临时操作（如集群资源检查、日志排查、配置调整），无需在跳板机或本地持久化安装工具。

3.4 跨平台工具兼容

在 Windows、macOS、Linux 等不同操作系统上，通过 Docker 容器提供一致的工具行为，避免因系统差异导致的命令兼容性问题。

4. 使用方法和配置说明

4.1 基本使用（docker run）

通过 docker run 命令直接运行工具，需挂载本地 Kubernetes 配置文件（kubeconfig）以连接集群。

示例：执行 kubectl get pods 命令

bash
docker run --rm \
  -v ~/.kube/config:/root/.kube/config \  # 挂载本地 kubeconfig 到容器内默认路径
  kube-tools \
  kubectl get pods -n default

• --rm：容器退出后自动删除，避免残留。
• -v ~/.kube/config:/root/.kube/config：将本地 kubeconfig 挂载到容器内 kubectl 默认读取路径。

4.2 持久化配置

若需保存工具配置（如 helm 仓库、kubectx 历史记录等），可挂载工具配置目录到本地：

bash
docker run --rm \
  -v ~/.kube/config:/root/.kube/config \  # kubeconfig 挂载
  -v ~/.kube-tools/helm:/root/.helm \     # helm 配置持久化
  -v ~/.kube-tools/kubectx:/root/.kube/ctx \  # kubectx 配置持久化
  kube-tools \
  helm repo list  # 查看持久化的 helm 仓库配置

4.3 在 CI/CD 流水线中使用

以 GitLab CI 为例，在 .gitlab-ci.yml 中定义作业，使用 kube-tools 镜像执行部署命令：

yaml
deploy-job:
  image: kube-tools
  stage: deploy
  script:
    - kubectl config use-context my-cluster  # 切换到目标集群上下文
    - helm upgrade --install my-app ./charts/my-app  # 部署应用
  only:
    - main

4.4 docker-compose 配置示例

通过 docker-compose.yml 定义服务，简化多工具组合使用（如同时运行 kubectl 和 helm）：

yaml
version: '3'
services:
  kube-tools:
    image: kube-tools
    volumes:
      - ~/.kube/config:/root/.kube/config  # 挂载 kubeconfig
      - ./helm-charts:/charts  # 挂载本地 Helm Charts 目录
    environment:
      - KUBE_CONFIG=/root/.kube/config  # 显式指定 kubeconfig 路径（部分工具可能需要）
    command: tail -f /dev/null  # 保持容器运行，便于进入交互模式

启动并进入容器：

bash
docker-compose up -d
docker-compose exec kube-tools sh  # 进入容器交互终端，执行工具命令

5. 配置参数说明

5.1 环境变量

5.2 常用挂载点

6. 注意事项

• 工具版本兼容性：镜像中工具版本需与目标 Kubernetes 集群版本匹配（如 kubectl 版本建议与集群版本差不超过 1 个 minor 版本），使用前可通过 kubectl version 确认兼容性。
• kubeconfig 权限安全：挂载本地 kubeconfig 时，确保文件权限严格（如 chmod 600 ~/.kube/config），避免容器内敏感信息泄露。
• 镜像更新：定期拉取最新镜像（docker pull kube-tools）以获取工具版本更新和安全补丁。
• 自定义工具需求：若需额外工具，可基于本镜像构建自定义镜像（如 FROM kube-tools; RUN apk add <工具>）。