itherz/consul

docker-consul 镜像文档

镜像概述

docker-consul是一个定制化的Consul镜像，在标准Consul基础上集成了MySQL客户端、LDAP客户端以及部分额外库，特别优化了健康检查功能，适用于需要与数据库或目录服务集成的服务发现场景。

核心功能与特性

• 基础Consul功能：完整保留Consul的服务发现、配置管理、分布式锁等核心能力
• 客户端集成：内置MySQL客户端和LDAP客户端，支持直接与数据库和目录服务交互
• 健康检查增强：包含Python环境及额外库，支持编写复杂的健康检查脚本
• 兼容性：基于官方Consul镜像构建，保持与标准Consul接口的兼容性

使用场景

• 需要从Consul健康检查中直接访问MySQL数据库的场景
• 需与LDAP目录服务集成进行服务认证或用户信息查询的场景
• 需要自定义复杂健康检查逻辑（如多步骤检查、数据校验）的服务部署
• 微服务架构中需增强服务健康状态监控的场景

使用方法

基本运行

bash
docker run -d --name=consul-custom -p 8500:8500 docker.xuanyuan.run/your-registry/docker-consul:latest agent -dev -client=0.0.0.0

健康检查示例

利用内置Python环境创建MySQL健康检查脚本（保存为mysql-check.py）：

python
import mysql.connector
import sys

def check_mysql():
    try:
        conn = mysql.connector.connect(
            host="mysql-host",
            user="check-user",
            password="check-pass",
            database="healthdb"
        )
        conn.close()
        return 0  # 健康
    except Exception as e:
        print(f"MySQL check failed: {e}")
        return 1  # 不健康

sys.exit(check_mysql())

在Consul配置中引用该检查：

json
{
  "service": {
    "name": "mysql-service",
    "check": {
      "id": "mysql-health-check",
      "name": "MySQL Health Check",
      "script": "python /scripts/mysql-check.py",
      "interval": "10s",
      "timeout": "5s"
    }
  }
}

挂载自定义配置

bash
docker run -d --name=consul-custom \
  -v /host/path/to/config:/consul/config \
  -v /host/path/to/scripts:/scripts \
  -p 8500:8500 \
  docker.xuanyuan.run/your-registry/docker-consul:latest agent -config-dir=/consul/config

注意事项

• 镜像默认包含基础依赖库，如需额外工具可通过docker exec进入容器安装
• 健康检查脚本需确保有可执行权限，并正确处理退出码（0=健康，非0=不健康）
• 生产环境建议使用非-dev模式运行，并配置持久化存储