stakater/consul-config-loader

Consul配置加载器

一个基于Docker的小型工具，用于将Spring Boot属性文件加载到Consul K/V存储中。它支持热重载以及文件系统和Git模式，便于配置集中管理和动态更新。

核心功能和特性

• 多模式支持：提供文件系统模式和Git模式，适应不同环境需求
• 热重载：自动检测配置文件变化并同步到Consul K/V存储
• ACL安全：支持Consul ACL权限控制，确保配置访问安全
• 与Spring生态集成：兼容Spring Boot和Spring Cloud应用

使用场景和适用范围

• 开发环境：通过文件系统模式快速同步本地配置文件
• 生产环境：通过Git模式实现配置的版本控制和集中管理
• Spring Boot/Cloud应用：需要动态配置管理的微服务架构

使用方法和配置说明

文件系统模式

在此模式下，consul-config-loader代理会将config/目录下的所有YAML属性文件推送到Consul K/V存储。它会自动检测文件的添加或编辑，并将其重新加载到Consul中。

1. 在bootstrap.yml中配置以下属性：

yaml
spring:
    cloud:
        consul:
            config:
                format: yaml
                profile-separator: "-"

2. 运行以下命令启动Consul服务器和代理：

bash
docker-compose -f quickstart/consul-loader-filesystem.yml up

3. 访问Consul UI查看同步的配置：http://localhost:8500/ui/#/dc1/kv/config/

Git模式

此模式推荐用于生产环境，是https://github.com/Cimpress-MCP/git2consul%E9%A1%B9%E7%9B%AE%E7%9A%84%E5%B0%81%E8%A3%85%E3%80%82

1. 在bootstrap.yml中配置以下属性：

yaml
spring:
    cloud:
        consul:
            config:
                fail-fast: true
                format: files
                profile-separator: "-"

2. 配置config/git2consul.json文件，使其从您自己的Git仓库加载配置。

3. 运行以下命令启动Consul和代理：

bash
docker-compose -f quickstart/consul-loader-git.yml up

ACL安全

为了维护KV访问和服务发现的安全性，此配置加载器要求Consul启用ACL，这需要存在主ACL令牌（通过环境变量MASTER_ACL_TOKEN引用）。该令牌用于创建客户端ACL令牌（由CLIENT_ACL_TOKEN变量提供），具有默认策略并用于写入配置更改。

• 客户端ACL的默认策略是允许KV读取和服务发现写入。可以使用ACL HTTP API更改此策略以实现自定义策略。
• 强烈建议使用随机字符串（如UUID）作为令牌值。MASTER_ACL_TOKEN和CLIENT_ACL_TOKEN不能相同。

要使JHipster或Spring Cloud应用使用ACL注册到Consul，只需在bootstrap.yml中添加客户端ACL令牌：

yaml
consul:
    token: my-client-acl-token

参考链接

• Spring Cloud Consul文档
• Consul K/V存储API文档
• https://github.com/Cimpress-MCP/git2consul