lqhl/wait-for-it

wait-for-it镜像

镜像概述

wait-for-it镜像是基于开源项目wait-for-it.sh的Docker镜像，包含一个纯bash脚本，用于等待指定主机和TCP端口的可用性。该脚本无任何外部依赖，可帮助同步相互依赖服务（如Docker容器）的启动顺序，确保服务在依赖项就绪后再启动。

核心功能

• 等待指定主机和TCP端口可用
• 支持设置超时时间（零表示无超时）
• 严格模式：仅当端口可用时才执行后续命令
• 安静模式：不输出状态信息
• 执行后续命令（可选）

使用场景

• 微服务架构中，等待数据库、缓存服务或其他依赖服务启动完成
• Docker容器编排时，确保依赖容器就绪后再启动当前容器
• 自动化脚本中，验证服务端口是否正常开放

配置说明

命令参数

text
wait-for-it.sh host:port [-s] [-t timeout] [-- command args]
-h HOST | --host=HOST       测试的主机或IP
-p PORT | --port=PORT       测试的TCP端口（也可通过host:port形式指定）
-s | --strict               仅当测试成功时执行后续命令
-q | --quiet                不输出状态信息
-t TIMEOUT | --timeout=TIMEOUT 超时时间（秒，0表示无超时）
-- COMMAND ARGS             测试完成后执行的命令及参数

部署示例

Docker Run示例

等待db:3306端口可用后执行命令：

bash
docker run --rm lqhl/wait-for-it db:3306 -- echo "DB服务已就绪"

设置10秒超时并启用严格模式：

bash
docker run --rm lqhl/wait-for-it -t 10 -s redis:6379 -- echo "Redis服务已就绪"

Docker Compose示例

在docker-compose.yml中确保web服务依赖db服务就绪：

yaml
version: '3'
services:
  db:
    image: mysql:8.0
    environment:
      MYSQL_ROOT_PASSWORD: root_pass
  web:
    image: your-web-app
    command: ["wait-for-it.sh", "db:3306", "--", "python", "app.py"]
    depends_on:
      - db
    # 若使用该镜像作为init容器（需Docker 1.13+）：
    # init_container:
    #   image: lqhl/wait-for-it
    #   command: ["db:3306"]