Jenkins——应用篇——插件使用——Publish over SSH

本文是jenkins应用系统文章的一部分，大部分来自工作和学习中的实践，部分内容来自官方文档和网友的文章，引用的文章会在“参考资料”部分附上原始链接，如无意中侵犯您的权利，请联系QQ：46106962，如需要进一步的交流请加入QQ群：（Jenkins学习交流）469536515。转载和使用请注明出处。

依赖环境

SSH，远程机开启SSH服务，允许Jenkins所在机器通过SSH服务登录到远程机执行脚本；可以设置SSH使用用户名/密码或通过key登录，SSH配置请查专门的资料这里不做说明
JDK，本文部署的是JAVA应用，远程机上要用jdk环境，如非Java应用请忽略
Tomcat或其他web容器，本文是以Tomcat为例，将应用部署到Tomcat中运行，远程机上安装Tomcat是必须的，如非Java应用请忽略，如用其他web容器请查找容器的安装资料

插件安装

   打开Jenkins的“系统管理>管理插件”，选择“可选插件”，在输入框中输入“Publish over SSH”进行搜索，如果搜索不到可以在“已安装”里确认是否已经安装过。在搜索结果中选中“Publish
over SSH”，点击页面的“直接安装”按钮，系统会自动安装，此插件安装后不需要重启Jenkins。如果插件安装成功在“系统管理>系统设置”会出现相关配置项。

插件配置

全局设置

插件安装成功后使用前需要在“系统管理>系统设置”中进行配置，处如图：



每一项都可以被SSH Server的设置所覆盖，这样的设计有一个好处，在服务器环境比较规范的情况下，可以省去每个SSH Server分别配置的繁琐步骤。

参数说明

Passphrase：SSH的密码
使用用户名/密码登录时为用户名的密码，使用私钥登录时为私钥的密码。

Path to key：SSH私钥的文件路径
私钥文件的路径，可以是绝对路径，也可以是相对$JENKINS_HOME的相对路径

Key：私钥
私钥导出后的文本内容

如果“Key”和“Path to key”都设置，则“Key”的优先级较高，私钥的密码是“Passphrase”中设置的内容。

Disable exec：禁止在目标机上执行命令
勾选后将会忽略在Job配置中“Exec command”选项中设置的命令。Jenkins的说明文档中的“The Disable exec in the advanced settings for individual configurations will be ignored.”没有完全理解，从实际效果来看，只要“Disable exec”被勾选后，不管SSH Server中是否勾选“Disable exec”，Job中设置的命令都将补忽略。

Publisher defaults

SSH Server 配置

SSH Server配置为Publish Over SSH中运程机的配置，分“基本设置”和“高级设置”两部分；“基本设置”主要是运程机IP、SSH用户名、SSH端口、连接超时时间等，“高级设置”和大部分“全局设置”中的选项相同。Job中使用的每一个运程机都要在这里进行配置。

基本设置

SSH Server的基本设置如下图：



此处设置在使用“172.16.18.192-SSH”的所有设置中都生效，相当于此运程SSH节点的全局设置；基于与“全局设置”中同样的原因这里的设置在Job中也可以被覆盖，这在多用户进行远程操作时很有必要，如在172.16.18.192这台机器上有userA和userB两个用户分别用来部署"应用A"和“应用B”。

参数说明

Name
SSH节点配置的名称，在Job中使用Publish over SSH插件时，此名称将出现在“SSH Server”中“Name”的下拉列表中，如下图：



Hostname
通过SSH连接到的机器的主机名或IP

Username
SSH服务使用的用户名，使用key进行连接时为key指定的用户名

Remote Derictory
运程机器上真实存在的目录，并且“Username”指定的用户要有访问此目录的权限，插件将把文件传送到此目录下。

高级设置

高级设置里可以设置SSH端口、重试时间以及重新设置“全局设置”中的选项，由于做用相似，不再做重复说明，设置如下图：

在Jenkins中配置Job

在Job设置中“增加构建步骤”里选择“Send files or execute commands over SSH”，即可以Job中使用Publish over SSH插件，配置如下图：





参数说明
Name
“系统管理>系统设置”设置的SSH Sverver的名字列表。
Source files
复制到运程机上的文件，相对workspace的路径，也支持表达式，如上图中的“**/*.war”。
Remove prefix
文件复制时要过滤的目录，如上图中的target目录。
Remote directory
文件得到到远程机上的目录，此目录是相对于“SSH Server”中的“Remote directory”的，如果不存在将会自动创建。

Exec command
在这里可以填写在运程机器上执行的脚本，如：应用部署脚本。下图中的使用shell部署应用到tomcat的示例：

参考资料

插件配置和使用（http://www.cnblogs.com/zz0412/p/jenkins_jj_10.html）

解决SSH证书问题（http://blog.csdn.net/jiang1986829/article/details/50955359）

插件配置和使用（http://my.oschina.net/yangting880815/blog/417661?fromerr=x1QONbYQ）