# Dubhe

**Repository Path**: eltongu/dubhe

## Basic Information

- **Project Name**: Dubhe
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-23
- **Last Updated**: 2026-10-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 天枢 Dubhe

天枢 Dubhe 是一个企业级、技术型 API Gateway 平台，目标是提供高性能、低内存、云原生、分布式和可扩展的流量治理能力。

天枢只负责技术层面的网关能力：流量接入、路由、认证、鉴权、限流、上游保护、配置发布和运行时可观测性。

天枢不提供 API 商业化能力，也不包含套餐、订阅、商业配额、计费、账单、支付、开发者门户或任何其他网关产品的数据和插件迁移能力。

## 当前状态

项目当前处于产品和架构基线阶段，已完成开发前的核心契约定义，尚未进入完整 V1 产品实现。

当前版本路线：

| 版本 | 名称 | 目标 |
|---|---|---|
| V0 | Architecture Validation | 验证路由、快照、代理性能、认证和关键运行时风险 |
| V1 | Standalone Gateway | 无数据库、无在线 CP 依赖的单节点生产级网关 |
| V2 | Control Plane/Data Plane | 控制面、数据面、多 DP 配置发布和企业治理 |
| V3 | Enterprise Policy and WASM | 完整技术策略和第三方 WASM 扩展 |
| V4 | Kubernetes Platform and Distributed Deployment | Gateway API、CRD、Controller/Operator、多集群和多地域 |

## V1 边界

V1 计划包含：

- HTTP/1.1、HTTP/2、gRPC、WebSocket
- TLS 终止
- Listener、Route、Service、Upstream、Target
- 多条件路由和确定性优先级
- 负载均衡、健康检查、连接池、超时、有限重试和基础熔断
- API Key、JWT、mTLS
- 基础鉴权、限流、并发限制、连接限制和请求大小限制
- 本地 YAML 或等价声明式配置
- 不可变配置快照和原子切换
- Prometheus Metrics、结构化日志、OpenTelemetry Tracing
- Helm 部署

V1 不包含：

- Control Plane/Data Plane 集群化
- PostgreSQL/MySQL 控制面
- Gateway API、Ingress、CRD 或 Controller 配置转换
- Operator
- 多集群和多地域
- WASM 第三方插件生态
- 套餐、订阅、计费和开发者运营
- 任何其他网关产品的迁移或兼容能力

## 文档导航

### 产品文档

- [产品总纲](docs/product/product-charter.md)
- [术语与边界规范](docs/product/glossary-and-boundaries.md)
- [多阶段路线图](docs/product/roadmap.md)
- [V1/V2 版本范围与验收规格](docs/product/release-scope.md)

### 架构文档

- [总体架构](docs/architecture/overall-architecture.md)
- [资源模型](docs/architecture/resource-model.md)
- [配置与快照](docs/architecture/config-snapshot.md)
- [CP/DP 协议](docs/architecture/cp-dp-protocol.md)
- [路由引擎](docs/architecture/routing-engine.md)
- [路由语义](docs/architecture/routing-semantics.md)
- [策略执行模型](docs/architecture/policy-engine.md)
- [策略绑定与合并矩阵](docs/architecture/policy-matrix.md)
- [认证与 Secret 生命周期](docs/architecture/authentication-and-secrets.md)

### 接口契约

- [Management API V1 OpenAPI](api/openapi/management-v1.yaml)
- [CP/DP protobuf](proto/controlplane/v1/controlplane.proto)

### 开发治理

- [Agent 协作规范](docs/development/agent-collaboration.md)
- [质量门禁](docs/development/quality-gates.md)
- [任务模板](docs/development/task-template.md)
- [Definition of Done](docs/development/definition-of-done.md)
- [契约变更策略](docs/development/contract-change-policy.md)

## 核心架构原则

- Data Plane 不直接依赖数据库。
- Control Plane 不处理代理业务流量。
- DP 使用已校验、已编译的不可变配置快照。
- CP 不可用本身不得导致已有有效配置停止服务。
- Workspace 是首期唯一的强技术隔离边界。
- CallerIdentity 只表示技术调用方，不表示商业消费者。
- 核心策略使用 Rust 原生实现，第三方扩展使用 WASM 沙箱。
- Kubernetes 声明层与内部资源模型保持独立。

## 开发前置要求

当前仓库主要包含产品文档、架构设计和接口契约。正式开发前需要完成：

- Rust workspace 和 CI 基线
- `buf`/`protoc` protobuf 校验和代码生成
- OpenAPI lint 和代码生成流程
- V0 路由、快照、代理性能和认证 Spike
- V1 YAML Schema 和配置契约
- 上游重试、熔断和健康检查详细设计
- 可观测性指标、日志和 Trace 字段规范
- PostgreSQL/MySQL 控制面存储设计

## 参与开发

开发任务必须先阅读：

1. [产品总纲](docs/product/product-charter.md)
2. [术语与边界规范](docs/product/glossary-and-boundaries.md)
3. [V1/V2 版本范围与验收规格](docs/product/release-scope.md)
4. 相关架构文档和接口契约

涉及资源模型、管理 API、CP/DP 协议或插件 ABI 的破坏性变更，必须升级版本并经过 ADR 与兼容性检查。