libra/doc/worker/config.rst

Configuration

Options can be specified either via the command line, or with a configuration file, or both. Options given on the command line will override any options set in the configuration file.

Configuration File Format

The configuration file is in INI format. Options are expressed in one of two forms:

key = value
key : value

Some key points to note:

• Boolean options should be given either a value of true or false.
• Some options can contain multiple values (see 'server' option in the [worker] section).
• If an option has both a short-form and long-form (e.g., -d and --debug), then you should use the long-form name in the configuration file.
• Unknown sections are ignored. This allows all Libra utilities to share the same configuration file, if desired.

Global Section

The [global] section contains options common to the various Libra utilities (worker, mgm, etc). This section is read before any other section, so values may be overridden by the other sections:

[global]
verbose = true

Worker Section

The [worker] section is specific to the libra_worker utility. Below is an example:

[worker]
user = haproxy
group = haproxy
driver = haproxy
reconnect_sleep = 60
server = 10.0.0.1:8080 10.0.0.2:8080
pid = /var/run/libra/libra_worker.pid
logfile = /var/log/libra/libra_worker.log

Command Line Options

libra_worker.py

-c <FILE>, --config <FILE>

Load options from the specified configuration file. Command line options will take precedence over any options specified in the configuration file.

-d, --debug

Enable debugging output.

--driver <DRIVER>

Load balancer driver to use. Valid driver options are:

• haproxy - HAProxy software load balancer. This is the default driver.

--group <GROUP>

Specifies the group for the process when run in daemon mode.

-h, --help

Show the help message and quit.

-l <FILE>, --logfile <FILE>

Name of the log file. When running in daemon mode, the default log file is /var/log/libra/libra_worker.log. When not in daemon mode, logging will go to STDOUT unless a log file is specified.

-n, --nodaemon

Do not run as a daemon. This option is useful for debugging purposes only as the worker is intended to be run as a daemon normally.

-p <PID>, --pid <PID>

Name of the PID file to use. Default is: /var/run/libra/libra_worker.pid

-s <SECONDS>, --reconnect_sleep <SECONDS>

The number of seconds to sleep between job server reconnect attempts when no specified job servers are available. Default is 60 seconds.

--server <HOST:PORT>

Used to specify the Gearman job server hostname and port. This option can be used multiple times to specify multiple job servers.

--user <USER>

Specifies the user for the process when in daemon mode. Default is the current user.

-v, --verbose

Enable verbose output. Normally, only errors are logged. This enables additional logging, but not as much as the -d option.