db0c1335a211abcecb7ce31cde5c3e1713ea8322
[openafs-wiki.git] / BuildbotSlaveHowto.mdwn
1 *How to set up a BuildBot Slave for OpenAFS*
2
3 _Rationale_
4
5 Why would I want to?  OpenAFS supports multiple platforms, but the strength of support for
6 each of those individual platforms is directly proportional to the amount of testing done thereon.
7 Although there are many different types of testing that can be done, one of the most basic is
8 that of changes to the code base.  A BuildBot slave allows for automated testing of each gerrit
9 commit and is therefore a great resource to developers, most of whom do not have the time or
10 resources to test their code on every platform prior to submission.  Therefore, we encourage you
11 to contribute a system as a build slave for a platform not already covered!  You know you want to!
12
13 _Approach_
14
15 This is a consumer-oriented, high-level "how-to" to (hopefully) show how simple it is to set up
16 your own build slave (and thereby contribute to OpenAFS!).  This document is not intended to be
17 platform-specific -- there are just too many different ways of doing things across
18 Linux/Windows/SunOS/IRIX/AIX/BSD etc.  There are additional notes elsewhere on this Wiki 
19 (see: [[BuildbotMasterNotes]]) about setting up the BuildBot Master, and some of this material
20 is covered there as well -- however, this page is an attempt to make the process more understandable
21 (specifically the buildslave setup).
22 [Sewa Mobil Jakarta](http://www.awanirentcar.com), [Vertical Blind Jakarta](http://www.tiraimodern.com/product/vertical-blind), [GPS Tracking](http://vamostech.com/gps-tracking), [Atap Fiberglass](http://www.goldenfibreglass.com/product-atap-fiberglass.php), [Rental Mobil Jakarta](http://griyamobilkita.webs.com)
23
24 _Overview_
25
26 A quick overview of the process:
27
28 1. Acquire suitable system
29 1. Install required software
30 1. Compile OpenAFS from git
31 1. Create buildbot account and home directory
32 1. Contact OpenAFS BuildBot admin for configuration details
33 1. Edit configuration files
34 1. Start build slave
35 1. Set up startup scripts
36 1. Optional configuration
37
38 *Of note:* since BuildBot slaves pull all their information from the master (rather than having it pushed
39 to them by the master), there is no need to open an incoming port on your firewall, etc.  As long as the
40 slave can contact the master on the port you're given (which will be explained later), you're good to go!
41
42 _Hardware Requirements_
43
44 * Any system which OpenAFS currently supports (the greater diversity of build slaves, the better)
45 * Enough free disk space to build OpenAFS tree (a couple gigabytes should do)
46
47 The machine does not necessarily need to be dedicated entirely to being a buildslave; a build slave
48 could run on any lightly-loaded, non-critical system (subject to your security requirements, etc.,
49 of course).  Some of the OpenAFS buildslaves are run by volunteers at their own homes, for instance.
50
51 If you happen to have an older system with multiple processors, you can run more than one build slave
52 instance on the same machine.  The workload will be distributed across them by the master: successive
53 gerrit commit builds are started on the next free instance, thus reducing the overall time to
54 test multiple commits.
55
56 _Software Requirements_
57
58 BuildBot has the following software dependencies:
59
60 * Python: [[http://www.python.org/]]
61 * Twisted: [[http://twistedmatrix.com/]]
62 * ZopeInterface: [[http://www.zope.org/Products/ZopeInterface]]
63 * Git: [[http://git-scm.com/]]
64
65 Links to the above software websites are provided for reference only -- you may very well have a more
66 convenient method for installing software on your platform than downloading the source, building,
67 and installing by hand.  Check public software repositories for your platform first to save yourself some
68 effort.  BuildBot is not particularly sensitive to dependency versioning, so you may not need the
69 absolute latest version of everything installed.  (For instance, BuildBot 0.7.12 is known to work with Python 2.5.2,
70 Git 1.7.9, ZopeInterface 3.3.0, Twisted 9.0.0.)
71
72 Git version 1.7.9 or above is required.   The "git clean -e" option must be present and the
73 "git clean -X -e excluded-file" behavior must be correct.
74
75 And, of course, you'll need to install BuildBot itself: [[http://buildbot.net/trac]]
76
77
78 _Compile OpenAFS from git_
79
80 Use git to clone the openafs repo, then make sure the software will compile successfully. For Unix platforms, the typical build process is 
81 "sh regen.sh && ./configure && make && make dest"
82
83 _Create buildbot account and home directory_
84
85 It is recommended that you use a special-purpose non-priviledged user account to run the build slave
86 (i.e., "buildbot").  The build master does not need to know the account's password -- in fact, the
87 account does not necessarily need remote login priviledges and may be locked or otherwise secured
88 as long as your platform still allows you to run commands as that user.
89
90 Test that you can run the buildbot command successfully (without error messages that might indicate
91 installation issues): /path/to/buildbot
92
93 _Contact OpenAFS BuildBot Master admin for configuration details_
94
95 Contact jason at rampaginggeek.com regarding the settings you'll
96 need to add your machine as an OpenAFS build slave.  These settings will include:
97
98 * buildmaster_host: this is the OpenAFS build master
99 * port: this is the port on the build master which your slave will talk to
100 * slavename: a unique descriptive name for your new build slave, usually representing your operating system and architecture (and not necessarily anything to do with your systems' hostname)
101 * passwd: a password assigned to your slave for use in connecting with the master
102
103 _Create your build slave configuration_
104
105 As your buildbot user:
106
107 Inside the user's home directory (say, /home/buildbot), create a subdirectory which will contain all of the buildslave files (say, /home/buildbot/slave1).
108 Buildbot will not touch anything outside of this directory.
109
110 Substituting the appropriate values from above, the execute:
111
112 /path/to/buildbot create-slave /home/buildbot/slave1 buildmaster_host:port slavename passwd
113
114 Check the configuration file /home/buildbot/slave1/buildbot.tac to make sure the settings you entered are reflected in it.
115 Make sure that "usepty" is set to "0". "usepty = 1" it is known to fail on at least one architecture.
116
117 *Optional, but recommended:* Edit the /home/buildbot/slave1/info/{admin,host} files to describe the system (in host) and send
118 yourself a shout-out (tell who you are in admin).  These show up on the web if you drill down to the build slave information
119 on the OpenAFS buildbot web portal, so you may want to obfuscate your contact information.
120
121 *Note:* if you are planning on running multiple OpenAFS buildslave instances, you simply repeat this and all later steps,
122 specifying a different base directory (i.e., /home/buildbot/slave2, /home/buildbot/slave3, etc.)
123
124 _Start build slave_
125
126 /path/to/buildbot start
127
128 Check the logs to make sure it started properly.  Check the OpenAFS BuildBot web portal to see the build progress presented
129 graphically.
130
131 There may be some kinks to work out of the system with the first few builds, especially if you are contributing a slave system
132 for a less-heavily-used platform whose support might suffer from bit rot between releases (hey, it happens!).  
133
134 _Set up startup scripts_
135
136 Self-explanatory.  Make sure they run /path/to/buildbot start as your buildbot user.
137
138 _Set up log rotation and various other useful settings_
139
140 The buildbot.tac configuration file can be used to optimize your build slave.  For instance, you may want to change maxRotatedFiles
141 so you don't end up with a bunch of logs littered about /home/buildbot/slave1/.  Have a look at the BuildBot documentation if
142 you wish, though you can expect to be able to take a fairly hands-off approach to administering your new OpenAFS build slave.
143
144 Link to current BuildBot documentation: [[http://buildbot.net/buildbot/docs/current/]]
145
146 Thanks for your help!