toschneck/wait-for-it

wait-for-it镜像概述

wait-for-it.sh是一个纯bash脚本工具，用于等待指定主机和TCP端口的可用性。它适用于同步相互依赖服务的启动（如关联的Docker容器），由于是纯bash实现，无需任何外部依赖。

核心功能

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

使用场景

• Docker容器启动时，需等待依赖服务（如数据库、API服务）就绪再启动当前容器
• 脚本中需要确保某个服务可用后再执行后续操作

配置说明

命令参数

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 超时时间（秒），零表示无超时
-- COMMAND ARGS             测试完成后执行的命令及参数

部署示例

基本使用（测试端口并执行命令）

测试[***]

bash
./wait-for-it.sh www.google.com:80 -- echo "google服务已就绪"

设置超时时间

设置超时为0（无超时）：

bash
./wait-for-it.sh -t 0 www.google.com:80 -- echo "google服务已就绪"

严格模式

仅当端口可用时执行命令（测试81端口会失败）：

bash
./wait-for-it.sh www.google.com:81 --timeout=1 --strict -- echo "google服务已就绪"

测试端口状态（无后续命令）

检查端口状态并获取退出码：

bash
./wait-for-it.sh [***]
echo $?  # 成功返回0，超时返回124