akhenakh/drone-waiton

drone-waiton

镜像概述

drone-waiton是轻量级的Drone CI插件，用于等待外部主机或服务可用，适用于CI流水线中需确保依赖服务（如数据库、缓存）启动后再执行后续任务的场景。镜像基于无发行版（distroless）构建，压缩后仅4.2MB，资源占用低。

核心功能

• 支持HTTP、HTTPS、TCP协议的服务可用性检测
• 可配置全局超时（整体检测的最长等待时间）
• 可配置单请求超时（单个服务检测的重试间隔前等待时间）
• 默认每1秒自动重试检测

使用场景

在CI/CD流水线中，当依赖外部服务（如Redis、MySQL、API服务）时，通过该插件等待服务就绪，避免因服务未启动导致后续任务失败。

配置说明

urls

• 类型：[]string
• 默认值：空字符串
• 描述：需检测的服务URL列表，支持http://、https://、tcp://协议。
• 示例：

yaml
kind: pipeline
steps:
- name: waiton
  image: akhenakh/drone-waiton
  settings:
    urls:
    - http://www.example.com
    - tcp://cache:6379

globaltimeout

• 类型：string
• 默认值：1m（1分钟）
• 描述：整体检测的最长等待时间，超时则返回错误。支持单位：分钟（m）、秒（s）等。
• 示例：

yaml
kind: pipeline
steps:
- name: waiton
  image: akhenakh/drone-waiton
  settings:
    globaltimeout: 30s
    urls:
    - http://httpbin.org/delay/5

urltimeout

• 类型：string
• 默认值：10s（10秒）
• 描述：单个服务请求的超时时间，超时后重试。支持单位：分钟（m）、秒（s）等。
• 示例：

yaml
kind: pipeline
steps:
- name: waiton
  image: akhenakh/drone-waiton
  settings:
    urltimeout: 3s
    urls:
    - http://httpbin.org/delay/2

部署示例

以下是等待Redis服务启动的Drone流水线示例：

yaml
kind: pipeline
steps:
- name: waiton
  image: akhenakh/drone-waiton:1.0
  settings:
    globaltimeout: 30s
    urls:
    - tcp://cache:6379

- name: service-ready
  image: busybox
  commands:
  - echo "Redis服务已就绪"
  depends_on:
  - waiton

services:
- name: cache
  image: redis
  ports:
  - 6379

细节说明

• 镜像基于Go程序构建，源码地址：https://github.com/akhenakh/waiton
• HTTP/TCP服务检测默认每1秒重试一次，直到服务可用或超时。