This commit is contained in:
vipg
2025-10-09 16:48:03 +08:00
parent 7e9930ae6b
commit ca33c8d5a3

View File

@@ -2,7 +2,7 @@
## 一、概述
本文档介绍用户服务系统的创建、构建和部署流程,涉及`create_api.py``build.py``deploy/deploy.sh`个核心脚本的使用方法帮助使用者快速搭建和部署用户服务相关的API模块。
本文档介绍用户服务系统的创建、构建和部署流程,涉及`create_api.py``deploy/deploy.sh`个核心脚本的使用方法帮助使用者快速搭建和部署用户服务相关的API模块。
## 二、环境准备
@@ -40,40 +40,14 @@
- 生成对应的`docker-compose.{a}.{b}.yaml`或`docker-compose.{a}.yaml`文件
- 自动修改`release.sh`、`init.py`和`README.md`中的服务标识
### 2. 构建API服务镜像build.py
用于批量构建所有API服务的Docker镜像并将构建结果整理到指定目录。
#### 使用方法:
```bash
python3 build.py
```
#### 功能说明:
1. 遍历所有以`api_`开头的目录(排除`api_template`
2. 执行每个目录下的`release.sh`脚本:
- 为脚本添加执行权限
- 运行脚本删除旧镜像并构建新镜像
3. 收集构建生成的`.tar`镜像文件:
- 复制到`deploy/images`目录
- 自动处理文件权限问题
- 清理原始目录中的`.tar`文件
#### 注意事项:
- 若遇到权限问题,可尝试使用`sudo`运行:
```bash
sudo python3 build.py
```
- 脚本会自动跳过不存在`release.sh`的目录
### 3. 部署服务deploy/deploy.sh
### 2. 部署服务deploy/deploy.sh
用于停止现有服务、构建API并启动新的Docker Compose编排。
#### 使用方法:
```bash
cd deploy
./deploy.sh
sudo sh deploy.sh
```
#### 功能说明:
@@ -102,7 +76,7 @@ API_DIR="./api" # API服务所在目录
1. **创建新API服务**
```bash
# 编辑create_api.py设置功能名
python3 create_api.py
sudo python3 create_api.py
```
2. **开发API功能**