drevops/docker-wait-for-dependencies

Docker wait for dependencies

镜像概述

Docker wait for dependencies是一个轻量级容器，主要功能是暂停自身运行，直到指定的其他服务通过TCP端口可访问。该镜像适用于在Docker Compose环境中确保依赖服务（如数据库、缓存等）完全就绪后，再启动主应用服务，避免因依赖服务未准备好而导致的启动失败。支持linux/amd64和linux/arm64两种架构。

核心功能与特性

• TCP服务等待：通过TCP端口检查指定服务是否可访问
• 可配置检查间隔：默认每2秒检查一次服务状态，可通过环境变量自定义
• 超时控制：默认等待超时时间为300秒，超时后自动终止等待，可通过环境变量调整
• 多架构支持：同时提供linux/amd64和linux/arm64架构镜像
• 轻量高效：容器体积小，资源占用低

使用场景

适用于任何需要确保依赖服务（如MongoDB、Redis、MySQL等）完全启动并可访问后，再启动主应用的场景。典型应用包括：

• 在CI/CD流程中，确保数据库、缓存等基础设施就绪后再执行应用部署
• 本地开发环境中，避免因依赖服务启动慢导致的应用启动失败
• 生产环境中，控制服务启动顺序，保证系统稳定性

使用方法

基本用法（Docker Compose示例）

以下是在docker-compose.yml中集成该镜像的示例配置：

yaml
version: '2'
services:
  # 依赖服务示例：MongoDB
  mongo:
    image: docker.xuanyuan.run/mongo:6
    container_name: mongo
    ports:
      - 27017:27017
    networks:
      - my-network

  # 依赖服务示例：Redis
  redis:
    container_name: redis
    image: docker.xuanyuan.run/redis:6
    ports:
      - 6379:6379
    networks:
      - my-network

  # 主应用服务
  server:
    container_name: server
    image: docker.xuanyuan.run/server
    ports:
      - 3000:3000
    networks:
      - my-network

  # 依赖等待服务
  start_dependencies:
    image: docker.xuanyuan.run/drevops/docker-wait-for-dependencies:23.12.0
    depends_on:
      - mongo
      - redis
    container_name: wait-for-dependencies
    # 命令格式：<服务名>:<端口> [<服务名>:<端口>...]
    command: mongo:27017 redis:6379
    networks:
      - my-network

networks:
  my-network:

确保依赖就绪后启动主服务

通过以下步骤，可确保mongo和redis服务完全就绪后再启动server服务：

bash
# 运行等待容器，直到mongo和redis可访问
docker-compose run --rm start_dependencies

# 依赖服务就绪后，启动主服务
docker-compose up server

配置说明

环境变量

该镜像支持通过环境变量调整检查行为，主要包括：

SLEEP_LENGTH

• 作用：设置两次检查之间的间隔时间（单位：秒）
• 默认值：2
• 示例配置：

  yaml
  start_dependencies:
    image: docker.xuanyuan.run/drevops/docker-wait-for-dependencies:23.12.0
    environment:
      - SLEEP_LENGTH=0.5  # 每0.5秒检查一次
  

TIMEOUT_LENGTH

• 作用：设置最大等待超时时间（单位：秒），超时后终止等待
• 默认值：300（5分钟）
• 示例配置：

  yaml
  start_dependencies:
    image: docker.xuanyuan.run/drevops/docker-wait-for-dependencies:23.12.0
    environment:
      - TIMEOUT_LENGTH=60  # 超时时间设为60秒
  

致谢

本镜像的核心功能基于https://github.com/ducktors/docker-wait-for-dependencies%E9%A1%B9%E7%9B%AE%E5%BC%80%E5%8F%91%EF%BC%8C%E6%84%9F%E8%B0%A2%E8%AF%A5%E9%A1%B9%E7%9B%AE%E8%B4%A1%E7%8C%AE%E8%80%85%E7%9A%84%E5%8E%9F%E5%A7%8B%E5%B7%A5%E4%BD%9C%E3%80%82