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%E8%84%9A%E6%9C%AC%E6%9E%84%E5%BB%BA%EF%BC%8C%E4%B8%BB%E8%A6%81%E7%94%A8%E4%BA%8E%E8%A7%A3%E5%86%B3%E5%A4%9A%E5%AE%B9%E5%99%A8%E7%8E%AF%E5%A2%83%E4%B8%AD%E7%9A%84%E5%90%AF%E5%8A%A8%E9%A1%BA%E5%BA%8F%E5%90%8C%E6%AD%A5%E9%97%AE%E9%A2%98%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E8%83%BD%E5%A4%9F%E7%AD%89%E5%BE%85%E6%8C%87%E5%AE%9A%E7%9A%84%E4%B8%BB%E6%9C%BA%E5%92%8C%E7%AB%AF%E5%8F%A3%E5%8F%98%E4%B8%BA%E5%8F%AF%E7%94%A8%E7%8A%B6%E6%80%81%E5%90%8E%EF%BC%8C%E5%86%8D%E6%89%A7%E8%A1%8C%E5%90%8E%E7%BB%AD%E5%91%BD%E4%BB%A4%EF%BC%8C%E7%A1%AE%E4%BF%9D%E4%BE%9D%E8%B5%96%E6%9C%8D%E5%8A%A1%E5%B0%B1%E7%BB%AA%E5%90%8E%E6%89%8D%E5%90%AF%E5%8A%A8%E5%BD%93%E5%89%8D%E5%AE%B9%E5%99%A8%EF%BC%8C%E9%81%BF%E5%85%8D%E5%9B%A0%E4%BE%9D%E8%B5%96%E6%9C%8D%E5%8A%A1%E6%9C%AA%E5%B0%B1%E7%BB%AA%E5%AF%BC%E8%87%B4%E7%9A%84%E5%90%AF%E5%8A%A8%E5%A4%B1%E8%B4%A5%E3%80%82

核心功能和特性

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

使用场景和适用范围

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

使用方法和配置说明

基本使用语法

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

参数说明

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

使用示例

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

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

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

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

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

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

Docker Compose集成示例

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

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

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