gesellix/wait-for

wait-for 镜像文档

概述和主要用途

wait-for 是一个用于同步服务（如Docker容器）的脚本，旨在等待其他服务变得可用。它兼容sh（Bourne shell）和Alpine Linux系统，灵感来源于https://github.com/vishnubob/wait-for-it%EF%BC%8C%E6%A0%B8%E5%BF%83%E5%8A%9F%E8%83%BD%E7%94%B1Eficode%E7%9A%84dsuni%E5%92%8Cmrako%E9%87%8D%E5%86%99%E3%80%82%E4%BD%BF%E7%94%A8%E6%97%B6%EF%BC%8C%E5%8F%AA%E9%9C%80%E5%B0%86%60wait-for%60%E6%96%87%E4%BB%B6%E4%BD%9C%E4%B8%BA%E9%A1%B9%E7%9B%AE%E7%9A%84%E4%B8%80%E9%83%A8%E5%88%86%E5%8D%B3%E5%8F%AF%E3%80%82

核心功能和特性

• 服务可用性检测：等待指定主机和端口的服务变得可用
• 跨环境兼容：支持sh和Alpine Linux系统
• 轻量级：仅需单个脚本文件，无需额外依赖
• 超时控制：可设置超时时间，零表示无超时
• 后续命令执行：检测完成后可执行指定命令
• 静默模式：支持不输出状态消息的静默运行

使用场景和适用范围

• Docker容器依赖管理：确保依赖服务（如数据库、API服务）启动后再启动当前容器
• 服务部署流程：在自动化部署中确保前序服务就绪后再执行后续步骤
• 开发环境配置：本地开发时同步多服务启动顺序
• CI/CD管道：在测试或部署阶段等待服务可用

使用方法和配置说明

命令格式

./wait-for host:port [-t timeout] [-- command args]

参数说明

使用示例

命令行示例

检查eficode.com是否可用：

bash
$ ./wait-for www.eficode.com:80 -- echo "Eficode网站已启动"

Connection to www.eficode.com port 80 [tcp/http] succeeded!
Eficode网站已启动

Docker Compose示例

等待数据库容器可用后启动后端服务：

yaml
version: '2'

services:
  db:
    image: postgres:9.4

  backend:
    build: backend
    command: sh -c './wait-for db:5432 -- npm start'
    depends_on:
      - db

测试说明

测试使用https://github.com/sstephenson/bats%E8%BF%9B%E8%A1%8C%EF%BC%8C%E8%AF%A5%E5%B7%A5%E5%85%B7%E4%BE%9D%E8%B5%96bash)%E3%80%82

测试步骤

1. 构建测试镜像：

   bash
   docker build -t wait-for .
   

2. 运行测试：

   bash
   docker run -t wait-for