minicliposs/gonsul

Gonsul 镜像文档

镜像概述

Gonsul是一个基于Go语言开发的工具，作为Hashicorp Consul KV存储的Golang入口点。其核心目标是弥补Consul缺乏内置审计机制的不足，并实现配置的Git化管理，使开发团队能够通过熟悉的Git工作流（如git-flow或develop-to-master流程）更友好地管理Consul配置。

核心功能与特性

• Git与Consul集成：将Consul KV存储的配置与Git仓库同步，实现配置的版本控制
• 审计支持：提供配置变更的审计能力，解决Consul原生缺乏审计机制的问题
• Git工作流兼容：支持主流Git工作流（如git-flow、develop-to-master），符合开发团队协作习惯
• Go语言实现：基于Go语言开发，具备轻量、高效、跨平台的特性

使用场景与适用范围

• 开发团队配置管理：需要多人协作管理Consul配置，且希望通过Git进行版本控制和变更追踪的场景
• 配置审计需求：对Consul配置变更有审计要求，需要记录谁、何时、为何修改配置的场景
• Git工作流实践：团队已采用Git工作流（如feature分支开发、代码审查后合并到主分支），希望将此流程延伸到配置管理的场景

使用方法与配置说明

基本使用

通过Docker运行Gonsul容器，需配置Git仓库地址、Consul连接信息以及同步策略等参数。

Docker Run示例

bash
docker run -d \
  --name gonsul \
  -e GIT_REPO_URL="https://github.com/your-org/consul-configs.git" \
  -e CONSUL_ADDR="consul:8500" \
  -e SYNC_INTERVAL="300" \  # 同步间隔（秒）
  -e GIT_BRANCH="master" \   # 要同步的Git分支
  your-registry/gonsul:latest

Docker Compose示例

yaml
version: '3'
services:
  gonsul:
    image: your-registry/gonsul:latest
    container_name: gonsul
    environment:
      - GIT_REPO_URL=https://github.com/your-org/consul-configs.git
      - CONSUL_ADDR=consul:8500
      - SYNC_INTERVAL=300
      - GIT_BRANCH=master
      - GIT_USERNAME=your-git-username  # 若Git仓库需要认证
      - GIT_PASSWORD=your-git-password
    depends_on:
      - consul
  consul:
    image: consul:latest
    ports:
      - "8500:8500"

环境变量配置

工作流程说明

1. 开发人员在Git仓库的指定分支（如develop）修改配置文件
2. 通过Git提交变更并发起合并请求（如合并到master分支）
3. Gonsul定期（根据SYNC_INTERVAL）拉取Git仓库最新代码
4. 检测到配置变更后，Gonsul将更新同步至Consul KV存储
5. 所有变更记录可通过Git日志进行审计，实现配置变更的可追溯