Skip to Content
Last modified by Bastian Triller on 2012/08/24 19:38
From version 115.1
edited by Johan Henselmans
on 2010/08/18 21:04
Change comment: There is no comment for this version
To version 126.2
edited by Bastian Triller
on 2012/08/24 19:38
Change comment: Changed document parent to [xwiki:documentation.Home.Deployment.Using Jenkins Build Server with WebObjects Projects.WebHome].

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Installing and Using the Hudson build server
1 +Installing and Configuring Jenkins
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.Home.Deployment.Using Jenkins Build Server with WebObjects Projects.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.johanhenselmans
1 +XWiki.btriller
Tags
... ... @@ -1,0 +1,1 @@
1 +build|favourite|jenkins
Content
... ... @@ -1,146 +1,116 @@
1 -[[Hudson>>http://hudson-ci.org/]] is an "extensible continuous integration server". It monitors repeated executions of jobs, such as building software projects, and can be used to build WebObjects applications and frameworks. Hudson is an open source project, and can be used at no cost. An introductory presentation on building WebObjects projects with Hudson was given by Mike Schrag at WOWODC-West in 2009, and the video can be [[purchased from wocommunity.org>>http://www.wocommunity.org/apps/WebObjects/WOCommunity.woa/wa/recordings]].
1 +**[[Jenkins>>url:http://jenkins-ci.org/||shape="rect"]]** is an "extensible continuous integration server". It monitors repeated executions of jobs, such as building software projects, and can be used to build WebObjects applications and frameworks. Jenkins is an open source project and can be used at no cost. It is hosted on [[Github.com>>url:https://github.com/jenkinsci||shape="rect"]].
2 2  
3 -== Setting up Hudson ==
3 +An introductory presentation on building WebObjects projects with Hudson (the predecessor to Jenkins) was given by Mike Schrag at WOWODC-West in 2009. You can also have a look at a [[recording from WOWODC 2009 East>>url:http://www.wocommunity.org/podcasts/wowodc/east09/WOWODC09E-MultipleVersionsWO.mov||shape="rect"]].
4 4  
5 -There are a couple different ways to run Hudson. The easiest is to run it as a standalone application.
5 +=== Pre-requirements ===
6 6  
7 -=== Standalone Installation ===
7 +Before you install Jenkins, you will need to install
8 8  
9 -{{info}}
10 -These instructions are based on David Avendasora's setup. You may have different preferences as to where to install Hudson at or where to set its home directory to.
11 -{{/info}}
9 +* a Java SDK (a JRE won't work because of Ant)
10 +* a Git client. Make sure that the 'git' command is in the regular PATH (in /usr/bin or /usr/sbin). If it's elsewhere, like /opt/local/bin/git or /usr/local/bin/git, make a symlink in /usr/bin (example: sudo ln -s /opt/local/bin/git /usr/bin/git).
11 +* a Subversion client if you are going to use Subversion
12 12  
13 -1. Create a ##/Developer/Hudson/Home## directory.
14 -1. [[Download Hudson>>http://hudson-ci.org/latest/hudson.war]], saving ##hudson.war## file to ##/Developer/Hudson##.
15 -1. Launch Hudson with the following command in Terminal.app:
13 +=== Upgrading from Hudson ===
16 16  
17 -{{code}}
15 +Switching from Hudson to Jenkins is straight-forward since Hudson was the foundation that Jenkins was forked from. jenkins-ci.org has a [[wiki entry>>url:https://wiki.jenkins-ci.org/display/JENKINS/Upgrading+from+Hudson+to+Jenkins||shape="rect"]] to help with the change.
18 18  
19 -java -DHUDSON_HOME=/Developer/Hudson/Home -jar /Developer/Hudson/hudson.war
17 +=== Stand-Alone Mac OS X Setup ===
20 20  
21 -{{/code}}
19 +1. Download the Jenkins Binary Installer from the [[Jenkins Website>>url:http://jenkins-ci.org/||shape="rect"]].
20 + The direct link to get the latest installer is: [[http:~~/~~/mirrors.jenkins-ci.org/osx/latest>>url:http://mirrors.jenkins-ci.org/osx/latest||shape="rect"]]. This will download a standard OS X Installer Package named {{code language="none"}}jenkins-n.nnn.pkg{{/code}}.
21 +1. Run the installer
22 +[[image:attach:JenkinsInstaller.png]]
23 +1. Restart your computer
24 + This is required because the current version of Jenkins does not create the its directory until it launches after you restart you computer.
25 +1. Point your browser to: [[http:~~/~~/localhost:8080/>>url:http://localhost:8080/||shape="rect"]]
26 +1. [[Start setting up jobs!>>doc:documentation.Home.Deployment.Using Jenkins Build Server with WebObjects Projects.Installing WebObjects and Wonder for Jenkins using WOJenkins.WebHome]]
22 22  
23 -{{info}}
28 +=== Stand-Alone CentOS/RedHat/Amazon Linux ===
24 24  
25 -If you have an instance of Tomcat or AJP running in a different process you can also use the {{\-}}{{{}{-}httpPort{-}}} and {{\-ajp13Port}} options to change the ports used.
26 -{code}
27 -java -DHUDSON_HOME=/Developer/Hudson/Home -jar /Developer/Hudson/hudson.war -httpPort=9080 --ajp13Port=9009
28 -{code}
30 +The easiest way to install Jenkins on a Fedora/RedHat/CentOS/Amazon Linux is by using [[Yum>>url:http://en.wikipedia.org/wiki/Yellow_dog_Updater,_Modified||shape="rect"]]. The Jenkins project have a Yum repository and [[complete instructions>>url:https://wiki.jenkins-ci.org/display/JENKINS/Installing+Jenkins+on+RedHat+distributions||shape="rect"]] on how to add the repository + install Jenkins the first time. You can also manually install Jenkins from a RPM available on jenkins-ci.org.
29 29  
30 -{{/info}}
32 +Please note that on CentOS 5.x (I don't know for CentOS 6), the list of root certificates is old, and you will get error when trying to clone a Git repository coming from GitHub. To update the list of root certificates, do:
31 31  
32 -1. Point your browser to: [[http://localhost:8080/]]
33 -1. Start setting up jobs
34 +{{code}}
34 34  
35 -=== Servlet Container Installation on Mac OS X (10.5, 10.6) ===
36 +sudo cp /etc/pki/tls/certs/ca-bundle.crt /etc/pki/tls/certs/ca-bundle.crt.original
37 +sudo curl http://curl.haxx.se/ca/cacert.pem -o /etc/pki/tls/certs/ca-bundle.crt
36 36  
37 -1. Install Tomcat from [[http://www.macports.org]] with the command
38 -
39 -{{noformat}}
40 -
41 -sudo /opt/local/bin/port install tomcat6
42 -
43 -{{/noformat}}
44 -
45 -1. Create an administrative user in ##/opt/local/share/java/tomcat6/conf/tomcat-users.xml##.
46 -
47 -{{code value="xml"}}
48 -
49 -<?xml version='1.0' encoding='utf-8'?>
50 -<tomcat-users>
51 - <role rolename="manager"/>
52 - <role rolename="admin"/>
53 - <user username="tomcat" password="tomcat" roles="admin,manager"/>
54 -</tomcat-users>
55 -
56 56  {{/code}}
57 57  
58 -{{panel bgColor="#F7D6C1"}}
41 +=== Stand-Alone Ubuntu/Debian ===
59 59  
60 -Don't forget to change the username and password after you have finished checking out the build server and start using it in production.
43 +Follow [[the following instructions>>url:http://pkg.jenkins-ci.org/debian/||shape="rect"]] to get Jenkins running on a Ubuntu or Debian system. If you didn't install a Sun JVM before installing Jenkins from their repository, it will install OpenJDK 1.6. [[Check the Ubuntu documentation>>url:https://help.ubuntu.com/community/Java||shape="rect"]] for details on how to install a JDK on Ubuntu.
61 61  
62 -{{/panel}}
45 +=== Post installation ===
63 63  
64 -1. Start Tomcat.
47 +After Jenkins is installed and running, go into Jenkins configuration and make sure that you install the "Multiple SCMs" and "Git plugin". If you are using another SCM like Mercurial or Perforce, install the plugins and the clients for your SCM.
65 65  
66 -{{noformat}}
49 +=== Using SSL ===
67 67  
68 -sudo launchctl load -w /Library/LaunchDaemons/org.macports.tomcat6.plist
51 +Setting up SSL for Jenkins is surprisingly easy. The following is originally from the [[SSL Setup Options>>url:http://jenkins.361315.n4.nabble.com/SSL-Setup-Options-td954261.html||shape="rect"]] page on nabble.com:
69 69  
70 -{{/noformat}}
53 +1. Create a selfsigned test SSL certificate. 
54 + keytool -genkey -keyalg RSA -alias selfsigned -keystore keystore.jks -storepass ToPSecRet321 -dname "cn=localhost"
55 +1. Launch Jenkins.
56 +1. {{noformat}}java -jar jenkins.war --httpPort=-1 --httpsPort=8080 --httpsKeyStore=keystore.jks --httpsKeyStorePassword=ToPSecRet321{{/noformat}}Launch browser 
57 + Open "https:~/~/localhost:8080" in browser. You might get a browser warning, because the certificate is not signed by a known certificate authority. Communication is SSL-encrypted nevertheless.
71 71  
72 -1. [[Download Hudson>>http://hudson-ci.org/latest/hudson.war]], saving ##hudson.war## somewhere for later.
73 -1. Create a folder for Hudson to work in: ##/opt/local/var/db/hudson##
74 -1. Change ownership of that folder: ##chown www:_www /opt/local/var/db/hudson##
75 -1. Add the following to ##/opt/local/share/java/tomcat6/conf/setenv.local##:
59 +{{note title="Please Note"}}
60 +The port has changed from the original instructions. That was required on Mac OS X because of permissions. Also, it's worth noting that the keytool asks for a second password for the private key of the ssl certificate. We are using the same password as the keystore password and everything works. It is unclear if that makes a difference.
61 +{{/note}}
76 76  
77 -{{noformat}}
63 +=== Servlet Container Installation on Mac OS X (10.5, 10.6) ===
78 78  
79 -export HUDSON_HOME=/opt/local/var/db/hudson
80 -export JAVA_OPTS=-Djava.awt.headless=true
65 +1. Install Tomcat from [[http:~~/~~/www.macports.org>>url:http://www.macports.org||shape="rect"]] with the command
66 +1. {{noformat}}sudo /opt/local/bin/port install tomcat6{{/noformat}}Create an administrative user in {{code language="none"}}/opt/local/share/java/tomcat6/conf/tomcat-users.xml{{/code}}. {{code 0="xml"}}<?xml version='1.0' encoding='utf-8'?>
67 +<tomcat-users>
68 + <role rolename="manager"/>
69 + <role rolename="admin"/>
70 + <user username="tomcat" password="tomcat" roles="admin,manager"/>
71 +</tomcat-users>{{/code}}
72 +1. {{panel bgColor="#F7D6C1"}}Don't forget to change the username and password after you have finished checking out the build server and start using it in production.{{/panel}}Start Tomcat.
73 +1. {{noformat}}sudo launchctl load -w /Library/LaunchDaemons/org.macports.tomcat6.plist{{/noformat}}[[Download Jenkins>>url:http://mirrors.jenkins-ci.org/war/latest/jenkins.war||shape="rect"]], saving {{code language="none"}}jenkins.war{{/code}} somewhere for later.
74 +1. Create a folder for Jenkins to work in: {{code language="none"}}/opt/local/var/db/jenkins{{/code}}
75 +1. Change ownership of that folder: {{code language="none"}}chown _www:_www /opt/local/var/db/jenkins{{/code}}
76 +1. Add the following to {{code language="none"}}/opt/local/share/java/tomcat6/conf/setenv.local{{/code}}:
77 +1. {{noformat}}export JENKINS_HOME=/opt/local/var/db/jenkins
78 +export JAVA_OPTS=-Djava.awt.headless=true{{/noformat}}Install Jenkins in Tomcat: go to [[http:~~/~~/localhost:8080>>url:http://localhost:8080||shape="rect"]], login with the user and password that you have created in {{code language="none"}}tomcat-users.xml{{/code}}, and upload {{code language="none"}}jenkins.war{{/code}} to the Tomcat server.
79 +1. Goto [[http:~~/~~/localhost:8080/jenkins>>url:http://localhost:8080/jenkins||shape="rect"]] and you can start configuring your Jenkins build server.
81 81  
82 -{{/noformat}}
81 +=== (% style="color: rgb(0,0,0);" %)**Servlet Container Installation on Mac OS X Server (10.6)**(%%) ===
83 83  
84 -1. Install Hudson in Tomcat: go to [[http://localhost:8080]], login with the user and password that you have created in ##tomcat-users.xml##, and upload ##hudson.war## to the Tomcat server.
85 -1. Goto [[http://localhost:8080/hudson]] and you can start configuring your Hudson build server.
86 -
87 -=== {{color value="#000000"}}{*}Servlet Container Installation on Mac OS X Server (10.6)*{{/color}} ===
88 -
89 89  1. Tomcat is by default installed on Mac OS X Server.
90 -1. Create an administrative user in&nbsp;##/Library/Tomcat/conf/tomcat-users.xml##.
91 -
92 -{{code value="xml"}}
93 -
94 -<?xml version='1.0' encoding='utf-8'?>
84 +1. Create an administrative user in {{code language="none"}}/Library/Tomcat/conf/tomcat-users.xml{{/code}}. {{code 0="xml"}}<?xml version='1.0' encoding='utf-8'?>
95 95  <tomcat-users>
96 96   <role rolename="manager"/>
97 97   <role rolename="admin"/>
98 98   <user username="tomcat" password="tomcat" roles="admin,manager"/>
99 -</tomcat-users> 
89 +</tomcat-users> {{/code}}
90 +1. {{panel bgColor="#F7D6C1"}}(% style="color: rgb(0,0,0);" %)Don't forget to change the username and password after you have finished checking out the build server and start using it in production. {{/panel}}The way to start it depends on the version. The current way is to go to the Web Settings in Server Admin, Settings, General, check the Tomcat checkbox. Restart the WebServer.
91 +1. [[Download Jenkins>>url:http://mirrors.jenkins-ci.org/war/latest/jenkins.war||shape="rect"]], saving {{code language="none"}}jenkins.war{{/code}} somewhere for later.
92 +1. Create a folder for Jenkins to work in: {{code language="none"}}/Library/Jenkins{{/code}}
93 +1. Change ownership of that folder: {{code language="none"}}chown _appserver:sys /Library/Jenkins{{/code}}
94 +1. Add the following to {{code language="none"}}/Library/Tomcat/bin/setenv.sh{{/code}}:
95 +1. {{code}}export JENKINS_HOME=/Library/Jenkins
96 +export JAVA_OPTS=-Djava.awt.headless=true{{/code}}Make sure that you are using UTF-8 in the Connector, by adding {{code language="none"}}URIEncoding="UTF-8"{{/code}} to the Connector in {{code language="none"}}/Library/tomcat/conf/server.xml{{/code}} as shown here:
97 +1. {{code 0="xml"}}<Connector port="8080" protocol="HTTP/1.1"
98 + connectionTimeout="20000"
99 + redirectPort="8443" URIEncoding="UTF-8"/>{{/code}}Install Jenkins in Tomcat: go to [[http:~~/~~/localhost:8080>>url:http://localhost:8080||shape="rect"]], login with the user and password that you have created in tomcat-users.xml, and upload jenkins.war to the Tomcat server.
100 +1. Goto [[http:~~/~~/localhost:8080/jenkins>>url:http://localhost:8080/jenkins||shape="rect"]] and you can start configuring your Jenkins build server.
100 100  
101 -{{/code}}
102 +== Building WO Apps ==
102 102  
103 -{{panel bgColor="#F7D6C1"}}
104 +* Check out[[attach:setupWorkspace.sh]]
104 104  
105 -{color:#000000}Don't forget to change the username and password after you have finished checking out the build server and start using it in production.&nbsp;{color}
106 +== Jenkins plugins ==
106 106  
107 -{{/panel}}
108 +After Jenkins is installed and started, you will need to install at the very minimum two plugins: [[Multiple SCMs>>url:https://wiki.jenkins-ci.org/display/JENKINS/Multiple+SCMs+Plugin||shape="rect"]] and [[Git>>url:https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin||shape="rect"]]. They are required if you need to build projects by using the WOJenkins templates. If your projects are under another SCM like Subversion or CVS, you also need to install Jenkins for it.
108 108  
109 -1. The way to start it depends on the version. The current way is to go to the Web Settings in Server Admin, Settings, General, check the Tomcat checkbox. Restart the WebServer.&nbsp;
110 -1. {{color value="#003366"}}[{{/color}}{{color value="#003366"}}Download Hudson{{/color}}http:~/~/hudson-ci.org/latest/hudson.war, saving&nbsp;##hudson.war##&nbsp;somewhere for later.
111 -1. Create a folder for Hudson to work in:&nbsp;##/Library/hudson##
112 -1. Change ownership of that folder:&nbsp;##chown appserver:sys /Library/Hudson##
113 -1. Add the following to&nbsp;##/Library/Tomcat/bin/setenv.sh##:
110 +{{info}}
111 +Don't forget to set **Global Config user.name Value** and **Global Config user.email Value** in the Jenkins settings, or else doing a Git clone will return an error.
112 +{{/info}}
114 114  
115 -{{noformat}}
114 +== Building projects ==
116 116  
117 -export HUDSON_HOME=/Library/Hudson
118 -export JAVA_OPTS=-Djava.awt.headless=true
119 -
120 -{{/noformat}}
121 -
122 -1. Make sure that you are using UTF8 in the Connector, by adding
123 -
124 -{{noformat}}
125 -
126 -URIEncoding="UTF-8"
127 -
128 -{{/noformat}}
129 -
130 -to the Connector in /Library/tomcat/conf/server.xml in such a way:
131 -
132 -{{noformat}}
133 -
134 - <Connector port="8080" protocol="HTTP/1.1"
135 - connectionTimeout="20000"
136 - redirectPort="8443" URIEncoding="UTF-8"/>
137 -
138 -{{/noformat}}
139 -
140 -1. Install Hudson in Tomcat: go to [[http://localhost:8080]], login with the user and password that you have created in tomcat-users.xml, and upload hudson.war to the Tomcat server.
141 -
142 -1. Goto [[http://localhost:8080/hudson]]&nbsp;and you can start configuring your Hudson build server.
143 -
144 -== Building WO Apps ==
145 -
146 -* Check out [[^setupWorkspace.sh]]
116 +See [[doc:documentation.Home.Deployment.Using Jenkins Build Server with WebObjects Projects.Installing WebObjects and Wonder for Jenkins using WOJenkins.WebHome]]
Jenkins Installer.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +103.2 KB
Content
JenkinsInstaller.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +103.2 KB
Content
setupWorkspace.sh
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +2.7 KB
Content
... ... @@ -1,0 +1,78 @@
1 +#!/bin/bash
2 +# Call this from Hudson as the first build stage:
3 +#
4 +# /Path/to/Deps/setupWorkspace.sh "${WORKSPACE}" 53
5 +#
6 +# Expects a Deps folder that contains:
7 +# this script
8 +# WebObjects53 folder with System/Library/Frameworks, etc
9 +# WebObjects54 folder with the same (if you use 54)
10 +# Wonder-latest-Frameworks-53.tar.gz (unless you build Wonder in Hudson)
11 +# Wonder-latest-Frameworks-54.tar.gz (if you use 54, unless you build Wonder in Hudson)
12 +# woproject.jar (WOLips woproject.jar ant tasks)
13 +
14 +WORKSPACE=$1
15 +DEPS=`dirname $0`
16 +WO_VERSION=$2
17 +ROOT=$WORKSPACE/Root
18 +WONDER=Wonder-latest-Frameworks-${WO_VERSION}.tar.gz
19 +WOPROJECT=woproject.jar
20 +JOB_ROOT=${WORKSPACE}/../..
21 +
22 +if [ "$WORKSPACE" == "" ]; then
23 + echo "You must provide a workspace setting."
24 + exit 1
25 +fi
26 +
27 +if [ "$WO_VERSION" == "" ]; then
28 + echo "You must provide a WO version."
29 + exit 1
30 +fi
31 +
32 +# Make sure the Libraries folder exists
33 +mkdir -p ${WORKSPACE}/Libraries
34 +
35 +# Setup System and Library
36 +#rm -rf ${ROOT}
37 +mkdir -p ${ROOT}
38 +mkdir -p ${ROOT}/lib
39 +cp ${DEPS}/${WOPROJECT} ${ROOT}/lib
40 +rm -rf ${ROOT}/Library/Frameworks
41 +mkdir -p ${ROOT}/Library/Frameworks
42 +mkdir -p ${ROOT}/Library/WebObjects/Extensions
43 +mkdir -p ${ROOT}/Network/Library/Frameworks
44 +mkdir -p ${ROOT}/User/Library/Frameworks
45 +rm ${ROOT}/System
46 +ln -sf ${DEPS}/WebObjects${WO_VERSION}/System ${ROOT}/System
47 +
48 +# Setup Wonder
49 +# If you want to use the Wonder in Deps, use this:
50 +(cd ${ROOT}/Library/Frameworks; tar xfz ${DEPS}/${WONDER})
51 +# If you build Wonder in Hudson, use this:
52 +#(cd ${ROOT}/Library/Frameworks; tar xfz ${JOB_ROOT}/Wonder/lastSuccessful/archive/dist/Wonder-*-Frameworks-${WO_VERSION}.tar.gz)
53 +
54 +# Copy other frameworks from Hudson build folders based on .classpath entries -- if you don't build everything
55 +# in Hudson, you will need to copy these in yourself
56 +FRAMEWORKS=`cat ${WORKSPACE}/.classpath | grep WOFramework/ | sed 's#.*WOFramework/\([^"]*\)"/>#\1#'`
57 +for FRAMEWORK in $FRAMEWORKS; do
58 + if [ -e "${JOB_ROOT}/${FRAMEWORK}" ]; then
59 + (cd ${ROOT}/Library/Frameworks; tar xfz ${JOB_ROOT}/${FRAMEWORK}/lastSuccessful/archive/dist/${FRAMEWORK}.tar.gz)
60 + fi
61 +done
62 +
63 +# Setup wolips.properties
64 +cat >> ${ROOT}/wolips.properties << END
65 +wo.system.root=${ROOT}/System
66 +wo.user.frameworks=${ROOT}/User/Library/Frameworks
67 +wo.system.frameworks=${ROOT}/System/Library/Frameworks
68 +wo.bootstrapjar=${ROOT}/System/Library/WebObjects/JavaApplications/wotaskd.woa/WOBootstrap.jar
69 +wo.network.frameworks=${ROOT}/Network/Library/Frameworks
70 +wo.api.root=/Developer/ADC%20Reference%20Library/documentation/WebObjects/Reference/API/
71 +wo.network.root=${ROOT}/Network
72 +wo.extensions=${ROOT}/Library/WebObjects/Extensions
73 +wo.user.root=${ROOT}/User
74 +wo.local.frameworks=${ROOT}/Library/Frameworks
75 +wo.apps.root=${ROOT}/Library/WebObjects/Applications
76 +wo.local.root=${ROOT}
77 +END
78 +