.\" Generated by scdoc 1.11.0
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "buildbot-worker" "7" "2021-02-01" "" "Services Administration"
.P
.SH NAME
.P
buildbot-worker - worker instances creation, upgrade and management
.P
.SH DESCRIPTION
.P
Buildbot worker instances are located under individual folders in
\fI/var/lib/buildbot/workers\fR. This manual explains how to manage them.
.P
.SH CREATION
.P
To create a new Buildbot worker instance named \fI$NAME\fR, use the following
commands:
.P
.nf
.RS 4
buildbot-worker create-worker \\
	/var/lib/buildbot/workers/$NAME <master> <name> <passwd>
chown -R buildbot: /var/lib/buildbot/workers/$NAME
.fi
.RE
.P
After which you may start the worker instance. Depending on the init system you
use, this is done differently.
.P
.SS systemd
.P
To start the instance:
.P
.nf
.RS 4
systemctl start buildbot-worker@$NAME\&.service
.fi
.RE
.P
To enable automatic start on boot:
.P
.nf
.RS 4
systemctl enable buildbot-worker@$NAME\&.service
.fi
.RE
.P
If you want to tune the way the instance is started (e.g., to change the user
that runs the process), you may use a systemd drop-in:
.P
.nf
.RS 4
mkdir -p /etc/systemd/system/buildbot-worker@$NAME\&.service\&.d
editor /etc/systemd/system/buildbot-worker@$NAME\&.service\&.d/user\&.conf
.fi
.RE
.P
With the following contents:
.P
.nf
.RS 4
[Service]
User=my-user
Group=my-group
.fi
.RE
.P
.SS sysvinit
.P
First, you need to edit \fI/etc/default/buildbot-worker\fR and configure your
instance. The syntax is pretty self explanatory, but here is an example:
.P
.nf
.RS 4
# 1-enabled, 0-disabled
WORKER_ENABLED[1]=1
# short name printed on start/stop
WORKER_NAME[1]="$NAME"
# user to run worker as
WORKER_USER[1]="buildbot"
# basedir to worker (absolute path)
WORKER_BASEDIR[1]="/var/lib/buildbot/workers/$NAME"
# buildbot-worker options
WORKER_OPTIONS[1]=""
# prefix command, i\&.e\&. nice, linux32, dchroot
WORKER_PREFIXCMD[1]=""
.fi
.RE
.P
After which, you may start the instance:
.P
.nf
.RS 4
service buildbot-worker start $NAME
.fi
.RE
.P
By default, it will automatically start on boot.
.P
.SH UPGRADE
.P
When installing new versions, each worker instance is automatically restarted.
No additional action is required.
.P
.SS upgrade from 0.8.x
.P
Since version 0.9.0 of Buildbot "slave"-based terminology is deprecated in
favor of "worker"-based terminology.
.P
If you are upgrading from a 0.8.x version, all old buildbot-slave instances in
\fI/var/lib/buildbot/slaves\fR must be manually migrated. The simplest way of doing
that is to create new workers re-using the same \fI<master>\fR, \fI<name>\fR and
\fI<passwd>\fR arguments. See the \fBCREATION\fR section of this manual for more
details.
.P
Once migrated, you may safely delete the old "slave" directory:
.P
.nf
.RS 4
rm -rf /var/lib/buildbot/slaves/$NAME
.fi
.RE
.P
.SH FILES
.P
\fI/var/lib/buildbot/workers/$NAME\fR
.RS 4
Working directory for the \fI$NAME\fR Buildbot worker instance.
.P
.RE
\fI/etc/systemd/system/buildbot-worker@$NAME.service.d\fR
.RS 4
Directory containing customization drop-ins for the \fI$NAME\fR Buildbot
worker instance service.
.P
.RE
\fI/etc/default/buildbot-worker\fR
.RS 4
The worker instances services definition for sysvinit users.
.P
.RE
.SH SEE ALSO
.P
\fBbuildbot-worker\fR(1), \fBsystemctl\fR(1), \fBsystemd.unit\fR(5), \fBservice\fR(8)
.P
.P
.SH AUTHOR
.P
Robin Jarry <robin@jarry.cc>