@@ -60,13 +60,15 @@ Setting up the buildbot worker
6060Conventional always-on machines
6161-------------------------------
6262
63- You need a recent version of the `buildbot <https://buildbot.net/ >`__ software,
64- and you will probably want a separate 'buildbot' user to run the buildbot
65- software. You may also want to set the buildbot up using a virtual
66- environment, depending on how you manage your system. We won't cover how to that
67- here; it doesn't differ from setting up a virtual environment for any other
68- software, but you'll need to modify the sequence of steps below as appropriate
69- if you choose that path.
63+ You need a recent version of the `buildbot <https://buildbot.net/ >`__ worker
64+ software. On most platforms the distribution's package manager provides the
65+ ``buildbot-worker `` package, which also creates a dedicated service account,
66+ systemd unit (or equivalent), and the necessary directories. For platforms
67+ where no package exists, ``pip install buildbot-worker `` is the fallback, but
68+ you will need to create the service account, directories, and service unit
69+ manually. You may also want to set the buildbot up using a virtual
70+ environment, depending on how you manage your system; you'll need to adjust
71+ the steps below as appropriate if you choose that path.
7072
7173.. tab :: Linux
7274
@@ -132,11 +134,18 @@ if you choose that path.
132134 buildbot-worker create-worker buildarea buildbot-api.python.org:9020 workername workerpasswd
133135
134136
135- Once this initial worker setup completes, you should edit the files
136- ``buildarea/info/admin `` and ``buildarea/info/host `` to provide your contact
137- info and information on the host configuration, respectively. This information
138- will be presented in the buildbot web pages that display information about the
139- builders running on your worker.
137+ The ``info/admin `` file in the worker directory should contain your contact
138+ information, and ``info/host `` should describe the host configuration. This
139+ information is displayed on the buildbot web interface. Since these pages are
140+ publicly visible, consider obfuscating your email address (for example,
141+ ``user AT example.com ``) to avoid spam from web scrapers.
142+
143+ The recommended ``buildbot.tac `` settings are:
144+
145+ * ``keepalive = 60 `` -- the buildmaster uses a 60-second keepalive interval;
146+ the default of ``600 `` is too high and can cause spurious disconnections.
147+ * ``delete_leftover_dirs = 1 `` -- automatically cleans up build directories
148+ that the master no longer needs.
140149
141150You will also want to make sure that the worker is started when the
142151machine reboots:
@@ -289,14 +298,6 @@ by tests that fail. Unfortunately we do not currently have a way to notify you
289298only of failures on your builders, so doing periodic spot checks is also a good
290299idea.
291300
292- .. note ::
293- The buildmaster uses a ``keepalive `` interval of ``60 `` seconds. Ensure
294- the ``keepalive `` setting in your ``buildbot.tac `` matches (the default
295- of ``600 `` is too high and can cause spurious disconnections). It is
296- also recommended to set ``delete_leftover_dirs = 1 `` so that build
297- directories the master no longer needs are cleaned up automatically.
298-
299-
300301Latent workers
301302--------------
302303
0 commit comments