velactl.conf

velactl.conf — velactl(8) configuration file.

Description

The velactl.conf file describes various global options ifluencing the behavior of velactl(8) . velactl(8) processes the file line by line, each line having the structure described below. Empty lines and lines beginning with '#' are comments and are ignored.

Structure

variable name = variable value

Each non-empty line specifies a variable name and its value separated by the equal sign ('='). The following variables are available:

AUTO_RESTART

Enable the automatic restart feature of velactl. Instances in auto-restart mode are restarted automatically when they exit. Default value: 1 (TRUE).

STOP_CHECK_TIMEOUT

The number of seconds to wait for a stopping Vela instance. Default value: 3.

START_CHECK_TIMEOUT

In auto-restart mode there is no real way to detect whether Vela failed to load or not. Velactl waits START_CHECK_TIMEOUT seconds and assumes that Vela loaded successfully if it did not exit within this interval. Default value: 5 seconds.

START_WAIT_TIMEOUT

In no-auto-restart mode the successful loading of a Vela instance can be verified by instructing Vela to daemonize itself and waiting for the parent to exit. This parameter specifies the number of seconds to wait for Vela to daemonize itself. Default value: 60 seconds.

VELA_APPEND_ARGS

Vela-specific arguments to be appended to the command line of each Vela instance. Also recognised as APPEND_ARGS (deprecated). Default value: "".

VELACTL_APPEND_ARGS

Velactl-specific arguments to be appended to the command line of each instance. Default value: "".

CHECK_PERMS

Specifies whether to check the permissions of the Vela configuration directory. If set, Vela refuses to run if the /etc/vela directory can be written by user other then vela Default value: 1 (TRUE).

CONFIG_DIR

The path to the Vela configuration directory to check if CHECK_PERMS is enabled. NOTE: it does not change the Vela policy file argument, this parameter is only used by the permission validating code. Default value: ${prefix}/etc/vela .

CONFIG_DIR_OWNER, CONFIG_DIR_GROUP, CONFIG_DIR_MODE

The owner/group/permissions values considered valid for the configuration directory. velactl fails if the actual owner/group/permissions values conflict the ones set here. Default values: root.vela, 0750 .

PIDFILE_DIR

The path to the Vela pid file directory. The directory is created automatically prior to starting Vela if it does not already exist.It is created if it does not exist, before NOTE: No --pidfile argument is passed to Vela, only texistance of the directory is verified. Default value: /var/run/vela.

PIDFILE_DIR_OWNER, PIDFILE_DIR_GROUP, PIDFILE_DIR_MODE

The owner/group/permission values the pidfile directory is created with if it does not exist. Default values: root.root, 0700.

Files

The default location for velactl.conf is /etc/vela/velactl.conf.

Author

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

Copyright

Copyright © 2021 BalaSys IT Security. All rights reserved.