First Run


This tutorial will take you from zero to running your first buildbot master and slave as quickly as possible, without changing the default configuration.

This tutorial is all about instant gratification and the five minute experience: in five minutes we want to convince you that this project Works, and that you should seriously consider spending some more time learning the system. In this tutorial no configuration or code changes are done.

This tutorial assumes that you are running on Unix, but might be adaptable easily to Windows.

For the quickest way through, you should be able to cut and paste each shell block from this tutorial directly into a terminal.

Getting the code

There are many ways to get the code on your machine. For this tutorial, we will use easy_install to install and run buildbot. While this isn’t the preferred method to install buildbot, it is the simplest one to use for the purposes of this tutorial because it should work on all systems. (The preferred method would be to install buildbot from packages of your distribution.)

To make this work, you will need the following installed:

Preferably, use your package installer to install these.

You will also need a working Internet connection, as virtualenv and easy_install will need to download other projects from the Internet.

Let’s dive in by typing at the terminal:

mkdir -p tmp/buildbot
cd tmp/buildbot
virtualenv --no-site-packages sandbox
source sandbox/bin/activate
easy_install buildbot

Creating a master

At the terminal, type:

cd sandbox
buildbot create-master master
mv master/master.cfg.sample master/master.cfg
touch $VIRTUAL_ENV/master/twistd.log


Now start it:

buildbot start $VIRTUAL_ENV/master
tail -f $VIRTUAL_ENV/twistd.log

You will now see all of the log information from the master in this terminal. You should see lines like this:

2009-07-29 21:01:46+0200 [-] twisted.spread.pb.PBServerFactory starting on 9989
2009-07-29 21:01:46+0200 [-] Starting factory <twisted.spread.pb.PBServerFactory instance at 0x1fc8ab8>
2009-07-29 21:01:46+0200 [-] BuildMaster listening on port tcp:9989
2009-07-29 21:01:46+0200 [-] configuration update started
2009-07-29 21:01:46+0200 [-] configuration update complete

Creating a slave

Open a new terminal, and first enter the same sandbox you created before:

cd tmp/buildbot
source sandbox/bin/activate

Now, create the slave:

buildbot create-slave slave localhost:9989 bot1name bot1passwd

The user:host pair, username, and password should be the same as the ones in master.cfg; please verify this is the case.

Now, start the slave:

touch $VIRTUAL_ENV/slave/twistd.log
buildbot start $VIRTUAL_ENV/slave
tail -f $VIRTUAL_ENV/slave/twistd.log

You should see lines like the following at the end of the worker log:

2009-07-29 20:59:18+0200 [Broker,client] message from master: attached
2009-07-29 20:59:18+0200 [Broker,client] SlaveBuilder.remote_print(buildbot-full): message from master: attached
2009-07-29 20:59:18+0200 [Broker,client] sending application-level keepalives every 600 seconds

Meanwhile, in the manager log, you should see lines like this:

2009-07-29 20:59:18+0200 [Broker,6,] Got slaveinfo from 'bot1name'
2009-07-29 20:59:18+0200 [Broker,6,] bot attached
2009-07-29 20:59:18+0200 [Broker,6,] <BuildSlave 'bot1name', current builders: buildbot-full> adding <SlaveBuilder builder=buildbot-full slave=bot1name>
2009-07-29 20:59:18+0200 [Broker,6,] Buildslave bot1name attached to buildbot-full

You should now be able to go to http://localhost:8010, where you will see a web page similar to:

index page

Click on the Waterfall Display link and you get this:

empty waterfall.

That’s the end of the first tutorial. A bit underwhelming, you say ? Well, that was the point! We just wanted to get you to dip your toes in the water. It’s easy to take your first steps, but this is about as far as we can go without touching the configuration.

You’ve got a taste now, but you’re probably curious for more. Let’s step it up a little in the second tutorial by changing the configuration and doing an actual build.

[1]BuildBot is a project that has switched VCS more than any other the author knows. It has been kept in CVS, arch, darcs, and git. The current VCS used is git, but please contact the author if you find the URL or VCS has changed again.
[2]The touch line is to avoid a bug the first time a master or slave is run. See to track the status, and pleae contact the author when this ticket is fixed.
[3]Contact the author at <thomas at apestaart dot org>