jhipster/jhipster-registry

JHipster Registry

https://github.com/jhipster/jhipster-registry/actions https://github.com/jhipster/jhipster-registry/actions

概述

JHipster Registry 是基于 Spring Cloud Netflix、https://github.com/Netflix/eureka 和 Spring Cloud Config 构建的服务注册中心，专为 JHipster 微服务架构设计。其核心功能包括服务注册与发现、分布式配置管理，是微服务架构中协调服务通信与配置同步的关键组件。

核心功能与特性

• 服务注册与发现：基于 Eureka 实现微服务实例的自动注册、健康状态监控及服务信息同步，支持服务间动态发现。
• 分布式配置管理：集成 Spring Cloud Config，支持从本地文件系统（原生配置）或 Git 仓库拉取配置，实现配置集中化与动态更新。
• 多环境支持：内置开发（dev）、生产（prod）等环境配置，适配不同部署场景需求。
• HashiCorp Vault 集成：支持与 Vault 密钥管理工具集成，安全存储敏感配置（如密码、API 密钥）。
• Web 管理界面：提供直观的 UI 控制台，用于监控服务状态、查看配置信息及管理注册实例。

使用场景与适用范围

• 微服务架构环境：作为核心注册中心，适用于需要集中管理服务注册、发现及配置的微服务系统。
• 开发与测试环境：支持本地快速启动及前端热重载，便于开发调试。
• 生产环境注意事项：Eureka 依赖独立 URL 同步实例状态，多实例部署需确保各节点具有唯一访问地址；Heroku 部署时仅支持原生配置，且无法通过扩展 dyno 实现冗余（需手动部署多个独立实例）。

使用方法

本地运行

开发模式

• 快速启动（含后端服务）：

  shell
  ./mvnw -Pdev,webapp
  

• 前端热重载（需单独启动）：

  shell
  # 启动后端服务
  ./mvnw
  # 安装前端依赖并启动热重载
  npm install && npm start
  

生产模式

shell
./mvnw -Pprod

Docker 部署

基础运行命令

使用 Docker Hub 官方镜像启动（默认端口 8761）：

shell
docker run -p 8761:8761 jhipster/jhipster-registry

指定环境变量

通过环境变量配置运行参数（如指定生产环境）：

shell
docker run -p 8761:8761 -e SPRING_PROFILES_ACTIVE=prod jhipster/jhipster-registry

Docker Compose 示例（含 Vault 集成）

yaml
version: '3'
services:
  jhipster-registry:
    image: jhipster/jhipster-registry
    ports:
      - "8761:8761"
    environment:
      - SPRING_PROFILES_ACTIVE=dev
      - VAULT_TOKEN=jhipster-registry
    depends_on:
      - vault
  vault:
    image: vault:latest
    ports:
      - "8200:8200"
    environment:
      - VAULT_DEV_ROOT_TOKEN_ID=jhipster-registry
    volumes:
      - ./vault-config/config:/vault/config
      - ./vault-config/logs:/vault/logs
      - ./vault-config/data:/vault/file

Heroku 部署

一键部署

点击按钮部署独立实例：

![Deploy to Heroku]([***]

部署限制

• 配置模式：仅支持 原生配置（不支持 Git 配置）。
• 实例扩展：无法通过扩展 dyno 实现冗余，需手动部署多个独立应用（多次点击部署按钮），因 Eureka 需独立 URL 同步内存状态。

配置说明

Spring Cloud Config 配置

支持两种配置源：

• 原生配置（Native）：从本地文件系统加载配置，适用于 Heroku 部署等场景。
• Git 配置：从 Git 仓库拉取配置，需在配置文件中指定仓库 URL（生产环境推荐）。

HashiCorp Vault 集成

开发模式（内存后端，数据不持久化）

1. 启动 Vault 容器：

   shell
   docker-compose -f src/main/docker/vault.yml up -d
   

2. 配置密钥：

   • 默认 root token 为 jhipster-registry，密钥引擎挂载于 secrets 路径。
   • 通过 Vault UI（http://localhost:8200）、CLI 或 HTTP API 创建密钥路径 jhipster-registry/dev（jhipster-registry 为应用名，dev 为开发环境），添加 JSON 格式密钥：

     json
     {
       "spring.security.user.password": "admin123!@#"
     }
     

3. 启动 JHipster Registry（跳过测试）：

   shell
   ./mvnw -DskipTests
   

4. 访问验证：通过 http://localhost:8761 访问，使用配置的密码 admin123!@# 登录。

服务器模式（文件系统后端，数据持久化）

1. 修改 Vault 配置：编辑 src/main/docker/vault.yml，取消以下配置注释：

   yaml
   command: server
   volumes:
     - ./vault-config/config:/vault/config
     - ./vault-config/logs:/vault/logs
     - ./vault-config/data:/vault/file
   

2. 启动 Vault 容器：

   shell
   docker-compose -f src/main/docker/vault.yml up -d
   

3. 初始化 Vault：

   • 访问 Vault UI（http://localhost:8200），初始化密钥份额（如 1 个份额、1 个阈值），记录 root token 和 unseal key。
   • 启用 KV 密钥引擎，挂载于 secrets 路径。

4. 配置密钥：创建密钥路径 jhipster-registry/dev，添加与开发模式相同的 JSON 密钥。

5. 更新 JHipster Registry 配置：修改 bootstrap.yml，指定 Vault token（使用初始化时的 root token）：

   yaml
   vault:
     authentication: token
     token: <your-root-token>  # 替换为实际 root token
   

6. 启动 JHipster Registry：

   shell
   ./mvnw -DskipTests
   

7. 访问验证：使用 Vault 配置的密码登录。

附录：常用环境变量