instances.conf

instances.conf — vela(8) instances database

Description

The instances.conf file describes the vela(8) instances to be run on the system. It is processed by velactl(8) line by line, each line having the structure described below. Empty lines and lines beginning with '#' are comments ignored by velactl.

Structure

instance-name parameters [-- velactl-options]

instance-name is the name of the Vela instance to be started; it is passed to vela with its --as parameter. Instance names may consist of the characters [a-zA-Z0-9_] and must begin with a letter.

parameters are space separated parameters entered into the vela command-line. For details on these command-line parameters see vela(8).

velactl-options are space separated parameters control startup specific options. They are processed by velactl itself. The following velactl options are available:

--auto-restart or -A

Enable the automatic restart feature of velactl. When an instance is in auto-restart mode, it is restarted automatically in case the instance exits.

--no-auto-restart or -a

Disable automatic restart for this instance.

--fd-limit <number> or -f <number>

Set the file descriptor limit to <number>. The file descriptor limit defaults to the number of threads (specified by the --threads parameter of vela(8)) multiplied by 4.

--num-of-processes <number> or -P <number>

Run <number> of processes for the instance. velactl starts exactly one Vela process in master mode and <number> of slave Vela processes. This mode of operation is incompatible with old-style dispatchers, you must use the new rule-based policy with this option.

Examples

vela_ftp --policy /etc/vela/policy.py --verbose 5

The line above describes a Vela instance named vela_ftp using policy file /etc/vela/policy.py, and having verbosity level 5.

vela_intra -v4 -p /etc/vela/policy.py --threads 500 --no-auto-restart --fd-limit 1024 --process-limit 512

This line describes a vela instance named vela_intra using the policy file /etc/vela/policy.py, verbosity level 4. The maximum number of threads is set to 500, file descriptor limit to 1024, process limit to 512.

Files

The default location of instances.conf is /etc/vela/instances.conf. Defaults for velactl tunables can be specified in /etc/vela/velactl.

Author

This manual page was written by the BalaSys Documentation Team <documentation@balasys.hu>.

Copyright

Copyright © 2021 BalaSys IT Security. All rights reserved.