is_ready 开源项目教程

1. 项目介绍

is_ready 是一个开源的自包含程序，用于等待多个地址变为可用。其主要目的是协调依赖于彼此的互联服务的启动，例如依赖于其他服务的 Docker 容器。这个工具不依赖任何外部库，可以作为独立的二进制文件执行。

is_ready 与其他等待服务可用的工具（如 wait-for-it 和 wait-for）相比，其显著特点是能够等待多个地址的可用性，而不仅仅是单一地址。此外，is_ready 作为自包含二进制文件，无需安装任何外部依赖。

2. 项目快速启动

以下是在本地环境中快速启动 is_ready 的步骤：

首先，您需要下载并编译 is_ready 项目：

git clone https://github.com/Stavrospanakakis/is_ready.git
cd is_ready
cargo build --release

编译完成后，您会在 target/release 目录下找到编译好的 is_ready 二进制文件。

在 Docker 容器中使用

您可以使用 Docker 来运行 is_ready。以下是一个简单的 Dockerfile 示例：

FROM alpine:3.19
RUN apk add --no-cache curl
ENV IS_READY_VERSION=v1.0.2
RUN curl -L https://github.com/Stavrospanakakis/is_ready/releases/download/${IS_READY_VERSION}/is_ready_${IS_READY_VERSION}_x86_64-unknown-linux-musl.tar.gz | tar xzf - -C /usr/local/bin

构建并运行 Docker 容器：

docker build -t my-is-ready .
docker run --rm my-is-ready --version

直接使用二进制文件

如果直接使用二进制文件，可以按照以下步骤：

# 运行 is_ready 等待 GitHub 和 Google 的 80 端口可用
./target/release/is_ready --timeout 10 --addr github.com:80 --addr google.com:80 -- echo "The addresses are available"

3. 应用案例和最佳实践

案例一：在容器启动脚本中使用

在容器启动脚本中，可以使用 is_ready 确保依赖的服务已经可用：

docker run --rm my-app is_ready --timeout 30 --addr db-service:3306 -- echo "Database is ready" && my-app

案例二：在容器编排中使用

在 Docker Compose 文件中，可以利用 is_ready 作为服务启动的前置条件：

version: '3'
services:
  db:
    image: postgres:latest
  app:
    build: .
    depends_on:
      db:
        condition: service_healthy
    command: is_ready --timeout 30 --addr db:5432 -- echo "Database is ready" && my-app

4. 典型生态项目

is_ready 可以与多种类型的项目集成，例如：

• 数据库服务启动脚本，确保应用在数据库完全就绪后再启动。
• 微服务架构中，作为服务间依赖协调的工具。
• CI/CD 流程中，检查外部依赖服务是否可用。