jenkins中文使用手册范本.docx

《jenkins中文使用手册范本.docx》由会员分享，可在线阅读，更多相关《jenkins中文使用手册范本.docx（17页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、.Jenkins操作手册XX测试部目录第 1 章 概 述1 第 2 章 根底篇32.1 Jenkins安装3资源下载3运行Jenkins的前提3 Jenkins启动3 Jenkins访问42.2 Jenkins根本设置5设置JDK5 设置ANT5配置邮件信息52.3 创立任务52.4 运行并监控构建作业7主把握面板7手动构建一个任务7 任务构建状态7第 3 章 提高篇：83.1 插件治理：8 FindBugs 插件设置8 Ftp插件配置9Junit插件9通过远程访问触发9 WebLogic.Deployer93.2 安全篇103.3 共性化设置11 第 4 章 常见问题121 / 174.1

2、edit lock问题124.2 IOException: Unable to delete问题124.3 not recognized as a valid application type 问题12 第 5 章 其它说明145.1 CI挑战155.2 ANT根本学问15.第 1 章概 述1.1 什么是持续集成随着软件开发简洁度的不断提高,团队开发成员间如何更好地协同工作以确保软件开发的质量已经渐渐 成为开发过程中不行回避的问题。尤其是近些年来,灵敏Agile 在软件工程领域越来越红火,如何能再不断变化的需求中快速适应和保证软件的质量也显得尤其的重要。持续集成正是针对这一类问题的一种软件开发

3、实践,对于提高软件开发效率并保障软件开发质量供给了 理论根底。它提倡团队开发成员必需常常集成他们的工作,甚至每天都可能发生屡次集成。而每次的集 XX 是通过自动化的构建来验证,包括自动编译、公布和测试,从而尽快地觉察集成错误,让团队能够更快的开发内聚的软件。持续集成最早由Martin Fowler 于 10 年前已经提出,期望通过持续集成能够实现以下过程： 任何人在任何地点,任何时间可以构建整个工程。 在持续集成构建过程中,每一个单元测试都必需被执行。 在持续集成构建过程中,每一个单元测试都必需通过。 持续集成构建的结果是可以公布的软件包。 当以上任何一点不能满足时,整个团队的主要任务就是去解

4、决这个问题。1.2持续集成的核心价值持续集成中的任何一个环节都是自动完成的,无需太多的人工干预,有利于削减重复过程以节约时间、费用和工作量；持续集成保障了每个时间点上团队成员提交的代码是能成功集成的。换言之,任何时间点都能第一时间觉察软件的集成问题,使任意时间公布可部署的软件成为了可能；持续集成还能利于软件本身的进展趋势,这点在需求不明确或是频繁性变更的情景中尤其重要,持续集成的质量能帮助团队进展有效决策,同时建立团队对开发产品的信念。1.3 持续集成的原则业界普遍认同的持续集成的原则包括：1 需要版本把握软件保障团队成员提交的代码不会导致集成失败。常用的版本把握软件有 IBM Rationa

5、l ClearCase、CVS、Subversion 等；2 开发人员必需准时向版本把握库中提交代码,也必需常常性地从版本把握库中更代码到本地；3 需要有特地的集成效劳器来执行集成构建。依据工程的具体实际,集成构建可以被软件的修改来直接触发,也可以定时启动,如每半个小时构建一次；4 必需保证构建的成功。假设构建失败,修复构建过程中的错误是优先级最高的工作。一旦修复,需要手动启动一次构建。1.4 持续集成系统的组成由此可见,一个完整的构建系统必需包括： 一个自动构建过程,包括自动编译、分发、部署和测试等。 一个代码存储库,即需要版本把握软件来保障代码的可维护性,同时作为构建过程的素材库。 一个持

6、续集成效劳器。本文中介绍的 Jenkins/Jenkins 就是一个配置简洁和使用便利的持续集成效劳器。1.5 Jenkins 介绍Jenkins 是一个软件界格外流行的开源CI 效劳器,Hodson 是基于Java 开发的一种持续集成工具,用于监控持续重复的工作,功能包括： 持续的软件版本公布/测试工程。 监控外部调用执行的工作。Jenkins 的版本取名叫Jenkins,所以本文档中的指Jenkins 与 Jenkins 这 2 个词为指同一个软件。 使用 Jenkins 人员需要对持续集成的概念有所了解 ,更多的要求对代码的编译过程很了解 ,Jenkins 对于maven 工程完整的编译

7、和公布流程如下： Jenkins 从SVN 上拉取代码到指定的编译机器上。 在编译机器上触发编译命令或脚本。 编译得到的结果文件。 把结果文件传到指定的效劳器上。使用 Jenkins 进展编译的人员,需要对自己的代码的编译方法,过程格外了解,对编译任务进展分拆。3 / 17.第 2 章根底篇2.1 Jenkins 安装2.1.1 资源下载首先从:/jenkins-ci.org/下载最的 jenkins 版本,最版本为 1.594,下载的文件载体为 jenkins.war；Jenkins 为免费开源软件,并且更速度稳定,每周一次更。所以网站上会供给有 2 个版本,一个最版本,一个老但稳定的版本。

8、可自行选择。2.1.2 运行Jenkins 的前提1） 环境变量的设置：a) JAVA_HOME,设置 JDK 的安装名目,建议承受 JDK1.7,但不建议用 JDK1.8b) ANT_HOME,设置 Ant 的名目,验证过 ant 最版本 1.9.4 可用。c) JENKINS_HOME,设置 Jenkins 的配置文件名目,默认为用户的名目,建议为 Jenkins 的安装名目,便于把握；d) MEVAN_HOME,设置 Maven 的名目,验证 3.2.3 可用。e) PATH,需要将 java、ant,maven 的 bin 名目配置到 path 名目下；f) CLASSPATH,需要将

9、 JDK 的 tools.jar 配置到 classpath 名目中；2.1.3 Jenkins 启动可以有两种方法进展运行 jenkins；a) 直接通过命令行如下：说明：Port 为 jenkins 运行的端口,默认端口为 8080,上述命令其实让 Jenkins 运行在 Winstone容器中；Command Line ParameterDescription-Port=$_PORTRuns Jenkins listener on port $_PORT using standard protocol. The default is port 8080. To disable , use

10、 port -1.-ListenAddress=$_HOSTBinds Jenkins to the IP address represented by $_HOST. The default is 0.0.0.0 i.e. listening on all available interfaces.-sPort=$_PORTUses S protocol on port $_PORT-sListenAddress=$S_HOSTBinds Jenkins to listen for S requests on the IP address represented by $S_HOST.-pr

11、efix=$PREFIXRuns Jenkins to include the $PREFIX at the end of the URL.以下有一些常用的参数：更多参数可以查看:/For example, to make Jenkins accessible at :/myServer:8080/jenkins, set -prefix=/jenkins-ajp13Port=$AJP_PORTRuns Jenkins listener on port $AJP_PORT using standard AJP13 protocol. The default is port 8009. To d

12、isable , use port-1.5 / 17-ajp13ListenAddress=$AJP_HOST-argumentsRealm.passwd.$ADMIN_USER-argumentsRealm.roles.$ADMIN_U SER=admin-Xdebug-Xrunjdwp:transport=dt_socket,addr ess=$DEBUG_PORT,server=y,susp end=nBinds Jenkins to the IP address represented by $AJP_HOST. The default is 0.0.0.0 i.e. listenin

13、g on all available interfaces.Sets the password for user $ADMIN_USER. If Jenkins security is turned on, you must log in as the $ADMIN_USER in order to configure Jenkins or a Jenkins project. NOTE: You must also specify that this user has an admin role. .Sets that $ADMIN_USER is an administrative use

14、r and can configure Jenkins if Jenkins” security is turned on. See Securing Jenkins for more information.Sets debugging on and you can access debug on $DEBUG_PORT.-%m-%d_%H-%M“.logLogging to desired file-XX:PermSize=512Mreferring to these options for Oracle Java-XX:MaxPermSize=2048M-Xmn128M -Xms1024

15、M -Xmx2048Mb) 在 Web 容器中运行Jenkins 可以运行在标准的 Web 效劳器中,支持 Tomcat、oss、WebLogic 中,只需要将 Jenkins.war放置到相应名目,启动效劳就可以进展访问；推举承受这个方式运行,便利配置和迁移。2.1.4 Jenkins 访问验证 jenkins 是否运行正常,通过访问:/10.1.200.59:8089 即可。Hudosn 应用支持 IE、FireFox 等扫瞄器。2.1.5 分布式jenkins 安装为了满足各种编译环境的需求,jenkins 支持分布式,以 jenkins agent 的形式运行slave 机。1. 在

16、jenkins 的主机上,选择系统治理治理节点2. 节点输入名字3. 选择Dumb Slave OK4. 设置处理器的数量,一般以CPU 核数来确定,如 4 核的一般写 35. 选择远程根名目,在 slave 机上用来存放jenkins 自身运行所要的文件6. 使用方式：为了分担master 机器的负载,可选尽可能多的使用本机器或,只允许运行指定本机的任务7. 启动方法：对于window 推举使用Launch slave agents via Java Web Start8. 有效性：任何时间有效配置好了之后,1. 从 slave 机器上翻开扫瞄器,访问jenkins 主机：:/yourjen

17、kinsmaster:80802. 在系统治理治理节点,翻开建立的节点。3. 点启动按钮,jenkins agent 就会从扫瞄器下载包需要的jar、jnlp 包,然后启动。运行程序.在 windows 中,可以安装成为效劳进程,但假设是运行 selenium 这种自动化工作的机器,则不建议这么做。2.2Jenkins 根本设置Jenkins 的根本设置都在系统的后台设置中,具体路径为:系统治理-系统治理2.2.1 设置JDK可以在这里进展 JAVA_HOME 设置,假设已经系统已经设置 JAVA_HOME,可以不需要再进展配置,同时可以让 Jenkins 再安装一个 JDK。2.2.2 设置

18、 Maven2.2.3 设置 ANT可以在这里进展 ANT_HOME 设置,假设系统已经设置了 ANT_HOME,可以不需要再进展配置,同时可以让 Jenkins 安装一个最的 ANT。备注：为了让配置更加简洁,建议在系统级设置 JAVA_HOME 和 ANT_HOME,MAVEN_HOME,便于系统的迁移。2.2.4 配置邮件信息系统能够在执行打算完成后发送结果邮件,需要配置邮件效劳器的相关信息：上面还需要配置Jenkins 的 URL 地址,作为后期访问地址,一旦设定URL,就不要轻易修改。左边显示的可过滤的条件及属于当前用户的BUG2.3 创立任务在 Jenkins 主菜单点击“建任务“

19、,消灭以以下图：键入任务名称,选择“Build a free-style software p“选ro项je,c点t 击“OK“按钮后,消灭下面的界面：说明:a) Project name:工程任务名称,工程任务名称不能重复,后面通称任务；b) Description：工程描述,主要对任务进展简要说明；c) Discard old builds：是否保存过去的构建,默认是保存。帮助:这里把握着您想要在 Jenkins 所在的磁盘把构建记录存储的有效期。Jenkins 为此供给了两个标准：1。时间驱动。在 Jenkins 中您可以推断假设到达确定时限来删除一条记录。2。数量驱动。在Jenkins

20、 中您可以确保它拥有N 份构建。假设又有的构建开头,最早的那份就将被删除。Jenkins 也可以让您建立的个别构建定义为”永久保持这个记录”,以便防止某些重要的构建被自动丢弃。d) This build is parameterized : 假设选择此选项,Jenkins 将允许您供给一套任意的键值对参数,它们会被传递到构建过程里。配置的参数往往是构建运行环境中的一些环境变量。帮助：当您使用了 Jenkins 的各种自动化,有时要求在构建过程中供给一组用户的输入,使用“parameterize“就能够更便利构建。例如,您可能会设立一个按需测试,在那里用户可以提交一个二进制文件的压缩文件来进展测

21、试。e) Disable Build：制止此任务进展构建,默认是不制止；f) Execute concurrent builds if necessary:g) Advanced Project Options1） Quite period:构建前等待时间；2） Retry Count:从 SCM 仓库中取出尝试时间；3） Block build when upstream project is building: 假设上一个仍在构建过程中,停顿本次构建任务；4） Use custom workspace:指定当前任务的 workspace,否则默认为 JENKINS_HOME 的工作名目h)

22、 Source Code Management：指定编译源代码的猎取方式： 1 None：手动方式；2 CVS：从 CVS 仓库中猎取;备注:CVS 通过 Module猎取多个工程工程3 SVN：从 SVN 仓库中猎取;备注：SVN 通过“Add more locations“来添加多个工程,在 SVN 的 URL 中需要添加用户名密码信息,例如:svn:/username:passwdi) Builds Triggers：设置构建触发器1） Build after other projects are built: 设置构建的流水线,配置在设置的任务构建完成后自动构建此任务,进展设置后,可以

23、在任务统揽中看到以下“下游工程说明“2） Trigger builds remotely :设置远程触发进展任务构建； 3 Build periodically：设置构建频率,设置跟 Quartz CronTrigger 设置雷同； 4 Poll SCM：设置从 SCM 库中检查源代码是否更：备注：关于第三和第四两点,根本配置为分钟 小时 天 月 星期举例： 每分钟进展集成 * * * * *,每 5 分钟进展集成 5 * * * *, 每天 12 点和 23 整点进展集成 0 12,23 * * *j) Build Environment：设置构建环境设置1） Tool Environmen

24、t：设置工具的环境变量2） Create a formatted version number：设置构建的版本号k) Build：执行构建构建支持 6 种方式,shell运行于 Linux 环境、Maven支持 Maven 编译、Commandwindows批处理命令、Ant、EasyAnt、Export job runtime parameters。举例：1） Ant：备注： Targets 主要是执行 ant 脚本中哪几个局部,可以添加多个； Build File:需要指定 Ant 脚本的物理位置； Properties：添加 Ant 指定的属性； Java Options：设置运行 ja

25、va 时的属性,例如内存、堆大小等； 2 Command备注：执行 Windows 的批处理命令,这里不能利用 Hodson 设置的变量；l) Post-build Actions1 Publish Javadoc：设置构建时产生 JavaDoc 时的文件名目； 2 Archive the artifacts:设置构建后哪些文件需要进展归档处理； 3 E-mail Notification：邮件提示备注：可以向多个人发送邮件,通过“；“进展分割4 Status Monitor：构建状态监控；：,好,根本的配置到这里完毕,可以搭建一个的任务进展构建了；.2.4 运行并监控构建作业2.4.1 主把

26、握面板当配置完成一个任务后,回到主把握面板： 上图中右边列表列举现在已经配置的任务已经任务当前的状态 左边有构建队列,当有构件时,会把当前正在构建的队列在上面进展列举； 上图右下角有 RSS 订阅,支持订阅全部、失败和最终一次等；2.4.2 手动构建一个任务当一个任务配置完成后,可以承受手动构建和触发器构建两种方式 ,在工程验证阶段,可以通过手动触发方式,点击任务区的“马上构建“,会在 Build History 中消灭以下进度条：点击进度条,可以进入到具体的编译过程,例如以以下图： 等构建完毕后,你可以看到最任务构建的结果图： 扫瞄任务的整体运行状况入以以下图：最左边列图示为最终一次构建状态

27、,其次列图示为整个任务的构建总体结果 ,具体如下表示,以以下图也只截取局部：2.4.3 任务构建状态Jenkins 通过当前构建状态和构建稳定 当前构建状态分为以下几种工程构建完成,同时被认为是稳定的工程构建完成,但被认定为不稳定构建失败作业已经制止 构建稳定行,Jenkins 会基于一些后处理器任务为构建公布一个稳健指数,越高越稳定构建成功率80%构建成功率 60%-79%构建成功率 40%-59%构建成功率 20%-39%构建成功率 0-19%期盼任务编译都处于和状态。7 / 17第 3 章提高篇：3.1 插件治理：由 Jenkins 类库现有的Jenkins 功能性扩展和开发者们为Jen

28、kins 供给的功能都可以称之为Jenkins 插件。Jenkins 将插件分为 Artifact Uploaders、Authentication and User Management、Build Notifiers、Build Reports、Build Tools、Build Triggers、Build Wrappers、Cluster Management and Distributed Build、Command Line Interface、External Site/Tool Integrations、Maven、Miscellaneous、Other Post-Build

29、Actions、 Decorators、Slave Launchers and Controllers、Source Code Management、User Interface 等 17 个插件大类。1） Artifact Uploaders：帮助把构建结果公布到一些网络终端上,例如 FTP 效劳器、Tomcat 应用效劳器、J 版本库等等；2） Authentication and User Management：Hodson 根本包不供给用户权限治理,通过此插件,融入LDAP、MySql 等权限治理插件,丰富权限治理；3） Build Notifiers：任务构建完成后公布通知的方式,支

30、持 Twitter、IRC、Google 日历等； 4 Build Reports：主要针对构建的源代码进展分析的报表,例如 FindBugs、Checkstyle 等等, 5 Build Triggers：构建大事监听并触发构建的插件,例如通过 URL 转变进展触发编译； 6 Build Tools：实现额外构建工具的插件,例如 Ruby Plugin、Grails Plugin 等；7） Build Wrappers：8） Cluster Management and Distributed Build： 9 Command Line Interface：10 External Site/

31、Tool Integrations： 11 Maven：12） Miscellaneous：13） Other Post-Build Actions： 14 Decorators:15 Slave Launchers and Controllers： 16 Source Code Management:17 User Interface:备注：全部的插件安装完毕后,必需重启Jenkins 才能使插件生效,不支持即插即用模式。具体插件使用说明:3.1.1 FindBugs 插件设置1. 下载 FindBugs,并解压到相应的名目,将 findbugs-ant.jar 拷贝 ANT_HOMElib

32、 名目下；2. 设置 FINDBUGS_HOME 名目为解压名目；3. Build.xml 文件中配置 FindBugs 配置：a) 设置 findBugs 在 build.xml 中的路径b) 声明 Findbugs 任务c) 创立 FindBugs 任务,例如：d) Eclipse 中配置 Findbugs选择Eclipse-Windows-Perference,对 ant 进展编辑,选择Runtimei. 配置 findbugs-ant.jar 到 Classpath 名目下下,可以通过选择“Add External JARS“；ii. 对 Tasks 进展配置,增加一个 Task,命名

33、为 findbugs,选择 Location 为添加的 findbugs-ant.jar 的物理位置,并指定具体为哪个类,如以以下图：e) 在 Jenkins 中设置 Findbugs选择需要配置任务进展配置,勾选其中 findbugs 选项,如以以下图：f) 编译成功后,fingbugs 的结果和趋势图可以点击具体的链接进展分析 findbugs 的认定结果和具体的代码,趋势图3.1.2 Ftp 插件配置a) 在系统的插件治理中下载 FTP 插件；b) 在系统治理中配置 FTP 效劳器的相关信息,如以以下图：c) 在选定的任务中配置 FTP在这里选择需要上传的 FTP 效劳器,并指定源文件和

34、目的地址。3.1.3 Junit 插件3.1.4 通过远程访问触发Jenkins 支持远程触发方式进展构建,具体设置在当前任务的设置中,如以以下图： 用户通过访问上面的URL 就可以进展相应的构建。3.1.5 WebLogic.DeployerWebLogic Server供给以下四种方式来帮助你配置和部署应用系统：a) Weblogic.Deployerb) 治理把握台c) WLST Weblogic.Deployerweblogic.Deployer 供给基于命令行的界面来执行根本和高级部署任务。当期望命令行访问 WebLogic Server 部署功能时 , 或者当需要使用治理把握台执行

35、不受支持的部署任务时 , 使用weblogic.Deployer。 治理把握台治理把握台供给一系列基于 Web 的部署助手,这些助手可以指导您完成部署过程。治理把握台还供给控件可用于更改和监视部署状态、在部署设备启动并运行时更改所选的部署描述符值。 当需要以交互方式执行根本部署功能并且可以访问受支持的扫瞄器时,请使用治理把握台。 WLSTWebLogic 脚本工具 是的命令行界面,可用于使域配置任务包括应用程序部署配置和9 / 17部署操作自动化。为了实现系统的自动部署,可以承受WebLogic.Deployer 和WLST 两种方式进展,但由于持续集成环境和 WebLogic Server

36、在物理位置上差异,最终选择承受 WebLogic.Deployer 作为持续继承公布到WebLogic Server 方式。下面对其进展根本操作介绍。WebLogic.Deployer 部署承受 java 命令方式进展部署,务必需要把根底篇中 3 个 WebLogic 相关的 jar放到 CLASSPATH 中或则在启动命令行中添加-classpath 命令参数。下面简洁说明几个最常用的WebLogic.Deployer 的命令: 部署或重部署应用程序或模块java weblogic.Deployer -adminurl t3:/192.168.180.3:7001-username user

37、name -password password-deploy -targets target_list-upload-name deployment_name 停顿部署单元并从目标效劳器中删除临时文件java weblogic.Deployer -adminurl t3:/192.168.180.3:7001 -username username-password password -undeploy -targets target_list -namedeployment_name具体命令说明：命令或选项说明-username username治理员用户名。假设供给 -username 选项

38、但不供给对应的 -password 选项,则 weblogic.Deployer会提示您输入密码。-password password-targets target_list-upload-name deployment_name治理员用户密码。在其上分发和部署应用程序或模块的目标。target_list参数是以逗号分隔的目标效劳器、群集或虚拟主机的列表。将指定的部署文件包括部署打算或备用部署描述符传输到 治理效劳器。需要公布的 war 或 ear 包的路径要安排给部署的应用程序或独立模块的部署名称,可选。具体可以参考:/3.2 安全篇Jenkins 安装完成后,默认是不进展安全把握的,需要在

39、系统配置中添加安全把握后,具体位置在系统治理的安全域中,Jenkins 支持Jenkins 专用用户数据库、LDAP、Servlet 容器代理、MySql 数据库。授权策略包括承受安全矩阵、登陆后可以做任何事、任何用户可以做任何事没有任何限制、工程矩阵授权策略、遗留模式等。 建议承受 Jenkins 专用数据库 ,安全策略承受安全矩阵方式 ,已经能够根本满足现有的模式。如以以下图：.选择Jenkins 专用用户数据库后,勾选允许用户注册选项。在添加用户或组,对其进展附权限。用户注册在首页的右上角,如以以下图点击注册后,消灭如以以下图：添加用户的根本信息,点击注册按钮后,用户注册完成,用户没有赋

40、权限,登陆后的界面如下： 备注:对用户先赋权限或先注册再赋权限没有先后挨次。3.3 共性化设置Jenkins 对用户视图支持共性化定制,保证登陆用户只关注自身关注的工程视图,用户登陆后,默认一般显示如以以下图：可以点击“+“增加共性化视图,消灭如下视图：选择List View选项,填写“View name“,以及需要的任务选项,同时可以选择需要呈现的列,选择完成后保存即可,可以在首页上显示。用户登陆后,可以选择“Personal View“或“My Views“查看共性化界面。11 / 17.第 4 章常见问题4.1edit lock 问题现象：当在构建时命令输出行提示： Deployer:1

41、49163The domain edit lock is owned by another session in non-exclusive mode - this deployment operation requires exclusive access to the edit lock and hence cannot proceed.解决方法：到 weblogic 把握台登陆后,应改为Lock&Edit 状态再构建。4.2IOException: Unable to delete 问题现象：当构建时报不能删除之前的文件时,具体信息如下：Checking out a fresh work

42、space because there”s no workspace at D:Jenkinsjobsgazaworkspacegaza java.io.IOException: Unable to delete D:Jenkinsjobsgazaworkspacegazaat Jenkins.Util.deleteFileat Jenkins.Util.deleteRecursiveat Jenkins.Util.deleteContentsRecursiveat Jenkins.scm.SubversionSCM$CheckOutTask.invoke at Jenkins.scm.SubversionSCM$CheckOutTask.invoke at Jenkins.FilePath.actat Jenkins.FilePath.actat Jenkins.scm.SubversionSCM.checkoutSubversionSCM.java:653