ferdous/flyaway

flyaway 镜像说明

镜像概述

该镜像是基于JHipster 6.7.1生成的网关应用，作为微服务架构的入口层，负责请求路由、服务发现与配置管理。应用需依赖JHipster Registry运行，支持OAuth2/OpenID Connect安全认证，并可集成PostgreSQL数据库、Kafka消息队列等组件，适用于构建分布式、可扩展的微服务系统。

核心功能

1. 微服务网关：统一接收外部请求并路由到对应微服务。
2. 服务发现与配置：通过JHipster Registry实现服务注册、动态配置与健康检查。
3. 安全认证：支持Keycloak/Okta的OAuth2/OpenID Connect认证，保障系统安全。
4. 多环境适配：支持开发、测试、生产环境的构建与部署，可打包为Jar或War文件。
5. 组件集成：兼容PostgreSQL、Kafka、SonarQube等常用技术栈。

使用场景

• 构建微服务架构的统一入口，简化外部请求处理。
• 需要动态服务发现与配置的分布式系统。
• 需集成OAuth2/OpenID Connect认证的企业级应用。
• 基于JHipster生态的微服务开发与部署。

配置说明

开发环境启动

1. 依赖安装：安装Node.js和Yarn后，执行yarn install安装前端依赖。
2. 启动服务：
   • 启动JHipster Registry（默认地址：http://localhost:8761）。
   • 分别运行./mvnw（后端）和yarn start（前端），实现热更新开发。

安全认证配置

Keycloak

启动Keycloak容器：

bash
docker-compose -f src/main/docker/keycloak.yml up

application.yml默认已配置Keycloak参数，无需额外修改即可使用。

Okta

1. 在Okta开发者平台创建OIDC应用，获取client-id和client-secret。
2. 修改src/main/resources/config/application.yml中的参数：

   yaml
   spring:
     security:
       oauth2:
         client:
           provider:
             oidc:
               issuer-uri: https://{yourOktaDomain}/oauth2/default
           registration:
             oidc:
               client-id: {clientId}
               client-secret: {clientSecret}
   

Docker部署示例

构建生产镜像

bash
./mvnw -Pprod verify jib:dockerBuild

启动完整应用（含依赖服务）

bash
docker-compose -f src/main/docker/app.yml up -d

Kubernetes部署

1. 推送镜像到Registry：

   bash
   docker tag flyaway ferdous/flyaway
   docker push ferdous/flyaway
   

2. 部署应用：

   bash
   ./kubectl-apply.sh
   

3. 查看服务地址：

   bash
   kubectl get svc flyaway
   

其他功能说明

• PWA支持：启用index.html中的Service Worker代码即可开启渐进式Web应用功能。
• 代码质量分析：启动SonarQube容器后，执行./mvnw -Pprod clean verify sonar:sonar进行代码质量检查。
• 实体再生：使用JHipster命令再生实体（如jhipster entity Answer --regenerate）以更新数据模型。
• Kafka管理：可通过kafka-topics.sh命令创建、删除或查看Kafka主题。