rajibhalder/configuration-server-prod

配置服务器 Docker 镜像文档

镜像概述

本镜像提供一个轻量级配置服务器，旨在解决分布式系统中配置文件分散管理的问题。通过集中式配置存储与分发，实现配置的统一管理、动态更新及版本控制，无需重启应用即可使配置生效，特别适用于微服务架构及多环境部署场景。

核心功能与特性

• 集中式配置管理：将所有应用配置集中存储，避免配置文件散落在各服务实例中
• 动态配置更新：支持配置实时推送更新，应用可动态感知配置变化并加载新配置
• 多环境支持：内置环境隔离机制，可分别管理开发（dev）、测试（test）、生产（prod）等环境配置
• 配置版本控制：集成版本管理功能，支持配置历史回溯与版本对比
• 安全访问控制：提供配置加密存储与访问权限控制，保护敏感配置信息
• 高可用部署：支持集群部署模式，通过负载均衡实现服务高可用

使用场景与适用范围

• 分布式系统：解决跨服务、跨节点的配置一致性问题
• 微服务架构：为微服务集群提供统一配置源，简化服务配置管理
• 多环境部署：同一应用在不同环境（开发/测试/生产）的差异化配置管理
• 频繁配置调整场景：需快速调整业务参数（如限流阈值、功能开关）的应用
• 配置敏感信息管理：对数据库密码、API密钥等敏感配置进行加密存储

使用方法与配置说明

基本使用（Docker Run）

bash
docker run -d \
  -p 8888:8888 \
  -e SPRING_PROFILES_ACTIVE=prod \
  -e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=https://github.com/your-org/config-repo \
  -e SPRING_CLOUD_CONFIG_SERVER_GIT_USERNAME=your-username \
  -e SPRING_CLOUD_CONFIG_SERVER_GIT_PASSWORD=your-token \
  --name config-server \
  your-registry/config-server:latest

Docker Compose 配置示例

yaml
version: '3.8'
services:
  config-server:
    image: your-registry/config-server:latest
    container_name: config-server
    ports:
      - "8888:8888"
    environment:
      - SPRING_PROFILES_ACTIVE=prod                     # 运行环境，默认值：default
      - SERVER_PORT=8888                               # 服务端口，默认值：8888
      - SPRING_CLOUD_CONFIG_SERVER_GIT_URI=https://github.com/your-org/config-repo  # 配置存储Git仓库地址（必填）
      - SPRING_CLOUD_CONFIG_SERVER_GIT_USERNAME=your-username  # Git仓库访问用户名（私有仓库必填）
      - SPRING_CLOUD_CONFIG_SERVER_GIT_PASSWORD=your-token      # Git仓库访问密码/令牌（私有仓库必填）
      - SPRING_CLOUD_CONFIG_SERVER_GIT_SEARCH_PATHS=configs/**  # 配置文件搜索路径，默认值：**
      - SPRING_CLOUD_CONFIG_SERVER_GIT_LABEL=main       # Git分支/标签，默认值：master
      - ENCRYPT_KEY=your-encryption-key                # 配置加密密钥，用于加密敏感配置
    restart: always

环境变量说明

配置文件结构规范

配置文件需按以下结构存储在Git仓库中：

config-repo/
├── application.yml          # 全局默认配置（所有环境共享）
├── application-dev.yml      # 开发环境配置
├── application-test.yml     # 测试环境配置
├── application-prod.yml     # 生产环境配置
├── service-a-dev.yml        # 服务service-a的开发环境配置
└── service-a-prod.yml       # 服务service-a的生产环境配置

配置访问示例

应用通过HTTP请求获取配置：

http
# 获取服务service-a在prod环境的配置
GET http://config-server:8888/service-a/prod

# 获取服务service-a在prod环境、main分支的配置
GET http://config-server:8888/service-a/prod/main

响应示例（JSON格式）：

json
{
  "name": "service-a",
  "profiles": ["prod"],
  "label": "main",
  "version": "a1b2c3d",
  "state": null,
  "propertySources": [
    {
      "name": "https://github.com/your-org/config-repo/service-a-prod.yml",
      "source": {
        "server.port": 8080,
        "db.url": "jdbc:mysql://prod-db:3306/service_a"
      }
    }
  ]
}

注意事项

1. 敏感配置（如数据库密码）建议使用ENCRYPT_KEY加密后存储，加密命令：curl -X POST http://config-server:8888/encrypt -d "sensitive-value"
2. 生产环境建议部署至少2个实例组成集群，配合负载均衡实现高可用
3. Git仓库需确保配置服务器有读取权限，私有仓库建议使用访问令牌（Token）而非明文密码
4. 配置更新后，客户端应用需通过@RefreshScope注解（Spring Cloud应用）或实现配置刷新机制感知变更