From 6c079fa6c3866576076ca47f50b5feacfa5ebbea Mon Sep 17 00:00:00 2001 From: Sebastian Harl Date: Sat, 21 Feb 2015 17:07:14 +0100 Subject: [PATCH] sysdbd-store-network(5): Documented the store::network plugin. --- doc/Makefile.am | 9 ++++ doc/sysdbd-store-network.5.txt | 86 ++++++++++++++++++++++++++++++++++ 2 files changed, 95 insertions(+) create mode 100644 doc/sysdbd-store-network.5.txt diff --git a/doc/Makefile.am b/doc/Makefile.am index b795d62..3867744 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -16,6 +16,7 @@ EXTRA_DIST = \ sysdbd-facter.5.txt \ sysdbd-mk-livestatus.5.txt \ sysdbd-puppet-store-configs.5.txt \ + sysdbd-store-network.5.txt \ sysdbd-syslog.5.txt \ sysdbd-timeseries-rrdtool.5.txt \ sysdb.7.txt \ @@ -29,6 +30,7 @@ CLEANFILES = \ sysdbd-facter.5 \ sysdbd-mk-livestatus.5 \ sysdbd-puppet-store-configs.5 \ + sysdbd-store-network.5 \ sysdbd-syslog.5 \ sysdbd-timeseries-rrdtool.5 \ sysdb.7 \ @@ -41,6 +43,7 @@ CLEANFILES = \ sysdbd-facter.5.html \ sysdbd-mk-livestatus.5.html \ sysdbd-puppet-store-configs.5.html \ + sysdbd-store-network.5.html \ sysdbd-syslog.5.html \ sysdbd-timeseries-rrdtool.5.html \ sysdb.7.html \ @@ -53,6 +56,7 @@ CLEANFILES = \ sysdbd-facter.5.xml \ sysdbd-mk-livestatus.5.xml \ sysdbd-puppet-store-configs.5.xml \ + sysdbd-store-network.5.xml \ sysdbd-syslog.5.xml \ sysdbd-timeseries-rrdtool.5.xml \ sysdb.7.xml \ @@ -67,6 +71,7 @@ man_MANS = \ sysdbd-facter.5 \ sysdbd-mk-livestatus.5 \ sysdbd-puppet-store-configs.5 \ + sysdbd-store-network.5 \ sysdbd-syslog.5 \ sysdbd-timeseries-rrdtool.5 \ sysdb.7 \ @@ -81,6 +86,7 @@ html_DATA = \ sysdbd-facter.5.html \ sysdbd-mk-livestatus.5.html \ sysdbd-puppet-store-configs.5.html \ + sysdbd-store-network.5.html \ sysdbd-syslog.5.html \ sysdbd-timeseries-rrdtool.5.html \ sysdb.7.html \ @@ -102,6 +108,7 @@ sysdbd-collectd-unixsock.5.xml: sysdbd-collectd-unixsock.5.txt $(MAN_DEPS) sysdbd-facter.5.xml: sysdbd-facter.5.txt $(MAN_DEPS) sysdbd-mk-livestatus.5.xml: sysdbd-mk-livestatus.5.txt $(MAN_DEPS) sysdbd-puppet-store-configs.5.xml: sysdbd-puppet-store-configs.5.txt $(MAN_DEPS) +sysdbd-store-network.5.xml: sysdbd-store-network.5.txt $(MAN_DEPS) sysdbd-syslog.5.xml: sysdbd-syslog.5.txt $(MAN_DEPS) sysdbd-timeseries-rrdtool.5.xml: sysdbd-timeseries-rrdtool.5.txt $(MAN_DEPS) sysdb.7.xml: sysdb.7.txt sysdb-description.txt $(MAN_DEPS) @@ -115,6 +122,7 @@ sysdbd-collectd-unixsock.5: sysdbd-collectd-unixsock.5.xml sysdbd-facter.5: sysdbd-facter.5.xml sysdbd-mk-livestatus.5: sysdbd-mk-livestatus.5.xml sysdbd-puppet-store-configs.5: sysdbd-puppet-store-configs.5.xml +sysdbd-store-network.5: sysdbd-store-network.5.xml sysdbd-syslog.5: sysdbd-syslog.5.xml sysdbd-timeseries-rrdtool.5: sysdbd-timeseries-rrdtool.5.xml sysdb.7: sysdb.7.xml @@ -128,6 +136,7 @@ sysdbd-collectd-unixsock.5.html: sysdbd-collectd-unixsock.5.txt $(MAN_DEPS) sysdbd-facter.5.html: sysdbd-facter.5.txt $(MAN_DEPS) sysdbd-mk-livestatus.5.html: sysdbd-mk-livestatus.5.txt $(MAN_DEPS) sysdbd-puppet-store-configs.5.html: sysdbd-puppet-store-configs.5.txt $(MAN_DEPS) +sysdbd-store-network.5.html: sysdbd-store-network.5.txt $(MAN_DEPS) sysdbd-syslog.5.html: sysdbd-syslog.5.txt $(MAN_DEPS) sysdbd-timeseries-rrdtool.5.html: sysdbd-timeseries-rrdtool.5.txt $(MAN_DEPS) sysdb.7.html: sysdb.7.txt sysdb-auth.txt sysdb-description.txt $(MAN_DEPS) diff --git a/doc/sysdbd-store-network.5.txt b/doc/sysdbd-store-network.5.txt new file mode 100644 index 0000000..beb13db --- /dev/null +++ b/doc/sysdbd-store-network.5.txt @@ -0,0 +1,86 @@ +sysdbd-store-network(5) +======================= +:doctype: manpage + +NAME +---- +sysdbd-store-network - store::network plugin sending to remote instances + +SYNOPSIS +-------- + LoadPlugin "store::network" + + + + Username "my.host.name" + SSLCertificate "/etc/sysdb/ssl/cert.pem" + SSLCertificateKey "/etc/sysdb/ssl/key.pem" + SSLCACertificates "/etc/ssl/certs/ca-certificates.crt" + + + +DESCRIPTION +----------- +*store::network* is a plugin which connects to a remote SysDB instance and +sends all locally collected stored objects to that instance. It uses the +low-level binary protocol to efficiently transmit the data. + +CONFIGURATION +------------- +*store::network* accepts the following configuration options: + +*Server* '
':: + A server block specifies the connection settings. Multiple servers may be + specified to send all data to multiple instances. The specified + '
' may be a local path-name of a UNIX domain socket, a hostname, + an IPv4 address, or and IPv6 address along with the remote port, separated + by a colon (":"). + + + All TCP connections are encrypted with SSL/TLS. See the *SSL* + configuration options for details about how to configure this. + + + All clients need to authenticate against the remote SysDB instance. See + the section *AUTHENTICATION* for details. + + + A server block accepts the following configuration options: + + *Username* '';; + The username used for authentication against the remote instance. + + *SSLCertificate* '';; + The SSL certificate file to use for SSL connections and + authentication. + + *SSLCertificateKey* '';; + The SSL private key file to use for SSL connections and + authentication. + + *SSLCACertificates* '';; + The certificate authority (CA) certificates file for server + certificate verification to use for SSL connection. + +AUTHENTICATION +-------------- + +include::sysdb-auth.txt[] + +SEE ALSO +-------- +manpage:sysdbd[1], manpage:sysdbd.conf[5] + +The SysDB homepage: https://sysdb.io/ + +AUTHOR +------ +SysDB was written by Sebastian "tokkee" Harl . + +COPYRIGHT +--------- +Copyright (C) 2012-2015 Sebastian "tokkee" Harl + +This is free software under the terms of the BSD license, see the source for +copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. + +// vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us : + -- 2.30.2