crossroads(1) - Linux man page

e-tunity

Name

crossroads - Load balancer and fail over utility

Synopsis

o
crossroads [flags] start: starts Crossroads
o
crossroads [flags] stop: stops Crossroads
o
crossroads [flags] restart: restarts Crossroads
o
crossroads [flags] configtest: verifies configuration
o
crossroads [flags] services: shows configured services
o
crossroads [flags] tell service backend state newstate: sets a back end state
o
crossroads [flags] tell service backend server hostname:port: redefines the address of a back end

Description

crossroads is the main control program of Crossroads, a balancing and fail over utility. The Crossroads utility consists of two binaries: crossroads and crossroads-daemon. The latter is controlled by the front end crossroads.

Recognized states in crossroads tell are:

o
available or up when a backend is working;
o
unavailable when a back end is temporarily down, but can be woken up;
o
down when a back end is permanently down (e.g., for maintenance). Crossroads itself will never activate a backend in this state.
o
waking when the live status of a back end is being checked.

Options

Crossroads recognizes the following flags:

o
-a: Logs start and end times of activity to syslog.
o
-b: Writes a binary representation of the configuration to stdout. For debugging only.
o
-B size: Sets the size of network buffers. Larger buffers will mean a less number of CWread() or CWwrite() operations, but a larger memory footprint. Usually the default value will do fine.
o
-C: Writes the compile time configuration to stdout and stops. Useful when submitting bug reports.
o
-c config: Uses config as the configuration file. The default is /some/path/etc/crossroads.conf or /etc/crossroads.conf. The first alternative applies when Crossroads is installed as /some/path/bin/crossroads; in that case, Crossroads tries to find its configuration by trying an 'etc' diretory 'near' its own path.
o
-d sec: Sets the DNS cache time-to-live to sec seconds. Value 0 suppresses DNS entry caching. The default is 0.
o
-l facility: Specifies the openlog (3) facility, default is LOG_DAEMON. Values can be 0 to 7, meaning LOG_LOCAL0 to LOG_LOCAL9.
o
-m permissions: Specifies shared memory permissions, default is 0644.
o
-s: Requests 'sloppy' binding to TCP ports. When a port is busy, Crossroads will retry periodically to get it. Default is to stop when a listening port cannot be obtained.
o
-t: Output of crossroads status is shown as a tabular view, in one or more lines of:
service backend=state [backend=state...]
o
-x: Output of crossroads status is shown as an XML document.
o
-v: Initial actions of Crossroads are more 'verbose'. (Once daemonized, the verbosity is controlled using verbosity statements in the configuration.)
o
-V: Shows the version ID and stops.
o
-?: Shows an overview of the usage.

Files

crossroads.conf, the default configuration file

See Also

o
crossroads.conf (7)
o
The full Crossroads documentation in html or pdf format, distributed with the sources.

Bugs

Crossroads is of course bug free (haha). When submitting bugs to the maintainer. please always include the following information:
o
The configuration file that Crossroads uses;
o
The compile-time configuration, which is the output of crossroads -C;
o
A good description of the bug, and of the conditions under which it occurs.

Author

o
Author: Karel Kubat
o
Maintainer: Karel Kubat karel@kubat.nl