10、【Jenkins】【Jenkins 使用】Jenkins

1、概述

• Jenkins 可以对远程的软件项目实现集成、部署等。

• Jenkins 的远程的方式有多种，基于现有知识个人总结出两种，一种是简易方式，一种是节点方式。

• 所谓简易方式，就是不创建节点，基于 Jenkins 自身的 master 节点来进行一些远程操作。

• 所谓节点方式，就需要先创建节点，然后使用创建出的专门针对某一服务器主机的节点实现远程操作。

2、简易方式

• 在简易方式中，为实现一些远程操作（比如通过 Shell 命令完成远程部署等），需要进行一些准备工作，比如“基于密钥对的免密建立连接”。

• 1、在 Jenkins 中安装 Publish Over SSH 这个插件并重启使之生效。

• 2、在部署了 Jenkins 的主机中生成密钥对，然后按照【Linux 网络】【SSH】密钥对验证文中的方式，先实现已部署了 Jenkins 的主机与远程主机之间的成功建立免密 SSH 连接。

• 3、点击 Jenkins 主页（首页）左侧的“系统管理”，再点击“系统配置”，进入“系统配置”页面，找到“Publish over SSH”部分：

系统配置 Publish over SSH

• 4、填写“Publish over SSH”这部分内容。
  Passphrase指在 Jenkins 主机使用ssh-keygen命令生成密钥对那个时候提示Enter passphrase (empty for no passphrase):输入的那个，如果当时没有的话，就不用填。

Path to key和Key，两者选一。
Path to key是 Jenkins 所在主机中私钥的路径。
Key是私钥内容，如果Path to key和Key均填写，则以Key为准，会忽略掉Path to key的配置。

Jenkins 主机上生成密钥对中的私钥 id_rsa 拷贝私钥的内容至 Key

• 5、增加“SSH Server”，即配置需要通过 SSH 建立连接的远程主机信息（可以配置多个远程主机）：

新增 SSH Server 配置一个 SSH Server 信息

Name：名称（自定义）
Hostname：远程主机 IP 地址
Username：登录远程主机所使用的用户名
Remote Directory：进行文件传输时使用的位于远程服务器的目录，如果需要向远程进行文件传输，则传输的“目的地”就是这里所配置的。

• 6、点击“TEST CONFIGURATION”，测试配置是否成功。如果成功的话，会显示“Success”：

测试配置是否成功

• 7、点击“保存”或“应用”。

• 8、创建一个 Item，进入 Item 的配置页面，“构建”中的“Send files or execute commands over SSH”和“构建后操作”中的“Send build artifacts over SSH”，这两个选项须建立在“Publish Over SSH”插件和刚才所进行的配置基础之上才能是可行的：

“构建”中的“Send files or execute commands over SSH” “构建后操作”中的“Send build artifacts over SSH”

• 9、举个例子，“构建”中的“Send files or execute commands over SSH”：

配置“Send files or execute commands over SSH”

Transfer Set（可以理解成 Send files or execute commands over SSH 构建策略面向一个 SSH Server 的一个策略单元） 的配置项（“构建后操作”中的“Send build artifacts over SSH”也是这样的配置模式）：

Source files（Source files和Exec command至少填其一）：从本地（即本例中部署 Jenkins 的主机）需要传送至 SSH Server 的文件或目录的路径。

注意：

1、这个路径是相对于“工作空间”的路径。
“工作空间”是指$Jenkins_Home_Path/workspace/$Item_Name：
Jenkins_Home_Path是之前提到过的“Jenkins 的安装路径”，例如默认是/root/.jenkins；
Item_Name就是工程、项目名，例如Test-1。

2、路径中允许使用适配符以实现多个文件传输，但是须符合 Apache Ant 中的标准。

3、如果是多个文件路径，允许使用,分隔。

个人目前经验：将需要传输的文件先转移至工作空间目录下，然后直接填写文件名称即可（这个Source files配置项的要求目前本人也就只能理解到这个程度）；另外，如果需要传输整个目录，目录必须以/结尾。

Remove prefix（非必填）：移除目录。
举个例子，假设要将工作空间下一个文件1.sh上传，但是这个文件的具体路径是Workspace_Path/1st/2nd/3rd/1.sh，所以Source files配置项填写1st/2nd/3rd/1.sh。但上传后发现，并不是只上传了1.sh这一个文件，还将整个上层目录1st/2nd/3rd/都传了过去。但如果不希望将这个目录上传，就只传这个1.sh的文件，那就可以配置Remove prefix为1st/2nd/3rd/，实际上传的时候就只会上传1.sh这个文件。

Remote directory（非必填）：远程目录。文件上传至远程什么的位置。

注意：

1、This folder will be below the one in the global configuration if present.（这个远程目录需建立在之前配置的全局的Remote directory之下，全局配置指的就是 Jenkins 主页（首页）左侧的“系统管理” -> “系统配置” -> Publish Over SSH插件配置中的Remote Directory）

2、The folder will be created if does not exist

Exec command（Source files和Exec command至少填其一）：在远程执行的命令。

1、This command will be executed on the remote server after any files are transferred.

2、The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed.
If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.

3、此处填写的时候，是需要按照 Shell 脚本的形式编写。比如#!/bin/bash开头等。

---

将本地的/root/.jenkins/workspace/Test-1/1st/2nd/3rd/1.sh上传至/root/jenkins_over_ssh_1目录下，只上传1.sh；上传后给远程的1.sh增加x权限。

全局配置回顾：

Jenkins 主目录（安装目录） Jenkins Publish Over SSH 插件配置（全局配置）

项目（任务）构建策略配置：

配置构建策略 Send files or execute commands over SSH

保存后，立即构建，构建成功后到远程主机（SSH Server）中验证：

构建成功 验证