kuzzleio/consul-template

Consul-template Docker镜像

镜像概述和主要用途

Consul-template Docker镜像封装了Consul-template工具，提供开箱即用的动态配置渲染能力。Consul-template是一款从Consul服务发现系统中获取数据，并根据模板动态生成配置文件的工具，支持在配置文件更新后自动执行指定命令（如服务重启），适用于需要动态调整配置的服务场景。

核心功能和特性

• 内置Consul-template：容器将Consul-template可执行程序作为入口点，直接支持模板渲染命令
• 卷挂载支持：可通过卷挂载提供模板文件和输出配置目录
• Consul集成：支持链接到Consul服务，从Consul获取配置数据
• 命令触发：配置文件更新后可自动执行指定命令（如服务重启、配置重载）
• Docker集成：支持挂载Docker相关文件，实现容器内操作Docker服务

使用场景和适用范围

• 动态负载均衡配置：如HAProxy、Nginx等负载均衡服务，当Consul中服务注册信息变化时自动更新配置
• 服务配置动态更新：需要根据服务集群状态调整配置的应用服务
• 配置集中管理：通过Consul集中管理配置，实现配置与服务解耦
• DevOps自动化：结合Docker和Consul实现配置更新自动化流程

使用方法和配置说明

基本用法

容器将Consul-template可执行程序作为入口点，直接通过命令行参数传递Consul-template配置。

必要的卷挂载

• 模板目录：挂载包含模板文件的目录到容器内
• 输出配置目录：挂载目标服务的配置目录，用于输出渲染后的配置文件
• Docker相关卷（如需执行Docker命令时）：
  • /usr/bin/docker：Docker可执行文件
  • /var/run/docker.sock：Docker socket文件

链接Consul服务

通过--link参数链接到Consul服务容器，使Consul-template能够访问Consul服务。

命令参数说明

• -consul：指定Consul服务地址（格式：host:port）
• -template：指定模板配置，格式为"模板路径:输出路径:更新后执行的命令"

部署示例

1. 准备依赖服务

bash
# 启动HAProxy服务（示例目标服务）
docker run -d --name haproxy -v /usr/local/etc/haproxy haproxy:1.5

# 启动busybox容器用于提供模板文件（挂载模板目录）
docker run -d --name consul-templates -v /path/to/templates:/volume/templates busybox

# 启动Consul服务（服务器模式，单节点引导）
docker run -d --name consul -h node1 progrium/consul -server -bootstrap 

2. 启动Consul-template容器

bash
docker run -d \
  --volumes-from haproxy \          # 挂载HAProxy的配置目录
  --volumes-from consul-templates \ # 挂载模板目录
  -v /usr/bin/docker:/usr/bin/docker \ # 挂载Docker可执行文件
  -v /var/run/docker.sock:/var/run/docker.sock \ # 挂载Docker socket
  --link consul:consul \            # 链接到Consul服务
  kuzzleio/consul-template \        # 镜像名称
  -consul consul:8500 \             # Consul服务地址
  -template "/volume/templates/haproxy/haproxy.cfg.tpl:/usr/local/etc/haproxy/haproxy.cfg:docker exec haproxy service haproxy restart"
                                    # 模板配置：模板路径:输出路径:更新后执行的命令

示例说明

上述示例中，Consul-template会监控Consul服务（地址consul:8500）中的数据变化，当数据变化时：

1. 从/volume/templates/haproxy/haproxy.cfg.tpl读取模板文件
2. 渲染生成配置文件到/usr/local/etc/haproxy/haproxy.cfg（HAProxy的配置目录）
3. 执行docker exec haproxy service haproxy restart命令重启HAProxy服务，使新配置生效