diff options
Diffstat (limited to 'systemd/kresd.systemd.7.in')
-rw-r--r-- | systemd/kresd.systemd.7.in | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/systemd/kresd.systemd.7.in b/systemd/kresd.systemd.7.in new file mode 100644 index 0000000..e92613e --- /dev/null +++ b/systemd/kresd.systemd.7.in @@ -0,0 +1,100 @@ +.TH "kresd.systemd" "7" "@date@" "CZ.NIC" "Knot Resolver @version@ Systemd Units" +.\" +.\" kresd.systemd.7 -- man page for systemd units for kresd +.\" +.\" Copyright (c) 2018, CZ.NIC. All rights reserved. +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.\" +.SH "NAME" +kresd.systemd +\- managing Knot Resolver @version@ through systemd. + +.SH "SYNOPSIS" +.nf +kresd@.service +kresd.target +system-kresd.slice +.fi + +.SH "DESCRIPTION" +.P +This manual page describes how to manage \fBkresd\fR using \fBsystemd\fR +units. + +.B QUICKSTART + +.nf +.RS 4n +\fBsystemctl start kresd@1\fR - single instance of kresd, responding on localhost +.RE +.fi + +.B CONCURRENT DAEMONS + +\fBkresd\fR daemon can be executed in multiple independent processes, which are +managed with \fBsystemd\fR via systemd templates (see \fBsystemd.unit\fR(5)). +Each \fBsystemd\fR service instance of \fBkresd\fR (\fIkresd@.service\fR) +represents a single, independent kresd process. + +If you have more than one CPU core available, a single running \fBkresd\fR +daemon will only be able to make use of one core at a time, leaving the other +cores idle. If you want \fBkresd\fR to take advantage of all available cores, +while sharing both cache and sockets, you should enable and start as many +instances of the \fBkresd@.service\fR as you have cores. Typically, each +instance is just named \fIkresd@\fBN\fI.service\fR, where \fIN\fR is a decimal +number. For example, to enable and start 3 concurrent daemons: + +.nf +.RS 4n +.B systemctl enable --now kresd@1.service kresd@2.service kresd@3.service +.RE +.fi + +The systemd-managed \fBkresd\fR service set is grouped in the +\fIsystem-kresd.slice\fR slice. The slice includes all running daemons +(instances of \fIkresd@.service\fR). + +.SH "EXAMPLES" + +To start a single kresd instance and enable it at boot: +.nf +.RS 4n +.B systemctl enable --now kresd@1.service +.RE +.fi + +To restart (or stop) all running instances, you can use a glob expression. +Please note that glob can't be used to start or enable instances. +.nf +.RS 4n +.B systemctl restart 'kresd@*' +.RE +.fi + +Bash users can also use Brace Expansion to enable or start multiple instances, +instead of listing them manually. +.nf +.RS 4n +.B systemctl enable --now kresd@{1..4}.service +.RE +.fi + +To start all enabled kresd daemons, you can also use the provided \fIkresd.target\fR: +.nf +.RS 4n +.B systemctl start kresd.target +.RE +.fi + +.RE + +.SH "SEE ALSO" +\fIkresd(8)\fR, +\fIsystemd.unit(5)\fR, +\fIhttps://knot-resolver.readthedocs.io/en/v@version@/\fR + +.SH "AUTHORS" +.B kresd +developers are mentioned in the AUTHORS file in the distribution. |