Jenkins SSH 插件：安装与使用指南

霍格沃兹_测试

2024-05-29 179 阅读3分钟

Jenkins SSH 插件（SSH Plugin）允许 Jenkins 通过 SSH 执行远程命令或传输文件，这对于在多个服务器之间进行任务协调、部署和维护工作非常有用。本文将介绍如何安装和使用 Jenkins SSH 插件，实现远程服务器上的自动化操作。

一、安装 Jenkins SSH 插件

进入 Jenkins 插件管理页面

登录 Jenkins 管理控制台。
点击“Manage Jenkins”。
选择“Manage Plugins”。
安装 SSH 插件
在“Available”标签下搜索“SSH Plugin”。
勾选“SSH Plugin”并点击“Install without restart”进行安装。
安装完成后，可以选择立即重启 Jenkins 使插件生效，或稍后重启。

二、配置 SSH 服务器

添加 SSH 服务器

进入“Manage Jenkins” -> “Configure System”。
找到“SSH remote hosts”部分，点击“Add”按钮添加一个新的 SSH 服务器。
配置 SSH 服务器的详细信息：
- Name：为 SSH 服务器起一个名字，方便识别。
- Hostname：SSH 服务器的主机名或 IP 地址。
- Port：SSH 服务器的端口号，默认是 22。
- Credentials：选择或添加 SSH 凭据（包括用户名和密码或私钥）。可以使用“Add”按钮添加新的凭据。
测试连接
在配置完成后，可以点击“Test Configuration”按钮测试连接，确保 Jenkins 能够通过 SSH 连接到远程服务器。

三、在 Jenkins Job 中使用 SSH 插件

创建或配置 Jenkins Job

进入需要使用 SSH 插件的 Jenkins Job。
点击“Configure”进入 Job 的配置页面。
添加构建步骤
在“Build”部分，点击“Add build step”按钮。
选择“Send files or execute commands over SSH”。
配置 SSH 操作
Name：选择之前配置的 SSH 服务器。
Transfers：配置文件传输（如果需要）：
- Source files：要传输的文件路径。
- Remote directory：远程服务器上的目标目录。
- Remove prefix：传输时移除文件路径前缀。
- Flatten files：将所有文件传输到一个目录中。
Exec command：在远程服务器上执行的命令。例如：

cd /path/to/your/project
./deploy.sh

Advanced：其他高级选项，如命令执行后是否继续构建、环境变量等。

保存并运行 Job

配置完成后，点击“Save”保存配置。
点击“Build Now”手动触发构建，或等待触发器自动执行。
查看控制台输出，确认 SSH 操作执行情况。

四、示例：在远程服务器上部署应用

假设我们有一个简单的应用部署脚本deploy.sh，需要在远程服务器上执行。以下是具体步骤：

准备部署脚本
在项目的根目录创建一个deploy.sh脚本，例如：

#!/bin/bash
echo "Starting deployment..."
cd /path/to/application
git pull origin main
docker-compose down
docker-compose up -d
echo "Deployment finished!"

2.配置 SSH 插件

按照前文步骤，在 Jenkins 中添加远程服务器并测试连接。
在 Jenkins Job 中添加“Send files or execute commands over SSH”构建步骤。
配置文件传输：
- Source files：deploy.sh
- Remote directory：/remote/path/to/scripts
配置执行命令：

chmod +x /remote/path/to/scripts/deploy.sh
/remote/path/to/scripts/deploy.sh

3.触发构建

- 保存配置并手动触发构建，或者设置触发器自动执行。
- 查看 Jenkins 控制台输出，确认部署脚本执行情况。

通过以上步骤，你可以使用 Jenkins SSH 插件在远程服务器上执行命令或传输文件，实现自动化部署和维护任务。这不仅简化了多服务器操作的复杂性，还提高了工作效率和准确性。