Docker Compose Wait 使用教程

1. 项目目录结构及介绍

在 ufoscout/docker-compose-wait 开源项目中，主要包含以下几个关键文件和目录：

• src: 存放主要的脚本代码，包括 wait 脚本。
• tests: 测试相关文件，用于验证脚本功能是否正常工作。
• Dockerfile: 创建测试镜像的配置文件。
• test.sh: 包含测试脚本的文件。
• .gitignore: 忽略在 Git 中跟踪的文件列表。
• Cargo.toml: Rust 项目的依赖管理文件。
• Cargo.lock: 锁定特定版本的依赖以确保一致性。
• LICENSE: 项目的许可证信息，这里是 Apache-2.0 许可证。
• README.md: 项目的说明文档。

这个项目提供了一个简单的命令行工具 docker-compose-wait，该工具可以在使用 Docker Compose (或者 Kubernetes 或 docker stack 等) 部署时等待其他服务启动完成。

2. 项目的启动文件介绍

• wait: 这是核心的 Shell 脚本，它负责检查指定的服务（通过 WAIT_HOSTS 环境变量）是否准备好接受连接。当所有等待的服务都可用时，该脚本将成功退出，从而允许你的应用程序启动。

例如，在 Dockerfile 中，你可以像这样添加 wait 并在其后运行你的应用程序：

ADD MySuperApp.sh /MySuperApp.sh
CMD /wait && /MySuperApp.sh

这将确保 MySuperApp.sh 在依赖的服务准备就绪后才会执行。

3. 项目的配置文件介绍

主要的配置是在 docker-compose.yml 文件中进行的，docker-compose-wait 工具通过环境变量 WAIT_HOSTS 来配置需要等待的服务。

例如：

version: "3"
services:
  mongo:
    image: mongo:3.4
    hostname: mongo
    ports:
      - "27017:27017"
  postgres:
    image: "postgres:9.4"
    hostname: postgres
    ports:
      - "5432:5432"
  mysql:
    image: "mysql:5.7"
    hostname: mysql
    ports:
      - "3306:3306"
  mySuperApp:
    image: "mySuperApp:latest"
    hostname: mySuperApp
    environment:
      WAIT_HOSTS: postgres:5432 mysql:3306 mongo:27017

在这个例子中，mySuperApp 服务将在 postgres:5432, mysql:3306 和 mongo:27017 可达之后启动。WAIT_HOSTS 的格式是 <hostname>:<port>，其中多个服务可以用逗号隔开。

如果你不希望设置 WAIT_HOSTS，工具将默认跳过等待步骤并立即启动你的应用。

请注意，docker-compose-wait 是一个辅助工具，它需要与 Docker Compose 配合使用来发挥作用。你需要在你的 Docker Compose 容器中安装此脚本，并正确配置 WAIT_HOSTS 以便于等待依赖服务的启动。