Mercurial > hg > autobot
diff README.txt @ 204:5f188d2a36aa
write how the .ini files work
author | Jeff Hammel <jhammel@mozilla.com> |
---|---|
date | Wed, 02 Feb 2011 18:17:07 -0800 |
parents | bba97450cbc2 |
children | 3e5d1c1e302d |
line wrap: on
line diff
--- a/README.txt Wed Feb 02 17:44:03 2011 -0800 +++ b/README.txt Wed Feb 02 18:17:07 2011 -0800 @@ -59,10 +59,98 @@ set) remove the log as well. The generated ``master.cfg`` file reads values from an ``master.ini`` -file in the same directory +file in the same directory. The master.ini contains a number of +different sections: + +* ``[:master:]`` contains the top level configuration for the master + as well as default settings for slaves +* sections like ``[slave:slavename]`` indicate a slave of name + ``slavename`` +* other sections are construction parameters for factories + +The format of the ``.ini`` file is detailed in the subsequent +section. You may change the .ini file used by editing the +``master.cfg`` file, or, if for whatever reason you don't want to use +an .ini file you can construct the appropriate configuration therein +yourself. + +An overview of the build status is detailed at the waterfall display, +by default at http://localhost:8010/waterfall . To force a build, +click on the desired builder and there will be a force build button +towards the bottom. It is important to remember that continuous integration is a safety -net, not a first line of defense. +net, not a first line of defense. In other words, continue to check your code +*before* sending it to autobot. + +.ini file format +---------------- + +As stated above, a ``master.ini`` file contains three different kinds +of sections: + +* ``[:master:]`` contains the top level configuration for the master + as well as default settings for slaves +* sections like ``[slave:slavename]`` indicate a slave of name + ``slavename`` +* other sections are construction parameters for factories + +What goes in each of these? + +``:master:`` The master section contains parameters appropriate to the +buildmaster: + +* slaveport: which port to listen for the slaves on +* htmlport: which port to serve the waterfall display on +* pollInterval: how often to poll the repositories, in seconds [DEFAULT: 60] +* treeStable: how long to wait before the tree settles down before + building [DEFAULT: 60] + +The other defaults may be seen by running ``create-autobot-master --help``. + +Other parameters given in the ``[:master:]`` section are used as the +baseline defaults for each slave. They may be overridden in each +``slave:`` section + +---- + +``slave:`` parameters for each slave: + +* password: each slave *must* have a password. Unless there's a + reason to have a password per slave, its probably better to put this + in the ``:master:`` section + +* factories: space-separated list of factories to run on that slave. + If the special value ``*`` is used, all factories will be run. You + can view the factories available with + ``create-autobot --list-factories``. The factory name corresponds to + the directory (or module) name in ``autobot.projects``. + +* os: the operating system of the slave. Should be one of linux, win, + or mac (though see TODO about future use of MozInfo making this + obselescent). You probably *shouldn't* have a default key for this + in the ``:master:`` section (though autobot won't try to stop you!). + +---- + +factory sections: Each parameter in a factory section is used as a +constructor (``__init__``) keyword argument when they are created in +the ``master.cfg``. So a factory section like:: + + [foo] + bar = fleem + baz = another parameter + +will invoke the foo factory (lets say it maps to ``MyFooFactory``) on +each slave like:: + + MyFooFactory(**dict(bar='fleem', baz='another parameter')) + +In addition, if a factory has a special key, ``platform``, the slave +will pass its platform information when instantiating a factory. +Currently, this is a dict with a single key, ``os``, but more may be +added as needed. As noted in the TODO below, ideally this would be +deprecated entirely by MozInfo but such is the interim solution. Projects @@ -98,6 +186,7 @@ jhammel@mozilla.com + TODO ---- @@ -109,4 +198,6 @@ branch pair. It is then updated as the slaves need and (e.g.) cloned from there. This should effectively minimize fetch time. -* slaves should have .ini files indicated by the config +* use (as yet non-existent) MozInfo package on the slave: instead of + specifying the operating system, etc on the master, MozInfo should + determine the applicable information from introspection