fitnesskeeper/consul-sidecar

Consul Sidecar镜像说明

镜像概述

该Docker镜像用于管理和部署Consul的检查脚本与检查定义，作为sidecar容器配合Consul agent实现服务健康监控、配置同步及状态处理，适用于微服务集群的运维场景。

核心功能

1. 内置预定义检查：包含docker-test（正常）、docker-test-warning（警告）、docker-test-critical（ critical）等测试用检查
2. 自定义检查激活：通过环境变量指定需启用的检查列表
3. 检查定义同步：将激活的检查定义写入本地目录，可挂载至Consul agent实现同步
4. 扩展检查支持：提供backup（S3备份Consul节点）、ecs-cluster（ECS集群状态监控）等实用检查

使用场景

• Consul服务集群的健康状态实时监控
• ECS集群的AMI版本验证与可用性监控
• Consul节点数据的S3自动备份
• 本地测试Consul检查逻辑的有效性

配置说明

必需配置

• 挂载/var/run/docker.sock：容器需访问Docker套接字获取容器信息

可选配置

• CHECKS：指定激活的检查名称列表，格式为JSON数组（如["docker-test","ecs-cluster"]）或空格分隔字符串（如docker-test docker-test-warning）

支持的检查详情

• backup：需传入S3_BUCKET环境变量，将Consul节点数据备份至S3，依赖ECS任务的S3写入权限
• ecs-cluster：创建ECS集群对应的Consul服务，添加AMI状态、CloudWatch指标、实例状态等检查

部署示例

Docker Run命令

shell
docker run --rm -it \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -e CHECKS='docker-test docker-test-warning' \
  fitnesskeeper/consul-sidecar:latest

Docker Compose示例

yaml
version: '3'
services:
  consul-sidecar:
    image: fitnesskeeper/consul-sidecar:latest
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./consul_check_definitions:/consul_check_definitions
    environment:
      - CHECKS=["docker-test","ecs-cluster"]
      - S3_BUCKET=my-consul-backup-bucket

授权信息

作者：Tim Hartmann
许可证：MIT License