sumina46/wait-for-it

wait-for-it Docker镜像

镜像概述和主要用途

wait-for-it Docker镜像基于GitHub上的https://github.com/vishnubob/wait-for-it/blob/master/wait-for-it.sh脚本构建，主要用于解决多容器环境中的启动顺序同步问题。该镜像能够等待指定的主机和端口变为可用状态后，再执行后续命令，确保依赖服务就绪后才启动当前容器，避免因依赖服务未就绪导致的启动失败。

核心功能和特性

• 依赖等待机制：可指定目标主机和端口，持续检查其可用性
• 命令执行触发：仅在目标主机端口可用后，执行用户指定的命令
• 轻量级设计：基于脚本实现，镜像体积小，资源占用低
• 兼容性强：支持各类需要网络依赖检查的容器场景

使用场景和适用范围

• 微服务架构：确保数据库、缓存等依赖服务启动后，再启动应用服务
• 多容器应用：需按顺序启动的容器集群，如前端容器等待后端API容器就绪
• 自动化部署：CI/CD流程中，确保测试环境依赖服务就绪后再执行测试命令
• 容器编排：在Docker Compose、Kubernetes等编排环境中协调容器启动顺序

使用方法和配置说明

基本使用语法

bash
docker run docker.xuanyuan.run/sumina46/wait-for-it <目标主机:端口> -- <待执行命令>

参数说明

• <目标主机:端口>：需等待的目标服务地址和端口，格式为host:port
• --：分隔符，用于区分等待目标和待执行命令
• <待执行命令>：目标服务可用后执行的命令

使用示例

示例1：等待Google服务可用后输出消息

bash
docker run docker.xuanyuan.run/sumina46/wait-for-it www.google.com:80 -- echo "google服务已就绪"

示例2：等待数据库服务后启动应用（假设数据库地址为db:5432，应用启动命令为java -jar app.jar）

bash
docker run docker.xuanyuan.run/sumina46/wait-for-it db:5432 -- java -jar app.jar

示例3：设置超时时间（默认超时为15秒，可通过--timeout参数自定义，单位为秒）

bash
docker run docker.xuanyuan.run/sumina46/wait-for-it db:5432 --timeout 30 -- java -jar app.jar

Docker Compose集成示例

在docker-compose.yml中使用，确保应用服务等待数据库服务就绪：

yaml
version: '3'
services:
  db:
    image: docker.xuanyuan.run/postgres:14
    ports:
      - "5432:5432"
    environment:
      POSTGRES_PASSWORD: password
  
  app:
    image: docker.xuanyuan.run/sumina46/wait-for-it
    command: db:5432 -- java -jar /app.jar
    depends_on:
      - db
    volumes:
      - ./app.jar:/app.jar

注：depends_on仅保证容器启动顺序，不保证服务就绪状态，结合wait-for-it可实现服务就绪等待。