mcalhoun/consul

Docker镜像文档：hashicorp/docker-consul分支版

镜像概述

本镜像为官方hashicorp/docker-consul镜像的分支版本，继承了原镜像的全部核心功能，旨在提供与官方Consul镜像一致的服务发现、配置管理及分布式系统协调能力。该镜像基于Consul（HashiCorp推出的开源工具）构建，适用于构建分布式系统中的服务注册与发现、配置共享、服务健康监控等场景。

核心功能与特性

• 服务发现：支持服务注册与发现机制，允许服务自动注册并被其他服务发现
• 健康检查：内置多种健康检查方式（HTTP、TCP、脚本等），实时监控服务状态
• KV存储：提供分布式键值存储，用于配置共享、特征标记等场景
• 多数据中心支持：支持跨数据中心的服务发现与通信
• 分布式一致性：基于Raft共识算法，确保数据一致性和高可用性
• 安全特性：支持TLS加密、ACL访问控制，保障服务通信安全

使用场景与适用范围

• 微服务架构：作为服务注册中心，实现微服务间的动态发现与通信
• 分布式配置管理：集中管理分布式系统的配置信息，支持动态更新
• 服务健康监控：实时监控服务状态，实现故障自动检测与恢复
• 容器编排环境：与Kubernetes、Docker Swarm等容器编排平台集成，提供服务发现能力
• 多数据中心部署：支持跨区域服务发现与协同，构建高可用分布式系统

使用方法与配置说明

基本使用（Docker Run）

启动单节点Consul代理（开发模式）

bash
docker run -d --name consul-agent -p 8500:8500 your-image-name agent -dev -client=0.0.0.0

• -dev：启用开发模式，适合本地测试（不持久化数据）
• -client=0.0.0.0：允许外部访问Consul API

启动服务器节点（生产模式）

bash
docker run -d --name consul-server -p 8500:8500 -p 8300:8300 -p 8301:8301 -p 8302:8302 -p 8600:8600 your-image-name agent -server -bootstrap-expect=1 -client=0.0.0.0 -ui

• -server：以服务器模式启动
• -bootstrap-expect=1：期望集群中服务器节点数量（单节点时设为1）
• -ui：启用Web管理界面

Docker Compose配置示例

yaml
version: '3'
services:
  consul:
    image: your-image-name
    container_name: consul
    ports:
      - "8500:8500"   # HTTP API端口
      - "8300:8300"   # 服务器间通信端口
      - "8301:8301"   # Serf LAN端口
      - "8302:8302"   # Serf WAN端口
      - "8600:8600"   # DNS端口
    command: agent -server -bootstrap-expect=1 -client=0.0.0.0 -ui
    volumes:
      - ./consul-data:/consul/data  # 持久化数据目录
    restart: always

核心配置参数

环境变量

常用命令参数

服务注册示例

通过HTTP API注册服务：

bash
curl -X PUT -d '{"Name": "web", "Address": "192.168.1.100", "Port": 80, "Check": {"HTTP": "http://localhost:80/health", "Interval": "10s"}}' http://localhost:8500/v1/agent/service/register

数据持久化

为确保数据持久化，需挂载数据目录：

bash
docker run -d --name consul -v /host/path/consul-data:/consul/data your-image-name agent -server -bootstrap-expect=1 -client=0.0.0.0

注意事项

• 生产环境中建议部署3个或以上服务器节点以确保高可用
• 开发模式（-dev）不适合生产环境，数据不会持久化
• 建议配置TLS加密和ACL以增强安全性
• 容器需具备足够的资源（CPU/内存）以支持Raft共识算法运行