Buildmaster Setup
=================

.. _Creating-a-buildmaster:

Creating a buildmaster
----------------------

As you learned earlier (:ref:`System-Architecture`), the buildmaster runs on a central host (usually
one that is publicly visible, so everybody can check on the status of the project), and controls all
aspects of the buildbot system

You will probably wish to create a separate user account for the buildmaster, perhaps named
``buildmaster``. Do not run the buildmaster as ``root``!

You need to choose a directory for the buildmaster, called the ``basedir``.
This directory will be owned by the buildmaster.
It will contain the configuration, database, and status information - including logfiles.
On a large buildmaster this directory will see a lot of activity, so it should be on a disk with
adequate space and speed.

Once you've picked a directory, use the ``buildbot create-master`` command to create the directory
and populate it with startup files:

.. code-block:: bash

    buildbot create-master -r basedir

You will need to create a :ref:`configuration file <Configuration>` before starting the buildmaster.
Most of the rest of this manual is dedicated to explaining how to do this.
A sample configuration file is placed in the working directory, named :file:`master.cfg.sample`,
which can be copied to :file:`master.cfg` and edited to suit your purposes.

(Internal details: This command creates a file named :file:`buildbot.tac` that contains all the
state necessary to create the buildmaster.
Twisted has a tool called ``twistd`` which can use this .tac file to create and launch a buildmaster
instance. Twistd takes care of logging and daemonization (running the program in the background).
:file:`/usr/bin/buildbot` is a front end which runs `twistd` for you.)

Your master will need a database to store the various information about your builds, and its
configuration. By default, the ``sqlite3`` backend will be used.
This needs no configuration, neither extra software.
All information will be stored in the file :file:`state.sqlite`.
Buildbot however supports multiple backends.
See :ref:`Database-Server` for more options.

Buildmaster Options
~~~~~~~~~~~~~~~~~~~

This section lists options to the ``create-master`` command.
You can also type ``buildbot create-master --help`` for an up-to-the-moment summary.

.. program:: buildbot create-master

.. option:: --force

    This option will allow to re-use an existing directory.

.. option:: --no-logrotate

    This disables internal worker log management mechanism.
    With this option worker does not override the default logfile name and its behaviour giving a
    possibility to control those with command-line options of twistd daemon.

.. option:: --relocatable

    This creates a "relocatable" ``buildbot.tac``, which uses relative paths instead of absolute
    paths, so that the buildmaster directory can be moved about.

.. option:: --config

    The name of the configuration file to use.
    This configuration file need not reside in the buildmaster directory.

.. option:: --log-size

    This is the size in bytes when exceeded to rotate the Twisted log files.
    The default is 10MiB.

.. option:: --log-count

    This is the number of log rotations to keep around.
    You can either specify a number or ``None`` to keep all :file:`twistd.log` files around.
    The default is 10.

.. option:: --db

    The database that the Buildmaster should use.
    Note that the same value must be added to the configuration file.
