1
2BUILDBOT-WORKER(1)               User Commands              BUILDBOT-WORKER(1)
3
4
5

NAME

7       buildbot-worker - a tool for managing buildbot worker instances
8

SYNOPSIS

10       buildbot-worker [ global options ] command [ command options ]
11
12       buildbot-worker   create-worker   [  -q|--quiet  ]  [  -f|--force  ]  [
13       -r|--relocatable ] [ -n|--no-logrotate ]  [  -k|--keepalive  TIME  ]  [
14       --usepty  {0|1}  ] [ --umask UMASK ] [ -s|--log-size SIZE ] [ -l|--log-
15       count COUNT ] [ --delete-leftover-dirs ]  [  --verbose  ]  PATH  MASTER
16       USERNAME PASSWORD
17
18       buildbot-worker [ --verbose ] { start|stop|restart } [ PATH ]
19
20       buildbot-worker [ --verbose ] { --help|--version }
21
22       buildbot-worker command -h|--help
23

DESCRIPTION

25       The  `buildbot-worker' command-line tool can be used to start or stop a
26       Buildbot worker or create a new worker instance.
27

OPTIONS

29   Commands
30       create-worker
31              Create and populate a directory for a new worker
32
33       start  Start a worker
34
35       stop   Stop a worker
36
37       restart
38              Restart a worker
39
40   Global options
41       -h|--help
42              Print the list of available commands and  global  options.   All
43              subsequent commands are ignored.
44
45       --version
46              Print  twistd  and buildbot-worker version.  All subsequent com‐
47              mands are ignored.
48
49       --verbose
50              Verbose output.
51
52   create-worker command options
53       -f|--force
54              Re-use an existing directory.
55
56       -h|--help
57              Show help for current command and exit.  All subsequent commands
58              are ignored.
59
60       -k|--keepalive
61              Send  keepalive  requests  to  buildmaster  every  TIME seconds.
62              Default value is 600 seconds.
63
64       -l|--log-count
65              Limit the number of kept old twisted log files  to  COUNT.   All
66              files are kept by default.
67
68       -q|--quiet
69              Do not emit the commands being run.
70
71       -r|--relocatable
72              Create a relocatable buildbot.tac.
73
74       -n|--no-logrotate
75              Do not permit worker rotate logs by itself.
76
77       -s|--log-size
78              Set  size  at  which  twisted lof file is rotated to SIZE bytes.
79              Default value is 1000000 bytes.
80
81       --umask
82              Set umask for files created by worker.   Default  value  is  077
83              which  means  only owner can access the files.  See umask(2) for
84              more details.
85
86       --usepty
87              Set whether child processes should be run in a pty (0  means  do
88              not run in a pty).  Default value is 0.
89
90       --delete-leftover-dirs
91              Set to remove unexpected directories in worker base directory.
92
93       PATH   Path to worker base directory.
94
95       MASTER Set  the  host  and port of buildbot master to attach to in form
96              HOST:PORT.  This should be provided by  buildmaster  administra‐
97              tor.
98
99       USERNAME
100              Worker  name to connect with.  This should be provided by build‐
101              master administrator.
102
103       PASSWORD
104              Worker password to connect with.  This  should  be  provided  by
105              buildmaster administrator.
106

SEE ALSO

108       buildbot(1), umask(2),
109
110
111
112Buildbot                          August 2010               BUILDBOT-WORKER(1)
Impressum