If you set
c['debugPassword'], then you can connect to the
buildmaster with the diagnostic tool launched by
debugclient MASTER:PORT. From this tool, you can reload the config
file, manually force builds, and inject changes, which may be useful
for testing your buildmaster without actually commiting changes to
your repository (or before you have the Change Sources set up). The
debug tool uses the same port number as the slaves do:
c['slavePortnum'], and is authenticated with this password.
c['debugPassword'] = "debugpassword"
If you set
c['manhole'] to an instance of one of the classes in
buildbot.manhole, you can telnet or ssh into the buildmaster
and get an interactive Python shell, which may be useful for debugging
buildbot internals. It is probably only useful for buildbot
developers. It exposes full access to the buildmaster's account
(including the ability to modify and delete files), so it should not
be enabled with a weak or easily guessable password.
There are three separate
Manhole classes. Two of them use SSH,
one uses unencrypted telnet. Two of them use a username+password
combination to grant access, one of them uses an SSH-style
authorized_keys file which contains a list of ssh public keys.
Note that using any Manhole requires that
installed. These are not part of the normal Buildbot dependencies.
# some examples: from buildbot import manhole c['manhole'] = manhole.AuthorizedKeysManhole(1234, "authorized_keys") c['manhole'] = manhole.PasswordManhole(1234, "alice", "mysecretpassword") c['manhole'] = manhole.TelnetManhole(1234, "bob", "snoop_my_password_please")
Manhole instance can be configured to listen on a specific
port. You may wish to have this listening port bind to the loopback
interface (sometimes known as “lo0”, “localhost”, or 127.0.0.1) to
restrict access to clients which are running on the same host.
from buildbot.manhole import PasswordManhole c['manhole'] = PasswordManhole("tcp:9999:interface=127.0.0.1","admin","passwd")
To have the
Manhole listen on all interfaces, use
"tcp:9999" or simply 9999. This port specification uses
twisted.application.strports, so you can make it listen on SSL
or even UNIX-domain sockets if you want.
The buildmaster's SSH server will use a different host key than the normal sshd running on a typical unix host. This will cause the ssh client to complain about a “host key mismatch”, because it does not realize there are two separate servers running on the same host. To avoid this, use a clause like the following in your .ssh/config file:
Host remotehost-buildbot HostName remotehost HostKeyAlias remotehost-buildbot Port 9999 # use 'user' if you use PasswordManhole and your name is not 'admin'. # if you use AuthorizedKeysManhole, this probably doesn't matter. User admin
After you have connected to a manhole instance, you will find yourself at a
Python prompt. You have access to two objects:
master (the BuildMaster)
status (the master's Status object). Most interesting objects on
the master can be reached from these two objects.
To aid in navigation, the
show method is defined. It displays the
non-method attributes of an object.
A manhole session might look like:
>>> show(master) data attributes of <buildbot.master.BuildMaster instance at 0x7f7a4ab7df38> basedir : '/home/dustin/code/buildbot/t/buildbot/'... botmaster : <type 'instance'> buildCacheSize : None buildHorizon : None buildbotURL : http://localhost:8010/ changeCacheSize : None change_svc : <type 'instance'> configFileName : master.cfg db : <class 'buildbot.db.connector.DBConnector'> db_poll_interval : None db_url : sqlite:///state.sqlite ... >>> show(master.botmaster.builders['win32']) data attributes of <Builder ''builder'' at 48963528> ... >>> win32 = _ >>> win32.category = 'w32'