totallymoney/consul-kv-primer

consul-kv-primer Docker镜像

https://hub.docker.com/r/totallymoney/consul-kv-primer/

镜像概述

Consul本身未提供启动时快速填充键值（KV）存储的便捷方式。在本地开发场景中，若应用依赖Consul KV中已存在的配置（如生产环境中的配置），这会成为一个问题。本镜像旨在解决Docker Compose启动目标环境时的该问题，只需通过environment或env_file属性提供所需环境变量即可。

核心功能

1. 等待Consul服务启动完成；
2. 通过Consul HTTP API将自身所有环境变量写入KV存储；
3. 完成后设置键IS_CONSUL_PRIMED的值为true，标识配置填充完成。

使用场景

本地开发环境中，当应用需要依赖Consul KV中的配置才能正常运行时，使用本镜像自动填充初始配置，模拟生产环境的配置状态。

配置说明

• 必填配置：CONSUL_URL：指向Consul服务的地址（如http://consul:8500）；
• 可选配置：通过environment字段直接设置或env_file引用文件，提供需要写入Consul KV的环境变量。

部署示例

1. 创建.env文件

env
FOO=bar
HELLO=world
HEY=youguys

2. 编写docker-compose.yml

yaml
version: '2'
services:
  consul-kv-primer:
    image: totallymoney/consul-kv-primer
    depends_on:
      - consul
    env_file: ./.env
    environment:
      - CONSUL_URL=http://consul:8500
  
  consul:
    image: consul
    ports:
      - "8500:8500"

3. 启动并验证

执行以下命令启动镜像：

bash
docker-compose up consul-kv-primer

验证配置是否写入：

bash
curl http://localhost:8500/v1/kv/HELLO?raw
# 预期输出：world

此时Consul的KV存储已完成初始填充，可在本地8500端口访问Consul服务。