ploop/docs/guides/cloud-dev-services.md
2026-08-31 15:54:42 +08:00

2.3 KiB
Raw Permalink Blame History

云开发中间件

本指南说明 M0a 的开发 PostgreSQL、Redis 与 Docker Compose v2 工具边界。连接配置来自项目负责人批准的 secret 渠道,不是仓库文档或 CI 的输入。

前提

确认本机 Docker Compose v2 可用:

docker compose version

本工作项不会定义或启动本地 PostgreSQL/Redis 容器。Compose v2 只为后续完整平台的自包含编排和 E2E 保留。

配置本机环境

根目录的 .env.example 只给出字段与非敏感端口。将其复制为 .env,并只从获批的 secret 渠道填写实际连接信息:

cp .env.example .env

.env 被 Git 忽略,严禁提交、粘贴到文档或放入 CI 日志。当前字段使用 PLOOP_POSTGRES_* 和 PLOOP_REDIS_* 前缀;Redis 的本地开发入口使用 PLOOP_REDIS_HOST,可选的内部地址仅存为 PLOOP_REDIS_INTERNAL_HOST,不由检查器自动选择。

DNS 与网络边界

  • 开发机若无法通过当前系统 DNS 解析获批的 Redis 公网域名,可在本机 .env 的 PLOOP_REDIS_HOST 填入服务负责人验证过的公网 IP;实际值不得写入 .env.example 或文档。服务地址变更后必须重新执行显式连通性检查。
  • PLOOP_REDIS_INTERNAL_HOST 仅用于同一云 VPC 内的运行环境。本机开发不得将其作为 Redis 访问地址,也不应为了该地址修改 /etc/hosts。

显式连通性检查

make check-dev-services

该命令只对 .env 中的 PostgreSQL 与 Redis 主机/端口进行超时受限的 TCP 检查。它不会显示用户名或密码,不会尝试认证、执行 SQL、写数据库、清 Redis 或运行 RAG。

如需使用另一份本机配置,可显式指定:

make check-dev-services ENV_FILE=/absolute/path/to/local.env

CI 与安全边界

  • make check、make ci 和 scripts/ci.sh 不会读取 .env、访问云服务或启动 Docker。
  • 云服务检查仅供经授权的开发者手动运行;它不是 PR/CI gate。
  • 后续 API、worker 或 migration 开始读取这些字段时,必须仍将凭据留在进程环境中,不能写入数据库、artifact、浏览器 DTO、日志或错误文本。
  • 需要自包含的本地 PostgreSQL/Redis Compose 服务时,先创建新的工作项;不得把本机容器与当前云开发数据混用。