在Supervisor中管理Git多分支部署的策略

理解Supervisor与Git的交互

supervisor是一个进程控制系统，其主要职责是监控和管理后台进程。它对版本控制系统（如git）一无所知，也无需了解。当supervisor启动一个程序时，它只是执行指定路径下的可执行文件或脚本。这意味着，对于supervisor而言，directory=/home/ubuntu/a 指向的是文件系统上的一个具体位置，其中包含的代码就是当前在该位置检出的git分支版本。

由于在同一个文件系统路径下，不可能同时检出两个不同的Git分支（例如，master 分支和 branch_1 分支的代码不能同时存在于 /home/ubuntu/a 目录中），因此Supervisor无法直接通过配置项来“切换”或“指定”Git分支。要运行不同分支的代码，必须在文件系统上为每个分支提供一个独立的、包含其代码的目录。

解决方案：多目录多分支部署

解决在Supervisor中管理不同Git分支的关键在于为每个分支创建独立的部署目录。这样，每个目录都将包含一个特定Git分支的完整代码副本，Supervisor可以分别管理这些独立的代码实例。

核心思想：

1. 为每个需要运行的Git分支创建一个独立的目录。
2. 将相应的Git分支代码检出到各自的目录中。
3. 在Supervisor配置文件中，为每个分支的代码实例配置一个独立的[program:...]条目，并指定其对应的directory。

实施步骤与示例

以下是实现多分支部署的具体步骤和Supervisor配置示例。

1. 准备项目目录

首先，在服务器上为每个Git分支创建独立的部署目录。例如，如果需要运行master分支和branch_1分支：

# 为master分支创建目录
mkdir -p /home/ubuntu/project_master
# 为branch_1分支创建目录
mkdir -p /home/ubuntu/project_branch_1

2. 克隆与切换分支

将代码仓库克隆到这些新创建的目录中，并切换到相应的分支。

喵记多

喵记多 - 自带助理的 AI 笔记

27

查看详情

# 克隆仓库到master分支目录并切换到master
git clone your_repo_url /home/ubuntu/project_master
cd /home/ubuntu/project_master
git checkout master
# 假设需要安装依赖
/home/ubuntu/project_master-venv/bin/pip install -r requirements.txt

# 克隆仓库到branch_1分支目录并切换到branch_1
git clone your_repo_url /home/ubuntu/project_branch_1
cd /home/ubuntu/project_branch_1
git checkout branch_1
# 假设需要安装依赖
/home/ubuntu/project_branch_1-venv/bin/pip install -r requirements.txt

注意： 建议为每个部署目录创建独立的Python虚拟环境（如 /home/ubuntu/project_master-venv 和 /home/ubuntu/project_branch_1-venv），以避免不同分支之间依赖库版本的冲突。

3. 配置Supervisor

现在，可以配置Supervisor来分别管理这两个分支的应用程序。在Supervisor的配置文件（通常是 /etc/supervisor/conf.d/your_app.conf 或类似路径）中添加两个独立的[program:...]块。

[program:my-app-master]
# command 指定要运行的程序，注意使用对应虚拟环境的解释器
command=/home/ubuntu/project_master-venv/bin/uvicorn a.path.main:app --host=0.0.0.0 --port 9009 --loop uvloop --log-level info
# directory 指向master分支的代码目录
directory=/home/ubuntu/project_master
user=ubuntu
autostart=true
autorestart=true
# 为master分支配置独立的日志文件
stdout_logfile=/var/log/supervisor/my-app-master.log
stderr_logfile=/var/log/supervisor/my-app-master-error.log
stopwaitsecs=10

[program:my-app-branch-1]
# command 指定要运行的程序，注意使用对应虚拟环境的解释器
# ！！！重要：如果两个分支运行的是同一个服务，必须使用不同的端口以避免冲突！！！
command=/home/ubuntu/project_branch_1-venv/bin/uvicorn a.path.main:app --host=0.0.0.0 --port 9010 --loop uvloop --log-level info
# directory 指向branch_1分支的代码目录
directory=/home/ubuntu/project_branch_1
user=ubuntu
autostart=true
autorestart=true
# 为branch_1分支配置独立的日志文件
stdout_logfile=/var/log/supervisor/my-app-branch-1.log
stderr_logfile=/var/log/supervisor/my-app-branch-1-error.log
stopwaitsecs=10

配置说明：

• [program:my-app-master] 和 [program:my-app-branch-1]: 定义了两个独立的程序实例。
• command: 指定了每个程序启动时执行的命令。请注意，如果两个程序是同一个Web服务，它们必须监听不同的端口（例如，9009 和 9010），否则会发生端口冲突。同时，确保command中使用的Python解释器或虚拟环境路径指向对应分支的独立环境。
• directory: 这是关键，它明确指定了Supervisor启动程序时的工作目录，即对应Git分支的代码所在目录。
• stdout_logfile / stderr_logfile: 为每个程序配置独立的日志文件，便于问题排查和监控。

4. 更新Supervisor配置

保存配置文件后，通知Supervisor重新加载配置并启动新定义的程序：

sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl status

注意事项与最佳实践

1. 端口冲突： 如果不同分支运行的是提供相同服务的应用程序（如Web服务），它们必须监听不同的端口。
2. 资源消耗： 同时运行多个分支实例会增加服务器的CPU、内存和网络资源消耗。请根据服务器的实际承载能力进行规划。
3. 日志管理： 为每个分支实例配置独立的日志文件至关重要，这有助于区分和调试不同版本的应用程序。
4. 虚拟环境： 强烈建议为每个分支的部署目录创建并使用独立的Python虚拟环境（或其他语言的依赖管理），以隔离不同分支可能存在的依赖库版本差异。
5. 部署流程： 每次代码更新时，需要进入对应的分支目录，执行git pull，安装新的依赖（如果requirements.txt有变化），然后通过sudo supervisorctl restart my-app-master（或 my-app-branch-1）重启相应的Supervisor程序。
6. 自动化： 对于复杂的部署场景，可以考虑编写自动化部署脚本或集成到CI/CD流程中，以简化多分支的管理和更新。
7. 配置管理： 如果不同分支需要不同的环境变量或配置文件，确保在各自的部署目录中正确设置。例如，可以使用.env文件或独立的配置文件来管理。

总结

Supervisor作为一个强大的进程管理工具，其设计理念是专注于文件系统层面的进程控制。它不直接与Git分支概念交互，但通过将不同Git分支的代码检出到独立的物理目录，并为每个目录配置独立的Supervisor程序条目，我们能够有效地在同一台服务器上管理和运行项目的多个分支版本。这种方法虽然需要更多的目录和配置，但提供了清晰、隔离且可控的多分支部署方案。

以上就是在Supervisor中管理Git多分支部署的策略的详细内容，更多请关注php中文网其它相关文章！