Management daemon
Tempesta Escudo runs two daemons:
-
tfw_mgr– a management daemon that receives gRPC messages from the client library or the CLI tool and dynamically reconfigures the Tempesta xFW and FW services. -
tfw_logger– responsible for observability logging into a ClickHouse database.
Both daemons are managed by the xfwctl script. For example, you can start the
Tempesta xFW service with:
# ./bin/xfwctl --start
Loading configuration from /etc/tempesta/xfw.json...
Configuration: -devices ens3
-devices-mode skb
-deployment-mode host
-dns false
-daemon_args
-daemon_log /var/log/tempesta/manager.log
-pidfile /var/run/tempesta_mgr.pid
-verbose false
-event-logging off
The script prints the settings loaded from /etc/tempesta/xfw.json by default,
including the BPF deployment mode and management daemon arguments.
You can specify a different configuration file path using the -c command-line
option for xfwctl. Run xfwctl --help for a list of available options and actions.
The configuration option event-logging in /etc/tempesta/xfw.json controls the collection of information about blocked packets.
By default, event-logging is on, meaning that information collection is active and the logging daemon (tfw_logger) will be started.
If event-logging is set to off, event collection will be disabled—even though the events themselves still occur—and tfw_logger will not start.
By default, tfw_logger is configured using /etc/tempesta/xfw_logger.json.
Configuration Options🔗
Network devices🔗
JSON key "devices". The value specifies the names of network devices to which XDP
and TC programs are attached. Example:
"devices": "ens3 ens4"
Network device mode🔗
JSON key "devices-mode". Refer to device modes.
Supported values are "skb" and "native". Example:
"devices-mode": "skb"
Deployment mode🔗
JSON key "deployment-mode". Supported values are "host" (default),
"gw" for an inline gateway, and "scrubbing" for a scrubbing node.
This is independent of the XDP "devices-mode" setting. Example:
"deployment-mode": "gw"
DNS processing🔗
JSON key "dns". Set the JSON boolean to true to load DNS-specific eBPF
processing and its map, or false (default) to leave them disabled. This option
works with each deployment mode. Enable it when using DNS protection rules such
as dns_filter. Example:
"dns": true
Automatic IRQ affinity🔗
JSON key "auto-irq-affinity". Set the JSON boolean to true (default) to
automatically assign network device interrupts (IRQs) to specific CPUs after
XDP and TC attachment. Existing queue counts are preserved.
Set it to false when managing IRQ affinity manually. This skips the affinity
helper, including its RPS and irqbalance changes.
"auto-irq-affinity": false
Both settings are applied when XDP and TC programs are loaded. After changing
them, restart xFW with xfwctl --restart to load both programs in the new mode.
Management daemon arguments🔗
JSON key "daemon_args". The value is a string of command-line arguments passed to
tfw_mgr. Refer to the daemon help output for available options:
# /opt/tempesta/sbin/tfw_mgr --help
Usage: tempesta_mgr [options]:
-l [ --listen ] arg (=127.0.0.1) address to listen on
-p [ --port ] arg (=50051) grpc port to listen on
--http-port arg (=9090) http port to listen on
-G [ --geoip ] arg path to a GeoIP database file
-L [ --log ] arg (=/var/log/tempesta/manager.log)
path to a log-file
-P [ --pidfile ] arg (=/var/run/tempesta_mgr.pid)
path to a pid-file
-h [ --help ] show this message and exit
-d [ --debug ] run in debugging mode
Example:
"daemon_args": "-l 192.168.100.4 -p 5000"
Verbose logging🔗
JSON key "verbose". The value is a boolean ("true" or "false",
default). This options enables verbose logging for tfw_mgr. Example:
"verbose": "true"