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

时间:2022-04-25 11:24:30
依赖环境
SSH:
    远程机开启SSH服务。同意Jenkins所在机器通过SSH服务登录到远程机运行脚本。
    能够设置SSH使用username/password或通过key登录,SSH配置请查专门的资料这里不做说明
   JDK:
    本文部署的是JAVA应用。远程机上要用jdk环境,如非Java应用请忽略
   Tomcat:
    本文是以Tomcat为例,将应用部署到Tomcat中运行,远程机上安装Tomcat是必须的,
    如非Java应用请忽略。如用其它web容器请查找容器的安装资料   在使用Publish Over SSH之前,需要制作SSH私钥。机器间做免密登录配置具体配置请看
------www.cnblogs.com/guanyf/p/10600458.html------

插件安装

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

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

插件配置

全局设置

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

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

參数说明
Passphrase:SSH的password
   使用username/password登录时为username的password。使用私钥登录时为私钥的password。
Path to key:SSH私钥的文件路径
   私钥文件的路径,能够是绝对路径。也能够是相对$JENKINS_HOME的相对路径
Key:私钥
   私钥导出后的文本内容
假设“Key”和“Path to key”都设置,则“Key”的优先级较高,私钥的password是“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中设置的命令都将补忽略

SSH Server 配置

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

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

  参数说明:

  Name:ssh server的名字,随便写,意义明确,到时候选择的时候,下拉框显示的就是这个名字

  HostName:远程服务器的IP地址,不用带端口号

  UserName:登陆服务器的用户名

  Remote Directory:远程服务器的目录,用来存放build完的war包,这里填写tomcat的安装目录即可

  Use password authentication, or use a different key:默认是未勾选的,这是登陆服务器的方式,一种是使用用户名密码,另外一种是需要在服务器上生成证书key之类的,为了图方便这里我勾上了。

  Passphrase / Password:填上服务器的密码即可。

  其他选项保持默认,然后保存。

高级设置

高级设置里能够设置SSHport、重试时间以及又一次设置“全局设置”中的选项。因为做用类似,不再做反复说明,设置例如以下图:

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

设置完成后点击 "Test Configuration"进行测试,出现下图提示表示设置成功

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

在Jenkins中配置Job

在Job设置中“添加构建步骤”里选择“Send files or execute commands over SSH”,即能够Job中使用Publish over SSH插件,配置例如以下图:

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

Name :之前添加过的SSH server
Transfer set配置参数如下:
  Source files:<>
          文件源,就是在Jenkins机器上的root/.jenkins/workspace/项目名/,
          这是根目录(项目名就是你之前在Jenkins新建的项目),这个根目录下的war包路径
          比如:root/.jenkins/workspace/myproject/a/b/c.war,
          那么Source files填写a/b/c.war即可。
          那么,我怎么知道我的全路径是什么呢,大家可以不配构建环境,在上一步的git地址配好以后,直接去build,
          构建完以后构建的信息里会有相关的路径输出
  Remove prefix:去掉source files的路径,
          比如之前是a/b/c.war,那么我如果填写a/b/,那么最后只会把c.war传输到目标文件下面。
  Remote directory:这是war包传输到远程服务器上的路径,
             但是由于之前在配置SSH Server的时候已经配置了一个Remote directory,所以默认如果不填,
             那么就是ssh server的目录,如果填的话,那么就会在ssh server的directory下去查找/生成。
  Exec Command:这个是填写shell命令,在你把war包传完以后,会去执行这里的命令。

到此配置完成