StellMap Console

stellmap-console 是 StellMap 注册中心的控制台项目，面向平台管理员和开发者提供服务实例查询、服务目录展示、注册中心状态查看和运维辅助能力。

项目概述

本项目定位为 StellMap 的前端或控制面入口。它不承载注册中心核心一致性逻辑，而是通过后端 API 读取服务目录、实例状态和集群运行信息，帮助使用者理解当前服务拓扑。

当前状态

项目	说明
稳定性	初始化中
项目类型	注册中心控制台
适用对象	平台管理员、研发人员、SRE
维护方	StellHub

解决什么问题

• 展示 namespace、service 和 instance 维度的服务目录。
• 查询服务实例状态、endpoint、labels 和 metadata。
• 查看注册中心集群状态和基础运行信息。
• 为运维排查提供可视化入口。

不解决什么问题

• 不实现注册中心服务端。
• 不直接修改 Raft、存储或实例租约逻辑。
• 不替代服务治理、配置中心或日志平台。

核心能力

能力	说明
服务目录	展示服务列表和实例列表
实例详情	查看实例 endpoint、labels、metadata
集群状态	查看注册中心节点状态
运维入口	提供基础排查视图

架构说明

flowchart LR
    User[User] --> Console[StellMap Console]
    Console --> API[StellMap API]
    API --> Service[StellMap Service]

Loading

快速开始

npm install
npm run dev

构建生产包：

npm run build

配置说明

配置项	是否必填	说明
VITE_API_BASE_URL	是	StellMap API 地址
VITE_APP_TITLE	否	控制台标题

本地开发

npm run lint
npm run test
npm run build

版本与升级

• MAJOR：不兼容路由、权限或 API 返回结构变更。
• MINOR：向后兼容的新页面或新能力。
• PATCH：向后兼容的问题修复。

可观测性

类型	名称	说明
Log	API_REQUEST_FAILED	后端接口调用失败
Log	PAGE_RENDER_ERROR	页面渲染异常

故障排查

页面没有数据

1. 检查 VITE_API_BASE_URL 是否正确。
2. 检查 StellMap Service 是否可访问。
3. 检查浏览器控制台网络请求。

安全说明

生产环境应通过统一网关访问后端 API，前端配置不应包含敏感运行信息。

目录结构

.
├── src/            # 前端源码
├── public/         # 静态资源
├── package.json    # 前端依赖与脚本
└── README.md       # 项目说明

贡献规范

• API 字段变更需要同步更新类型定义和页面展示。
• 页面交互变更需要保证基础可用性。
• 行为变更必须同步更新 README 或 docs。

支持

由 StellHub 维护。建议通过 GitHub Issues 记录问题、需求和设计讨论。

许可证

以仓库内 LICENSE 文件为准。