mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-09-29 22:06:38 +08:00
ryan
600a7acdfb
- 删除未经验证的环境要求（Docker 版本号、浏览器条目）与括号废话 - 故障排查改为真实处理路径（升级→重新发布→强制同步→重建 Agent→提交 issue），删除仅开发时用的排障章节 - 删除设计文档中的测试与验收、实现检查清单、贡献者阅读建议等开发内容 - 修正与代码不符的事实：reset-passwd 命令名、证书续签窗口 7 天、Pages 检查间隔 1440 分钟、Relay vhost 端口 8080、SSO 仅支持 OIDC 等 - 去除口语化表述与无意义括号，改写「不是…而是…」句式 - 同步修正文档站链接锚点，构建验证通过
94 lines
5.8 KiB
Markdown
94 lines
5.8 KiB
Markdown
# Zone 与域名资源设计
|
||
|
||
## 目标
|
||
|
||
将“网站”重构为以可注册根域为入口的 Zone 管理体验。`example.com` 之类的 Zone 是稳定的管理边界；用户通过稳定 ID 路径进入该 Zone，查看并维护其中明确声明的域名、域名所绑定的反代路由和证书，以及路由级 WAF、Pages 等能力。
|
||
|
||
本设计替代 `managed_domains` 的概念、表与 API。Zone 核心 **不** 内建权威 DNS 解析记录管理；若需将 ZoneDomain 的 A 记录指向边缘节点，使用可选模块 [Cloudflare DNS 指向](./cloudflare-pointing.md)。
|
||
|
||
## 范围与约束
|
||
|
||
* Zone 根域使用 Public Suffix List 解析，例如 `api.example.co.uk` 归属 `example.co.uk`。
|
||
* URL 使用 ID：列表为 `/websites`，详情为 `/websites/:zoneId`；不使用域名作为 URL 参数。
|
||
* Zone 域名必须是明确的 FQDN，禁止录入 `*.example.com`。TLS 证书可仍含通配符 SAN，并用于覆盖明确的 Zone 域名。
|
||
* 一个 Zone 域名至多关联一条反代路由；一条反代路由可关联多个 Zone 域名，因而可跨 Zone 共享同一套上游、缓存、限流、WAF 与 Pages 配置。
|
||
* Zone 模型本身不新增 DNS 记录、边缘函数、预览子域或租户隔离能力。对外 DNS A 记录的创建/更新由独立的 Cloudflare 指向模块负责，且不改变 Zone / ZoneDomain 表职责。
|
||
|
||
## 核心模型
|
||
|
||
```mermaid
|
||
erDiagram
|
||
ZONES ||--o{ ZONE_DOMAINS : contains
|
||
PROXY_ROUTES ||--o{ ZONE_DOMAINS : serves
|
||
TLS_CERTIFICATES ||--o{ ZONE_DOMAINS : secures
|
||
PROXY_ROUTES ||--o{ WAF_RULE_GROUP_BINDINGS : applies
|
||
PAGES_PROJECTS ||--o{ PROXY_ROUTES : backs
|
||
|
||
ZONES {
|
||
uint id PK
|
||
string domain UK
|
||
}
|
||
ZONE_DOMAINS {
|
||
uint id PK
|
||
uint zone_id
|
||
uint proxy_route_id
|
||
string domain UK
|
||
uint cert_id
|
||
}
|
||
```
|
||
|
||
### `of_zones`
|
||
|
||
保存根域、创建时间与更新时间。根域全局唯一且创建后不可原地修改；需要变更时新建 Zone 并迁移域名。删除 Zone 前必须先清空其 Zone 域名。
|
||
|
||
### `of_zone_domains`
|
||
|
||
保存 `zone_id`、明确 `domain`、可空的 `proxy_route_id`、可空的 `cert_id` 及时间戳。`domain` 全局唯一；所有关系字段建立索引但不建立物理外键。`proxy_route_id` 允许为空，以承接已准备证书但尚未配置反代的历史域名。
|
||
|
||
`of_proxy_routes` 逐步移除 `domain`、`domains`、`cert_id`、`cert_ids` 与 `domain_cert_ids` 等域名/证书冗余列。路由不得再指定任何 TLS 证书；路由名称 `site_name` 成为稳定的人类可读标识，编译器从关联的 Zone 域名读取 `server_name` 与其 `cert_id`。这使每个明确域名的证书只有一个来源。
|
||
|
||
## 业务与 API
|
||
|
||
管理端新增 Zone 资源：
|
||
|
||
* `GET/POST /api/v1/d/zones`
|
||
* `GET/POST /api/v1/d/zones/:id/update`
|
||
* `POST /api/v1/d/zones/:id/delete`
|
||
* `POST /api/v1/d/zones/:id/domains`（列表经 overview 返回）
|
||
* `POST /api/v1/d/zones/:id/domains/:domainID/update`
|
||
* `POST /api/v1/d/zones/:id/domains/:domainID/delete`
|
||
* `GET /api/v1/d/zones/:id/overview`
|
||
|
||
反代路由的创建、更新请求改用 `zone_domain_ids`，不再提交 `domains`、`cert_id`、`cert_ids` 或 `domain_cert_ids`。服务端在事务中验证域名归属、全局唯一性和证书 SAN 覆盖；失败通过 `response.Abort*` 统一返回。删除已绑定路由的 Zone 域名必须先解除或删除该路由；删除仍有域名的 Zone 必须拒绝。
|
||
|
||
WAF、Pages、上游与发布版本仍属于 `proxy_routes`。Zone 概览只聚合展示其域名关联的路由状态，不复制或重新定义这些配置。
|
||
|
||
## 前端体验
|
||
|
||
`/websites` 只展示 Zone 根域，显示已配置域名数、路由数与状态，并提供搜索、创建和操作菜单。点击进入 `/websites/:zoneId`。
|
||
|
||
详情页包含：
|
||
|
||
* 概览：域名、路由和有效证书统计；域名—路由—证书摘要；路由级 WAF 与 Pages 摘要。
|
||
* 域名：明确 FQDN 的列表、证书选择和关联路由；不显示或接受通配符域名。
|
||
* 路由：筛选到当前 Zone 的路由并链接到既有路由详情。
|
||
* 证书：当前 Zone 域名实际引用的证书。
|
||
* 设置：Zone 备注和受保护的删除操作。
|
||
|
||
新增路由时从 Zone 域名中选择；用户也可以先在 Zone 中登记域名，再绑定路由。全局反代路由入口保留，但改用同一套 Zone 域名选择器。
|
||
|
||
## 数据迁移
|
||
|
||
本次改造分两个发布阶段，以免 SQL 用错误的“末两段域名”规则处理多级公共后缀。操作细则见 [Zone 域名迁移与发布验收](../guide/zone-domain-migration.md)。
|
||
|
||
1. **第一阶段 DDL**：PostgreSQL 与 SQLite 同版本 Goose 创建 `of_zones` / `of_zone_domains`；暂时保留 `of_managed_domains` 与路由冗余列。
|
||
2. **数据导入（自动）**：Server 启动时 `migrator.Migrate()` 先应用 goose SQL 至 `202607120002`，再自动导入旧路由域名 / `managed_domains`（`publicsuffix` 解析注册根域，写入 `cert_id` 与 `proxy_route_id`），最后继续后续 SQL。冲突时启动失败；修复后重启可幂等重试。无需手动命令。
|
||
3. **代码切换**：控制面 API、配置快照、渲染、前端均以 Zone 域名为唯一来源；路由写入仅使用 `zone_domain_ids`。
|
||
4. **第二阶段清理**：Goose SQL `202607130001_drop_legacy_route_domain_columns` 删除 `of_managed_domains` 与 `of_proxy_routes` 冗余列。Down 仅恢复开发库空结构，不回填历史数据。
|
||
|
||
### 运行时模型边界
|
||
|
||
* 持久化：域名与证书只存在于 `of_zone_domains`；`of_proxy_routes` 仅保存路由策略（上游、缓存、限流、WAF 绑定键等）。
|
||
* 渲染：配置快照在内存中组装临时 `Domains` / `DomainCertIDs` 供 OpenResty 渲染，不写回数据库。
|
||
* 结构迁移仅使用 `internal/infra/persistence/migrator/goose/{postgres,sqlite}/*.sql`；启动时自动导入历史域名，第二阶段后旧列不存在则为空操作。
|