diff --git a/docs/resource/img/svc_spec.png b/docs/resource/img/svc_spec.png new file mode 100644 index 0000000000..a7c9fdd033 Binary files /dev/null and b/docs/resource/img/svc_spec.png differ diff --git a/svc-bkrepo/README.md b/svc-bkrepo/README.md new file mode 100644 index 0000000000..ec6697aa7f --- /dev/null +++ b/svc-bkrepo/README.md @@ -0,0 +1,133 @@ +# svc-bkrepo + +`svc-bkrepo` 是蓝鲸开发者中心的蓝鲸制品库 bkrepo 增强服务模块。 + +## 本地开发指引 + +### 1. 安装 Python 3.11 + +推荐使用 [pyenv](https://github.com/pyenv/pyenv) 管理 Python 环境。 + +- 安装 pyenv,请参考 [相关指引](https://github.com/pyenv/pyenv#getting-pyenv)。 +- 使用 pyenv 安装 Python 3.11: + +```shell +❯ pyenv install 3.11.10 +``` + +### 2. 安装项目依赖 + +本项目使用 [poetry](https://python-poetry.org/) 管理依赖。 + +- 安装 poetry 并通过它安装依赖: + +```shell +❯ make init-py-dep +``` + +完成依赖安装后,可以使用 poetry 启动项目,常用命令包括: + +- `poetry shell`:进入当前 virtualenv。 +- `poetry run {COMMAND}`:在 virtualenv 中执行命令。 + +### 3. 配置本地环境变量 + +设置环境变量(可以在项目根目录新建 `.envrc` 文件,或在终端中手动执行以下内容): + +```bash +# 与 apiserver 模块通信的密钥 +export PAAS_SERVICE_JWT_CLIENTS_KEY="xxx" + +# 数据库配置 +export MYSQL_NAME="svc_bkrepo" +export MYSQL_USER="root" +export MYSQL_PASSWORD="" +export MYSQL_HOST="" +export MYSQL_PORT="3306" + +# 数据库加密密钥,设置后不能变更,否则已加密的 DB 数据将无法解密 +# tr -dc A-Za-z0-9