yuxuanhui
32 lines
4.8 KiB
Markdown
32 lines
4.8 KiB
Markdown
# Gitea + Docker 生产部署
|
|
|
|
生产 Compose 只部署 Go API，连接已由其他服务管理的 PostgreSQL；数据库可以在同一主机，也可以在另一台服务器。本地开发继续使用包含 PostgreSQL 的 `compose.yaml`。小程序仍由微信开发者工具发布，构建时的 `TARO_APP_API_BASE_URL` 应指向此 API 的 HTTPS 域名。
|
|
|
|
## 首次准备
|
|
|
|
1. 在目标 Linux 主机安装 Docker Engine、Docker Compose、Git、Bash、`flock` 和 `curl`。按照 [Gitea Runner 文档](https://docs.gitea.com/usage/actions/act-runner/)在这台主机上注册仓库专用的 `act_runner`，为它配置 `tencent-prod:host` 标签，并确保 Runner 用户可以执行 Docker 命令和 `actions/checkout@v4`。此工作流在宿主机执行代码且拥有 Docker 权限，只应给可信仓库和维护者使用。
|
|
2. 在 Gitea 仓库启用 Actions，并按[密钥文档](https://docs.gitea.com/usage/actions/secrets/)设置 `DATABASE_URL`、`WECHAT_APP_ID`、`WECHAT_APP_SECRET`。数据库连接只使用一个 `DATABASE_URL` 密钥；`WECHAT_APP_ID` 必须与小程序 AppID 一致。缺少密钥会在 Compose 校验时失败；校验使用 `config --quiet`，不会打印展开后的密钥。
|
|
3. `DATABASE_URL` 使用 `postgresql://用户名:已编码密码@数据库主机:端口/数据库名?sslmode=模式`，例如 `postgresql://ballet_island:<encoded-password>@db.example.com:5432/ballet_island?sslmode=verify-full`。数据库主机必须从 **API 容器内部**可解析、可访问，不能把容器内的 `127.0.0.1` 当作另一台主机。密码中的 `@`、`:`、`/`、`?`、`#`、`%` 等 URL 特殊字符须按 [PostgreSQL 连接 URI 规则](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING)做百分号编码。`sslmode` 按数据库实际 TLS 配置填写：服务器未启用 TLS 时用 `disable`；有可验证证书时优先用 `verify-full`，使用私有 CA 时还需让 API 容器信任该 CA。跨服务器还需放通应用主机到数据库的连接，并确认数据库允许该用户和来源地址访问。
|
|
4. 确保宿主机 `127.0.0.1:8080` 空闲。HTTPS 反向代理将 API 域名转发到该地址，并在微信小程序后台配置 request 合法域名。生产 Compose 仅将 API 绑定到回环地址，不发布数据库端口。
|
|
5. 首次上线前在统一数据库服务器上创建数据库和账号，确定备份位置及恢复步骤。本地 `compose.yaml` 的 `ballet-island_postgres_data` 卷不会被生产 Compose 使用；若数据仍在该卷中，须先迁移到统一数据库服务器。
|
|
|
|
## 发布流程
|
|
|
|
推送 `main` 中的 `backend/**` 或工作流变更会触发部署，也可在 Gitea Actions 中手动运行。Runner 从 Gitea 检出代码，在目标主机取得部署锁，并确认检出的提交仍是远端 `main` 最新提交。然后校验生产 Compose、以提交短 SHA 构建 API 镜像、更新 `ballet-island` Compose 项目，等待 API 的数据库就绪检查通过，再访问宿主机 `/readyz`。工作流结束时输出该项目的容器状态。
|
|
|
|
生产配置通过 `--env-file /dev/null` 忽略开发 `.env`，数据库连接完全由 Gitea 的 `DATABASE_URL` 指定。后端在未设置 `DATABASE_URL` 时仍使用本地开发的 `PG*` 环境变量。生产 Compose 不创建 PostgreSQL 容器，也不要求与数据库容器共享 Docker 网络；如果数据库仅通过另一 Compose 项目的内部服务名开放，须先提供 API 容器可达的网络和地址。工作流未使用 `--remove-orphans`，切换前若已有同名项目中的旧 PostgreSQL 容器，不会自动停止或清理它。
|
|
|
|
API 启动时会在事务和数据库锁保护下应用尚未执行的版本迁移，当前没有独立迁移命令。发布前应在统一数据库服务器上备份，未来涉及不兼容 schema 的改动须先制定迁移与回退顺序。工作流不会自动回滚数据库；失败后先检查容器状态和日志，再决定恢复备份或重新部署。
|
|
|
|
## 验收与回退
|
|
|
|
发布成功后，从服务器确认 `curl -f http://127.0.0.1:8080/readyz`，并从外部确认 HTTPS 域名的 `/readyz`。真实微信登录、合法域名及小程序构建产物仍需单独验收；`/readyz` 只证明 API 可连接数据库。
|
|
|
|
每个发布镜像保留 `ballet-island-api:<提交短 SHA>` 标签。要回到某个已构建版本，应先确认其镜像仍在目标主机上，并评估数据库迁移是否与旧程序兼容；随后用同一组生产环境变量设置 `IMAGE_TAG=<旧提交短 SHA>`，在 `backend/` 执行：
|
|
|
|
```sh
|
|
docker compose --env-file /dev/null -f compose.prod.yaml up -d --wait --wait-timeout 180 --no-build
|
|
```
|
|
|
|
回退镜像不会回退数据库迁移。修改 Gitea 中 `DATABASE_URL` 的密码也不会修改统一数据库服务器里的账号密码，两处需要按数据库运维流程同步更新。
|