(no commit message)
[openafs-wiki.git] / AFSLore / BuildbotSlaveHowto.mdwn
index ea2e365..866aac5 100644 (file)
@@ -26,6 +26,7 @@ A quick overview of the process:
 
 1. Acquire suitable system
 1. Install required software
+1. Compile OpenAFS from git
 1. Create buildbot account and home directory
 1. Contact OpenAFS BuildBot admin for configuration details
 1. Edit configuration files
@@ -53,12 +54,27 @@ test multiple commits.
 
 _Software Requirements_
 
-You will need recent versions of the following pieces of software installed:
+BuildBot has the following software dependencies:
 
-* Python 
-* Twisted
-* ZopeInterface
-* Git
+* Python: [[http://www.python.org/]]
+* Twisted: [[http://twistedmatrix.com/]]
+* ZopeInterface: [[http://www.zope.org/Products/ZopeInterface]]
+* Git: [[http://git-scm.com/]]
+
+Links to the above software websites are provided for reference only -- you may very well have a more
+convenient method for installing software on your platform than downloading the source, building,
+and installing by hand.  Check public software repositories for your platform first to save yourself some
+effort.  BuildBot is not particularly sensitive to dependency versioning, so you may not need the
+absolute latest version of everything installed.  (For instance, BuildBot 0.7.12 is known to work with Python 2.5.2,
+Git 1.6.6, ZopeInterface 3.3.0, Twisted 9.0.0.)
+
+And, of course, you'll need to install BuildBot itself: [[http://buildbot.net/trac]]
+
+
+_Compile OpenAFS from git_
+
+Use git to clone the openafs repo, then make sure the software will compile successfully. For Unix platforms, the typical build process is 
+"sh regen.sh && ./configure && make && make dest"
 
 _Create buildbot account and home directory_
 
@@ -72,7 +88,7 @@ installation issues): /path/to/buildbot
 
 _Contact OpenAFS BuildBot Master admin for configuration details_
 
-Check the openafs-devel list archives (or join and ask) for who to contact regarding the settings you'll
+Contact jason at rampaginggeek.com regarding the settings you'll
 need to add your machine as an OpenAFS build slave.  These settings will include:
 
 * buildmaster_host: this is the OpenAFS build master
@@ -92,6 +108,7 @@ Substituting the appropriate values from above, the execute:
 /path/to/buildbot create-slave /home/buildbot/slave1 buildmaster_host:port slavename passwd
 
 Check the configuration file /home/buildbot/slave1/buildbot.tac to make sure the settings you entered are reflected in it.
+Make sure that "usepty" is set to "0". "usepty = 1" it is known to fail on at least one architecture.
 
 *Optional, but recommended:* Edit the /home/buildbot/slave1/info/{admin,host} files to describe the system (in host) and send
 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
@@ -108,7 +125,7 @@ Check the logs to make sure it started properly.  Check the OpenAFS BuildBot web
 graphically.
 
 There may be some kinks to work out of the system with the first few builds, especially if you are contributing a slave system
-for a less-heavily-used platform whose support might suffer from bit rot between releases (hey, it happens!).
+for a less-heavily-used platform whose support might suffer from bit rot between releases (hey, it happens!).  
 
 _Set up startup scripts_
 
@@ -120,5 +137,7 @@ The buildbot.tac configuration file can be used to optimize your build slave.  F
 so you don't end up with a bunch of logs littered about /home/buildbot/slave1/.  Have a look at the BuildBot documentation if
 you wish, though you can expect to be able to take a fairly hands-off approach to administering your new OpenAFS build slave.
 
+Link to current BuildBot documentation: [[http://buildbot.net/buildbot/docs/current/]]
+
 Thanks for your help!