ci(deploy): support pulling published docker images
This commit is contained in:
@@ -1,6 +1,8 @@
|
||||
# 自动构建与自动重启流程
|
||||
|
||||
本文档说明当前项目通过 Git remote + `post-receive` hook 实现自动构建、自动重启的流程。当前服务器端运行方式已经容器化，核心文件为 [.githooks/post-receive](../.githooks/post-receive)、[Dockerfile](../Dockerfile) 和 [docker-compose.yml](../docker-compose.yml)。
|
||||
本文档说明当前项目通过 Git remote + `post-receive` hook 实现自动部署、自动重启的流程。当前服务器端运行方式已经容器化，核心文件为 [.githooks/post-receive](../.githooks/post-receive)、[Dockerfile](../Dockerfile) 和 [docker-compose.yml](../docker-compose.yml)。
|
||||
|
||||
服务器默认仍会本地构建 Docker 镜像；如果服务器工作树中存在 `.deploy.env` 且配置 `COZSWEET_DEPLOY_IMAGE_SOURCE=pull`，则会改为从镜像仓库拉取由 Gitea Actions 构建好的镜像。
|
||||
|
||||
## 部署入口
|
||||
|
||||
@@ -73,9 +75,10 @@ production root@43.106.13.130:/root/cozsweet-repos/main
|
||||
5. 根据当前分支复制环境变量文件。
|
||||
6. 根据当前分支选择 Next.js 启动端口。
|
||||
7. 根据分支导出 Docker Compose 所需变量，包括镜像名、容器名、env 文件和端口。
|
||||
8. 执行 `docker compose build web` 构建环境专属镜像。
|
||||
9. 如果镜像构建失败，写入失败日志并中止，旧容器继续运行。
|
||||
10. 如果镜像构建成功，执行 `docker compose up -d --remove-orphans web` 重建并启动容器。
|
||||
8. 如果使用默认 `build` 模式，执行 `docker compose build web` 构建环境专属镜像。
|
||||
9. 如果使用 `pull` 模式，执行 `docker compose pull web` 拉取 CI 已发布镜像。
|
||||
10. 如果镜像构建或拉取失败，写入失败日志并中止，旧容器继续运行。
|
||||
11. 如果镜像准备成功，执行 `docker compose up -d --remove-orphans web` 重建并启动容器。
|
||||
|
||||
## 分支、环境变量、端口映射
|
||||
|
||||
@@ -88,6 +91,28 @@ production root@43.106.13.130:/root/cozsweet-repos/main
|
||||
| `dev` | `env-example/.env.development.example` → `.env.local` | `9135` | `cozsweet-web-dev` | `cozsweet-web:dev-<commit>` |
|
||||
| 其他分支 | 使用默认 `.env.local` | `9135` | `cozsweet-web-<branch>` | `cozsweet-web:<branch>-<commit>` |
|
||||
|
||||
如果 `.deploy.env` 配置为 pull 模式，镜像标签会从本地标签切换为远程仓库标签：
|
||||
|
||||
```env
|
||||
COZSWEET_DEPLOY_IMAGE_SOURCE=pull
|
||||
COZSWEET_REGISTRY_IMAGE=registry.example.com/cozsweet/cozsweet-web
|
||||
```
|
||||
|
||||
默认远程镜像 tag 为 `<deploy_env>-<short_sha>`：
|
||||
|
||||
```text
|
||||
registry.example.com/cozsweet/cozsweet-web:test-<commit>
|
||||
registry.example.com/cozsweet/cozsweet-web:prod-<commit>
|
||||
```
|
||||
|
||||
也可以在服务器本地 `.deploy.env` 中覆盖为 latest tag：
|
||||
|
||||
```env
|
||||
COZSWEET_REMOTE_IMAGE_TAG=prod-latest
|
||||
```
|
||||
|
||||
推荐生产发布使用默认精确 tag，避免 `latest` 因缓存或并发发布导致版本不可追踪。
|
||||
|
||||
本地生产发布脚本和服务器端 `post-receive` 已统一使用 `.env.production`。Next.js 在生产构建时会读取 `.env.production`；测试和开发发布仍使用 `.env.local`。
|
||||
|
||||
本地部署脚本清除 Cloudflare CDN 缓存时，也会按当前分支读取 env：`main` 优先读取 `.env.production`，其他分支优先读取 `.env.local`。如果优先文件不存在或缺少 `CF_ZONE_ID` / `CF_API_TOKEN`，会尝试读取另一个文件作为兜底。
|
||||
@@ -127,6 +152,34 @@ cd /root/cozsweet-repos/main
|
||||
|
||||
后续生产发布会自动使用新的容器化 hook。
|
||||
|
||||
## 镜像来源
|
||||
|
||||
### 默认：服务器本机构建
|
||||
|
||||
未配置 `.deploy.env` 时，`post-receive` 使用原有模式：
|
||||
|
||||
```bash
|
||||
docker compose build web
|
||||
docker compose up -d --remove-orphans web
|
||||
```
|
||||
|
||||
### 推荐：CI 构建，服务器拉取
|
||||
|
||||
Gitea Actions 通过 [.gitea/workflows/docker-image.yml](../.gitea/workflows/docker-image.yml) 构建并推送镜像。服务器只负责拉取镜像：
|
||||
|
||||
```bash
|
||||
docker compose pull web
|
||||
docker compose up -d --remove-orphans --no-build web
|
||||
```
|
||||
|
||||
服务器需要提前执行一次 registry 登录：
|
||||
|
||||
```bash
|
||||
docker login REGISTRY_HOST
|
||||
```
|
||||
|
||||
服务器本地 `.deploy.env` 不提交到仓库，示例见 [env-example/.deploy.env.example](../env-example/.deploy.env.example)。
|
||||
|
||||
## 容器构建机制
|
||||
|
||||
Docker 构建使用 Next.js standalone 输出：
|
||||
@@ -145,14 +198,20 @@ Docker 构建使用 Next.js standalone 输出：
|
||||
|
||||
重启由 Docker Compose 实现：
|
||||
|
||||
1. `post-receive` 先执行 `docker compose build web`。
|
||||
2. 构建失败时直接中止，旧容器继续运行。
|
||||
3. 构建成功后执行：
|
||||
1. `post-receive` 先准备镜像：默认执行 `docker compose build web`，pull 模式执行 `docker compose pull web`。
|
||||
2. 镜像准备失败时直接中止，旧容器继续运行。
|
||||
3. 镜像准备成功后执行：
|
||||
|
||||
```bash
|
||||
docker compose up -d --remove-orphans web
|
||||
```
|
||||
|
||||
pull 模式下会额外加上 `--no-build`，确保服务器不会意外本地构建：
|
||||
|
||||
```bash
|
||||
docker compose up -d --remove-orphans --no-build web
|
||||
```
|
||||
|
||||
4. Compose 会使用新镜像重建服务容器。
|
||||
5. 容器配置了 `restart: unless-stopped`，容器异常退出后由 Docker 自动拉起。
|
||||
6. 容器内固定监听 `3000`，宿主机端口按分支映射为 `9135` 或 `9185`。
|
||||
@@ -190,13 +249,20 @@ git branch --show-current
|
||||
git rev-parse --short HEAD
|
||||
```
|
||||
|
||||
镜像构建失败时，日志中会出现：
|
||||
镜像构建或拉取失败时，日志中会出现：
|
||||
|
||||
```text
|
||||
docker build EXIT_CODE=<非 0>
|
||||
ABORTED ... (docker build failed, old container kept running)
|
||||
```
|
||||
|
||||
或：
|
||||
|
||||
```text
|
||||
docker pull EXIT_CODE=<非 0>
|
||||
ABORTED ... (docker pull failed, old container kept running)
|
||||
```
|
||||
|
||||
这种情况下不会停止旧容器，也不会启动新容器。
|
||||
|
||||
容器启动失败时，日志中会出现：
|
||||
|
||||
@@ -79,3 +79,39 @@ docker image ls | grep cozsweet-web
|
||||
```
|
||||
|
||||
如果使用 Gitea 自带 Container Registry，需要确认 Gitea 服务已开启 packages / container registry，并且 `REGISTRY_HOST` 与 Docker 登录地址一致。
|
||||
|
||||
## 部署服务器拉取镜像
|
||||
|
||||
部署服务器需要先登录镜像仓库：
|
||||
|
||||
```bash
|
||||
docker login REGISTRY_HOST
|
||||
```
|
||||
|
||||
然后在部署服务器工作树中创建 `.deploy.env`：
|
||||
|
||||
```bash
|
||||
cp env-example/.deploy.env.example .deploy.env
|
||||
```
|
||||
|
||||
配置示例：
|
||||
|
||||
```env
|
||||
COZSWEET_DEPLOY_IMAGE_SOURCE=pull
|
||||
COZSWEET_REGISTRY_IMAGE=registry.example.com/cozsweet/cozsweet-web
|
||||
```
|
||||
|
||||
`post-receive` 会根据当前分支和 commit 自动拉取：
|
||||
|
||||
```bash
|
||||
registry.example.com/cozsweet/cozsweet-web:test-<short_sha>
|
||||
registry.example.com/cozsweet/cozsweet-web:prod-<short_sha>
|
||||
```
|
||||
|
||||
如果需要改用 latest tag，可以在服务器 `.deploy.env` 中显式设置：
|
||||
|
||||
```env
|
||||
COZSWEET_REMOTE_IMAGE_TAG=prod-latest
|
||||
```
|
||||
|
||||
推荐优先使用默认的 `<env>-<short_sha>` 精确 tag，这样发布和回滚都更可控。
|
||||
|
||||
Reference in New Issue
Block a user