docs: 新增统一端口分配清单文档 (#798) #841

Merged
xiaoxia merged 1 commits from docs/ci-port-inventory into develop 2026-07-24 21:29:32 +08:00
Owner

背景

#798 - 建立统一端口分配清单文档(P2)

内容

梳理代码中所有服务/容器使用的端口,形成统一文档。

涵盖范围

  • 应用服务端口:API(8000) / Web(80) / Worker(无端口)
  • 基础设施端口:PostgreSQL / Redis / Registry
  • CI/DevOps端口:ChatOps Webhook(8090) / Staging SSH(22222) / Preview环境
  • 开发环境默认端口:.env.example 中全部端口变量
  • CI Workflow 中的端口变量:ci-pipeline.yml + ci_env.sh
  • 命名规范:推荐统一 {服务}_PORT 格式,列出待统一项
  • 相关配置文件路径索引

关键数据

服务 容器内 Staging宿主机 Production宿主机
API 8000 8000 8001
Web 80 3001 3002
PG 5432 5434 5433
Redis 6379 6381 6380

变更

  • 新增 docs/PORTS.md - 端口分配清单文档

验证

  • 纯文档新增,不影响业务代码
  • 不涉及 CI 流程变更
## 背景 #798 - 建立统一端口分配清单文档(P2) ## 内容 梳理代码中所有服务/容器使用的端口,形成统一文档。 ### 涵盖范围 - **应用服务端口**:API(8000) / Web(80) / Worker(无端口) - **基础设施端口**:PostgreSQL / Redis / Registry - **CI/DevOps端口**:ChatOps Webhook(8090) / Staging SSH(22222) / Preview环境 - **开发环境默认端口**:.env.example 中全部端口变量 - **CI Workflow 中的端口变量**:ci-pipeline.yml + ci_env.sh - **命名规范**:推荐统一 `{服务}_PORT` 格式,列出待统一项 - **相关配置文件路径索引** ### 关键数据 | 服务 | 容器内 | Staging宿主机 | Production宿主机 | |------|--------|--------------|-----------------| | API | 8000 | 8000 | 8001 | | Web | 80 | 3001 | 3002 | | PG | 5432 | 5434 | 5433 | | Redis | 6379 | 6381 | 6380 | ## 变更 - 新增 `docs/PORTS.md` - 端口分配清单文档 ## 验证 - ✅ 纯文档新增,不影响业务代码 - ✅ 不涉及 CI 流程变更
xiaoxia self-assigned this 2026-07-24 20:24:06 +08:00
xiaoxia added 1 commit 2026-07-24 20:24:06 +08:00
docs: 新增统一端口分配清单文档 (#798)
CI/CD Pipeline / Check if frontend-only change (pull_request) Successful in 24s
CI/CD Pipeline / Validate - Migration (alembic) (pull_request) Successful in 1m14s
CI/CD Pipeline / Validate - Type Check (mypy) (pull_request) Successful in 1m32s
CI/CD Pipeline / Frontend Lint (pull_request) Successful in 36s
CI/CD Pipeline / PR Build Web Image (pull_request) Successful in 20s
CI/CD Pipeline / Build Staging API Image (pull_request) Has been skipped
CI/CD Pipeline / Build Staging Web Image (pull_request) Has been skipped
CI/CD Pipeline / Build Staging Worker Image (pull_request) Has been skipped
CI/CD Pipeline / PR Build Worker Image (pull_request) Successful in 18s
CI/CD Pipeline / PR Build API Image (pull_request) Successful in 2m28s
Preview Deploy / Deploy Preview Environment (pull_request) Failing after 10s
AI Code Review / AI Code Review (pull_request) Successful in 2m27s
PR Automation / Auto Approve on CI Green (pull_request) Successful in 3m16s
CI/CD Pipeline / Validate - Code Quality (pull_request) Successful in 5m43s
CI/CD Pipeline / Frontend Unit Tests (pull_request) Has been skipped
CI/CD Pipeline / Build Production API Image (pull_request) Has been skipped
CI/CD Pipeline / Build Production Web Image (pull_request) Has been skipped
CI/CD Pipeline / Build Production Worker Image (pull_request) Has been skipped
CI/CD Pipeline / Deploy Staging (Watchtower auto-deploy) (pull_request) Has been skipped
CI/CD Pipeline / Unit Tests (pull_request) Successful in 6m26s
CI/CD Pipeline / Integration Tests (pull_request) Successful in 2m48s
CI/CD Pipeline / Deploy Production (pull_request) Has been skipped
CI/CD Pipeline / Staging E2E Tests (pull_request) Has been skipped
CI/CD Pipeline / Staging API Integration Tests (pull_request) Has been skipped
CI/CD Pipeline / ACR Image Cleanup (pull_request) Has been skipped
CI/CD Pipeline / Production Browser E2E (pull_request) Has been skipped
PR Automation / Auto Merge on CI Green + Approved (pull_request) Successful in 50m4s
Preview Cleanup / Cleanup Preview Environment (pull_request) Successful in 7s
edc9c50268
梳理所有服务/容器/CI环境的端口分配,形成统一参考文档。
涵盖API/Web/PG/Redis/Registry/ChatOps等全部端口。
Collaborator

代码审查结果 - PR #841

⚠️ 问题(2个需要修改)

  1. docs/PORTS.md 第6行:文档更新时间显示为 2026-07-24,属于未来时间。这通常是年份笔误,会导致文档时效性信息混乱。
  2. docs/PORTS.md 第56行:硬编码了具体的内网 IP 地址 172.30.18.198。如果该仓库为公开或半公开状态,直接暴露内网架构细节属于信息泄露风险。建议使用占位符(如 ${GITEA_INTERNAL_IP}gitea-registry.internal)代替。

💡 建议(0个可选)


格式检查通过 | 逻辑审查需修改 | 建议关注性能


🤖 由 AI 代码审查机器人自动生成 | 2026-07-24 12:31:57 | 模型:

## 代码审查结果 - PR #841 ### ⚠️ 问题(2个需要修改) 1. **docs/PORTS.md 第6行**:文档更新时间显示为 `2026-07-24`,属于未来时间。这通常是年份笔误,会导致文档时效性信息混乱。 2. **docs/PORTS.md 第56行**:硬编码了具体的内网 IP 地址 `172.30.18.198`。如果该仓库为公开或半公开状态,直接暴露内网架构细节属于信息泄露风险。建议使用占位符(如 `${GITEA_INTERNAL_IP}` 或 `gitea-registry.internal`)代替。 ### 💡 建议(0个可选) --- ✅ 格式检查通过 | ❌ 逻辑审查需修改 | ✅ 建议关注性能 --- <sub>🤖 由 AI 代码审查机器人自动生成 | 2026-07-24 12:31:57 | 模型: </sub> <!-- AI_CODE_REVIEW_AUTO_COMMENT -->
xiaoxia merged commit c9c7da0c74 into develop 2026-07-24 21:29:32 +08:00
xiaoxia deleted branch docs/ci-port-inventory 2026-07-24 21:29:32 +08:00

🗑️ 预览环境已清理

PR #841 已关闭或合并,对应的预览环境已被清理。

如有需要,可以重新打开 PR 来重新生成预览环境。

🗑️ **预览环境已清理** PR #841 已关闭或合并,对应的预览环境已被清理。 > 如有需要,可以重新打开 PR 来重新生成预览环境。
Sign in to join this conversation.