本文旨在讲解如何利用 Supervisor 管理部署在不同 git 分支上的应用程序。Supervisor 本身不直接感知 Git 分支,但通过在不同目录下检出不同分支的代码,并配置 Supervisor 针对不同目录下的应用程序进行管理,可以实现灵活的部署方案。这种方法允许你在同一服务器上运行不同版本的应用程序,便于测试、灰度发布或维护多个稳定版本。
Supervisor 与 Git 分支管理
Supervisor 是一个进程管理工具,它负责监控和管理 linux 系统中的进程。它并不知道 Git 的存在,也不关心你的代码是如何管理的。Supervisor 仅仅是执行文件系统中的可执行文件。因此,要使用 Supervisor 管理不同 Git 分支的应用,核心思路是将不同分支的代码检出到不同的目录,然后配置 Supervisor 针对这些目录下的应用进行管理。
实现步骤
-
创建不同的目录:
为每个需要运行的 Git 分支创建一个独立的目录。例如,你可以创建 app_master 和 app_branch_1 两个目录,分别用于存放 master 分支和 branch_1 分支的代码。
mkdir /home/ubuntu/app_master mkdir /home/ubuntu/app_branch_1
-
检出不同的 Git 分支:
使用 git clone 命令将代码仓库克隆到每个目录中,并切换到相应的分支。
cd /home/ubuntu/app_master git clone <your_git_repository_url> . git checkout master cd /home/ubuntu/app_branch_1 git clone <your_git_repository_url> . git checkout branch_1
-
配置 Supervisor:
修改 Supervisor 的配置文件,为每个分支的应用创建一个独立的程序配置。 关键在于 Directory 选项,它指定了 Supervisor 运行应用的目录。
[program:app_master] command=/home/ubuntu/app_master/a-venv/bin/uvicorn a.path.main:app --host=0.0.0.0 --port 9009 --loop uvloop --log-level info directory=/home/ubuntu/app_master user=ubuntu autostart=true autorestart=true [program:app_branch_1] command=/home/ubuntu/app_branch_1/a-venv/bin/uvicorn a.path.main:app --host=0.0.0.0 --port 9009 --loop uvloop --log-level info directory=/home/ubuntu/app_branch_1 user=ubuntu autostart=true autorestart=true
注意: 确保 command 选项中指定的可执行文件路径与对应的分支目录一致。 另外,确保虚拟环境的路径也是正确的,每个分支都应该有独立的虚拟环境。
-
更新 Supervisor 配置:
使用 supervisorctl 命令更新 Supervisor 的配置,并启动相应的程序。
sudo supervisorctl reread sudo supervisorctl update sudo supervisorctl start app_master sudo supervisorctl start app_branch_1
示例
假设你的 Git 仓库地址为 git@github.com:your_username/your_repo.git,你的应用入口文件为 a/path/main.py,并且你已经创建了虚拟环境。以下是一个完整的示例:
-
创建目录并检出代码:
mkdir /home/ubuntu/app_master cd /home/ubuntu/app_master git clone git@github.com:your_username/your_repo.git . git checkout master python3 -m venv a-venv source a-venv/bin/activate pip install -r requirements.txt # 如果有 requirements.txt 文件 mkdir /home/ubuntu/app_branch_1 cd /home/ubuntu/app_branch_1 git clone git@github.com:your_username/your_repo.git . git checkout branch_1 python3 -m venv a-venv source a-venv/bin/activate pip install -r requirements.txt # 如果有 requirements.txt 文件
-
配置 Supervisor:
将以下内容添加到 /etc/supervisor/conf.d/your_app.conf 文件中:
[program:app_master] command=/home/ubuntu/app_master/a-venv/bin/uvicorn a.path.main:app --host=0.0.0.0 --port 9009 --loop uvloop --log-level info directory=/home/ubuntu/app_master user=ubuntu autostart=true autorestart=true environment=PATH="/home/ubuntu/app_master/a-venv/bin:%(ENV_PATH)s" [program:app_branch_1] command=/home/ubuntu/app_branch_1/a-venv/bin/uvicorn a.path.main:app --host=0.0.0.0 --port 9009 --loop uvloop --log-level info directory=/home/ubuntu/app_branch_1 user=ubuntu autostart=true autorestart=true environment=PATH="/home/ubuntu/app_branch_1/a-venv/bin:%(ENV_PATH)s"
注意: environment 选项用于确保 Supervisor 运行的应用能够找到虚拟环境中的可执行文件。
-
更新并启动 Supervisor:
sudo supervisorctl reread sudo supervisorctl update sudo supervisorctl start app_master sudo supervisorctl start app_branch_1
注意事项
- 虚拟环境: 强烈建议为每个分支创建独立的虚拟环境,以避免依赖冲突。
- 目录结构: 确保每个分支的代码都位于独立的目录中,并且 directory 选项指向正确的目录。
- 配置文件: Supervisor 的配置文件应该清晰易懂,方便维护。
- 部署脚本: 可以编写脚本自动化代码检出、虚拟环境创建和 Supervisor 配置更新等步骤,简化部署流程。
- 端口冲突: 如果两个应用使用相同的端口,需要修改其中一个应用的端口配置,避免端口冲突。
- 资源占用: 同时运行多个分支的应用会消耗更多的系统资源,需要根据服务器的配置进行调整。
总结
通过在不同的目录下检出不同的 Git 分支,并配置 Supervisor 针对这些目录下的应用进行管理,可以实现灵活的部署方案。 这种方法允许你在同一服务器上运行不同版本的应用程序,便于测试、灰度发布或维护多个稳定版本。 在实际应用中,应该结合具体的项目需求和服务器配置,选择合适的部署方案。 记住,Supervisor 只是一个进程管理工具,它并不直接感知 Git 的存在,关键在于如何组织文件系统,并正确配置 Supervisor。