onedata/k8s-wait-for

k8s-wait-for镜像说明

镜像概述

k8s-wait-for是一个简单实用的工具镜像，包含脚本用于等待Kubernetes（K8s）中的资源（如服务、作业、Pod）进入指定状态。它常与K8s的Init容器结合使用，解决部署过程中的资源依赖问题，确保主容器仅在依赖资源就绪后启动。

核心功能

• 支持等待多种K8s资源状态：Job完成、Pod就绪、Service可用等；
• 提供详细事件日志，便于通过kubectl describe <pod>排查初始化卡住的原因；
• 与Init容器集成，通过kubectl get pods清晰展示初始化进度（如Init:<ready>/<total>）；
• 轻量级设计，镜像体积小，不增加额外资源负担。

使用场景

• 微服务启动顺序控制：主应用启动前等待数据库、缓存等依赖Pod就绪；
• 作业依赖管理：应用部署前等待初始化Job（如数据迁移）完成；
• CI/CD流水线：确保K8s资源部署完成后再执行后续测试或发布步骤。

配置说明

使用镜像时，通过命令行参数指定等待的资源类型和条件。执行wait_for.sh -h可查看详细参数说明，常见用法：

• 等待Job完成：wait_for.sh job <job-name>；
• 等待Pod就绪：wait_for.sh pod -l <label-selector>（如-lapp=my-db）；
• 等待Service可用：wait_for.sh service <service-name>。

部署示例

1. Docker直接运行

等待名为my-init-job的Job完成：

bash
docker run --rm docker.xuanyuan.run/onedata/k8s-wait-for job my-init-job

2. Kubernetes Init容器示例

在Pod中使用Init容器等待DB Pod就绪：

yaml
apiVersion: v1
kind: Pod
metadata:
  name: my-app-pod
spec:
  initContainers:
  - name: wait-for-db
    image: docker.xuanyuan.run/onedata/k8s-wait-for
    args: ["pod", "-lapp=my-db-pod"]
  containers:
  - name: my-app
    image: docker.xuanyuan.run/my-app:latest
    ports:
    - containerPort: 8080

此配置确保主应用容器仅在标签为app=my-db-pod的Pod就绪后启动。