Python 脚本批量管理 PHP 部署：fabric 实战

引子

在管理多个 PHP 服务器时，重复的手动部署和服务器管理任务不仅耗时，还容易出错。我手上的几台服务器，每天都需要进行代码更新、服务重启和日志检查。为了提高效率，我决定使用 Python 的 Fabric 库来自动化这些任务。本文将详细介绍如何使用 Fabric 批量管理 PHP 部署，并提供可运行的代码示例。

Fabric 简介

Fabric 是一个用于简化 SSH 操作的 Python 库。它允许你通过编写 Python 脚本来执行远程服务器上的命令，从而实现自动化部署和管理。以下是 Fabric 的几个关键特性：

• 支持并行执行任务
• 提供简单的 API 来运行命令和上传文件
• 支持任务之间的依赖关系

安装 Fabric

首先，确保你已经安装了 Python 和 pip。然后使用 pip 安装 Fabric：

pip install fabric

编写 Fabric 脚本

下面是一个用于部署 PHP 项目的 Fabric 脚本示例。这个脚本将执行以下任务：

1. 连接到远程服务器
2. 拉取最新的代码
3. 安装依赖
4. 重启 PHP-FPM 和 Nginx 服务

from fabric import task
from invoke import run

@task
def deploy(c):
    # 切换到项目目录
    c.run('cd /var/www/my-php-project', warn=True)
    
    # 拉取最新的代码
    c.run('git pull origin master')
    
    # 安装 PHP 依赖
    c.run('composer install --no-interaction --no-dev')
    
    # 重启 PHP-FPM
    c.run('sudo systemctl restart php7.4-fpm')
    
    # 重启 Nginx
    c.run('sudo systemctl restart nginx')
    
    # 输出部署完成的信息
    print("Deployment completed successfully.")

解释代码

在上面的脚本中，我们定义了一个名为 deploy 的任务。这个任务执行以下操作：

• c.run('cd /var/www/my-php-project', warn=True): 切换到项目目录。如果目录不存在，不会报错。
• c.run('git pull origin master'): 拉取最新的代码。
• c.run('composer install --no-interaction --no-dev'): 安装 PHP 依赖。
• c.run('sudo systemctl restart php7.4-fpm'): 重启 PHP-FPM 服务。
• c.run('sudo systemctl restart nginx'): 重启 Nginx 服务。
• print("Deployment completed successfully."): 输出部署完成的信息。

执行部署任务

要执行这个部署任务，需要在终端中运行以下命令：

fab -H user@remote-server deploy

其中，-H user@remote-server 指定了远程服务器的连接信息。你也可以在 Fabric 脚本中配置主机列表，以支持多台服务器的同时部署。

管理多台服务器

为了管理多台服务器，可以在 Fabric 脚本中定义一个主机列表。以下是一个示例：

from fabric import task

@task
def deploy(c):
    # 定义主机列表
    env.hosts = ['server1.example.com', 'server2.example.com', 'server3.example.com']
    
    # 切换到项目目录
    c.run('cd /var/www/my-php-project', warn=True)
    
    # 拉取最新的代码
    c.run('git pull origin master')
    
    # 安装 PHP 依赖
    c.run('composer install --no-interaction --no-dev')
    
    # 重启 PHP-FPM
    c.run('sudo systemctl restart php7.4-fpm')
    
    # 重启 Nginx
    c.run('sudo systemctl restart nginx')
    
    # 输出部署完成的信息
    print("Deployment completed successfully on all servers.")

执行这个任务时，Fabric 会并行连接到所有列出的服务器并执行部署任务。

根因 & 解决

在实施 Fabric 部署脚本的过程中，我遇到了一些常见问题：

1. 权限问题: 有时，SSH 用户没有足够的权限执行某些命令。通过使用 sudo 并配置适当的权限，解决了这个问题。
2. 网络连接问题: 网络不稳定可能导致部署中断。使用 Fabric 的重试机制和错误处理，确保部署过程的可靠性。
3. 依赖安装失败: 有时，Composer 依赖安装失败。通过在脚本中添加错误处理和日志记录，及时发现和解决问题。

以下是添加错误处理的示例代码：

from fabric import task
from invoke import run

@task
def deploy(c):
    try:
        # 切换到项目目录
        c.run('cd /var/www/my-php-project', warn=True)
        
        # 拉取最新的代码
        c.run('git pull origin master')
        
        # 安装 PHP 依赖
        c.run('composer install --no-interaction --no-dev')
        
        # 重启 PHP-FPM
        c.run('sudo systemctl restart php7.4-fpm')
        
        # 重启 Nginx
        c.run('sudo systemctl restart nginx')
        
        print("Deployment completed successfully.")
    except Exception as e:
        print(f"Deployment failed: {e}")

小结

使用 Python 的 Fabric 库可以显著简化 PHP 部署过程。通过编写自动化脚本，你可以减少人为错误，提高部署效率。本文提供的示例脚本和步骤，可以作为你开始使用 Fabric 的参考。

踩坑清单

• 确保 SSH 用户有足够的权限执行所需命令。
• 处理网络连接问题，使用重试机制和错误处理。
• 在依赖安装失败时，添加日志记录和错误处理。
• 测试脚本在多台服务器上的执行情况，确保并行执行的稳定性。
• 定期更新 Fabric 和相关依赖，保持脚本的安全性和功能性。