1===================================================================
2How To Add Your Build Configuration To LLVM Buildbot Infrastructure
3===================================================================
4
5Introduction
6============
7
8This document contains information about adding a build configuration and
9buildslave to private slave builder to LLVM Buildbot Infrastructure.
10
11Buildmasters
12============
13
14There are two buildmasters running.
15
16* The main buildmaster at `<http://lab.llvm.org:8011>`_. All builders attached
17  to this machine will notify commit authors every time they break the build.
18* The staging buildbot at `<http://lab.llvm.org:8014>`_. All builders attached
19  to this machine will be completely silent by default when the build is broken.
20  Builders for experimental backends should generally be attached to this
21  buildmaster.
22
23Steps To Add Builder To LLVM Buildbot
24=====================================
25Volunteers can provide their build machines to work as build slaves to
26public LLVM Buildbot.
27
28Here are the steps you can follow to do so:
29
30#. Check the existing build configurations to make sure the one you are
31   interested in is not covered yet or gets built on your computer much
32   faster than on the existing one. We prefer faster builds so developers
33   will get feedback sooner after changes get committed.
34
35#. The computer you will be registering with the LLVM buildbot
36   infrastructure should have all dependencies installed and you can
37   actually build your configuration successfully. Please check what degree
38   of parallelism (-j param) would give the fastest build.  You can build
39   multiple configurations on one computer.
40
41#. Install buildslave (currently we are using buildbot version 0.8.5).
42   Depending on the platform, buildslave could be available to download and
43   install with your package manager, or you can download it directly from
44   `<http://trac.buildbot.net>`_ and install it manually.
45
46#. Create a designated user account, your buildslave will be running under,
47   and set appropriate permissions.
48
49#. Choose the buildslave root directory (all builds will be placed under
50   it), buildslave access name and password the build master will be using
51   to authenticate your buildslave.
52
53#. Create a buildslave in context of that buildslave account.  Point it to
54   the **lab.llvm.org** port **9990** (see `Buildbot documentation,
55   Creating a slave
56   <http://docs.buildbot.net/current/tutorial/firstrun.html#creating-a-slave>`_
57   for more details) by running the following command:
58
59    .. code-block:: bash
60
61       $ buildslave create-slave <buildslave-root-directory> \
62                    lab.llvm.org:9990 \
63                    <buildslave-access-name> <buildslave-access-password>
64
65#. Fill the buildslave description and admin name/e-mail.  Here is an
66   example of the buildslave description::
67
68       Windows 7 x64
69       Core i7 (2.66GHz), 16GB of RAM
70
71       g++.exe (TDM-1 mingw32) 4.4.0
72       GNU Binutils 2.19.1
73       cmake version 2.8.4
74       Microsoft(R) 32-bit C/C++ Optimizing Compiler Version 16.00.40219.01 for 80x86
75
76#. Make sure you can actually start the buildslave successfully. Then set
77   up your buildslave to start automatically at the start up time.  See the
78   buildbot documentation for help.  You may want to restart your computer
79   to see if it works.
80
81#. Send a patch which adds your build slave and your builder to zorg.
82
83   * slaves are added to ``buildbot/osuosl/master/config/slaves.py``
84   * builders are added to ``buildbot/osuosl/master/config/builders.py``
85
86   It is possible to whitelist email addresses to unconditionally receive notifications
87   on build failure; for this you'll need to add an ``InformativeMailNotifier`` to
88   ``buildbot/osuosl/master/config/status.py``. This is particularly useful for the
89   staging buildmaster which is silent otherwise.
90
91#. Send the buildslave access name and the access password directly to
92   `Galina Kistanova <mailto:[email protected]>`_, and wait till she
93   will let you know that your changes are applied and buildmaster is
94   reconfigured.
95
96#. Check the status of your buildslave on the `Waterfall Display
97   <http://lab.llvm.org:8011/waterfall>`_ to make sure it is connected, and
98   ``http://lab.llvm.org:8011/buildslaves/<your-buildslave-name>`` to see
99   if administrator contact and slave information are correct.
100
101#. Wait for the first build to succeed and enjoy.
102