pegasystems/k8s-wait-for

Kubernetes资源状态等待工具镜像

镜像概述

主要用途

该Docker镜像封装了一个轻量级脚本工具，专门用于在Kubernetes环境中等待指定资源（服务、作业或Pod）达到用户定义的期望状态。主要用于解决自动化部署流程中的资源依赖问题，确保后续操作仅在前置条件满足时执行。

核心功能和特性

• 多资源类型支持：兼容Kubernetes核心资源类型，包括Service（服务）、Job（作业）和Pod（容器组）
• 自定义状态检查：可根据资源类型配置具体的期望状态（如Pod就绪、服务可用、作业完成等）
• 灵活的超时控制：支持设置最大等待时间，避免流程无限期阻塞
• 轻量级设计：基于精简基础镜像构建，镜像体积小，启动速度快
• 原生K8s集成：直接调用Kubernetes API进行资源状态查询，无需额外依赖

使用场景和适用范围

典型使用场景

• CI/CD流程控制：在应用部署前等待依赖服务（如数据库、缓存）就绪
• 作业依赖管理：在执行关键Kubernetes Job前，验证前置资源是否满足运行条件
• 初始化容器：作为initContainer嵌入Pod定义，确保主容器启动前依赖资源已就绪
• 自动化运维：在批量操作或版本升级过程中，验证资源状态是否符合预期

适用范围

• Kubernetes集群环境（推荐v1.18+版本）
• 需要资源就绪性检查的自动化部署流程
• 依赖外部服务状态的应用初始化流程

使用方法和配置说明

基本使用方式

通过Docker命令直接运行镜像，指定目标资源类型、名称、命名空间及期望状态等参数。工具将定期查询Kubernetes API，直至资源达到期望状态或超时退出。

命令行参数说明

各资源类型支持的期望状态值

• Pod：Running（运行中）、Ready（就绪）、Succeeded（成功完成）、Failed（失败）
• Service：Ready（端点就绪）、Available（服务可用）
• Job：Complete（完成）、Failed（失败）、Active（活跃）

环境变量配置

支持通过环境变量传递配置参数，优先级低于命令行参数：

Docker部署示例

示例1：等待Pod进入Running状态

bash
docker run --rm \
  -v $HOME/.kube/config:/root/.kube/config \  # 挂载本地kubeconfig（集群外使用）
  [镜像名称] \
  --resource-type pod \
  --name api-server-pod \
  --desired-state Running \
  --timeout 600 \
  --interval 10

示例2：等待指定命名空间的Job完成

bash
docker run --rm \
  -e KUBECONFIG=/kube/config \
  -v /path/to/kubeconfig:/kube/config \
  [镜像名称] \
  --resource-type job \
  --name data-migration \
  --namespace backend \
  --desired-state Complete \
  --timeout 1800

示例3：Kubernetes集群内作为初始化容器使用

yaml
# Pod定义片段
apiVersion: v1
kind: Pod
metadata:
  name: app-with-dependency
spec:
  initContainers:
  - name: wait-for-db
    image: [镜像名称]
    command: ["--resource-type", "service", "--name", "mysql-service", "--namespace", "db", "--desired-state", "Ready", "--timeout", "300"]
    serviceAccountName: resource-reader  # 需配置具有service查看权限的服务账户
  containers:
  - name: main-app
    image: your-app-image

注意事项

1. 权限配置：运行环境需具备查询目标资源的权限，集群内使用时需为服务账户配置适当RBAC角色
2. 状态定义：不同资源类型的状态值有差异，需严格按照支持的状态值配置（如Pod的"Ready"状态表示所有容器就绪）
3. 超时设置：根据资源启动特性合理设置超时值，避免因超时过短导致部署失败
4. 网络连通性：确保运行环境能够访问Kubernetes API服务器（集群外需配置网络访问策略）