jhipster/consul-config-loader

Consul Config Loader

一个基于Docker的小型工具，用于将Spring Boot和/或Micronaut属性文件加载到Consul K/V存储。它支持热重载以及文件系统和Git模式。

核心功能与特性

• 多框架支持：兼容Spring Boot和Micronaut框架，可通过环境变量控制启用状态
• 热重载：自动检测文件变更并同步到Consul K/V存储
• 文件系统模式：监控本地config/目录下的YAML文件，实时同步到Consul
• Git模式：基于https://github.com/Cimpress-MCP/git2consul项目，适合生产环境，支持从Git仓库加载配置
• ACL安全：支持Consul ACL功能，通过主令牌创建客户端令牌，保障KV访问和服务发现的安全性

支持框架配置

默认仅启用Spring Boot支持，可通过以下环境变量控制框架兼容性：

• ENABLE_SPRING：是否启用Spring Boot支持，值为true或false
• ENABLE_MICRONAUT：是否启用Micronaut支持，值为true或false

使用场景

• 开发环境：使用文件系统模式，实时同步本地配置文件到Consul，便于开发调试
• 生产环境：使用Git模式，通过Git仓库管理配置，实现版本控制和集中化配置管理

使用方法

文件系统模式

在此模式下，工具会将config/目录下的所有YAML属性文件推送到Consul K/V存储，并自动检测文件新增或修改以重新加载。

配置步骤

1. 在bootstrap.yml中配置Consul：

   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项目的封装，推荐用于生产环境。

配置步骤

1. 在bootstrap.yml中配置Consul：

   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安全配置

工具要求Consul启用ACL功能，并通过环境变量提供令牌：

• MASTER_ACL_TOKEN：主ACL令牌，用于创建客户端ACL令牌
• CLIENT_ACL_TOKEN：客户端ACL令牌，用于KV读取和服务发现写入（默认策略）

注意：MASTER_ACL_TOKEN和CLIENT_ACL_TOKEN必须不同，建议使用随机字符串（如UUID）作为令牌值。

应用配置

在JHipster或Spring Cloud应用中，通过bootstrap.yml配置客户端令牌：

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

参考链接

• https://cloud.spring.io/spring-cloud-consul/#spring-cloud-consul-config
• https://www.consul.io/docs/agent/http/kv.html
• https://github.com/Cimpress-MCP/git2consul