Added documentation and sample configuration for the facter backend.

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 30f997df4a763a91cb2d6640785c11c7c6efb18e..af7962b02f341a184164af81b2c49f9a41762cf7 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -12,6 +12,7 @@ EXTRA_DIST = \
                sysdb-description.txt \
                sysdbd-cname-dns.5.txt \
                sysdbd-collectd-unixsock.5.txt \
+               sysdbd-facter.5.txt \
                sysdbd-mk-livestatus.5.txt \
                sysdbd-puppet-store-configs.5.txt \
                sysdbd-syslog.5.txt \
@@ -24,6 +25,7 @@ CLEANFILES = \
                sysdbd.conf.5 \
                sysdbd-cname-dns.5 \
                sysdbd-collectd-unixsock.5 \
+               sysdbd-facter.5 \
                sysdbd-mk-livestatus.5 \
                sysdbd-puppet-store-configs.5 \
                sysdbd-syslog.5 \
@@ -35,6 +37,7 @@ CLEANFILES = \
                sysdbd.conf.5.html \
                sysdbd-cname-dns.5.html \
                sysdbd-collectd-unixsock.5.html \
+               sysdbd-facter.5.html \
                sysdbd-mk-livestatus.5.html \
                sysdbd-puppet-store-configs.5.html \
                sysdbd-syslog.5.html \
@@ -46,6 +49,7 @@ CLEANFILES = \
                sysdbd.conf.5.xml \
                sysdbd-cname-dns.5.xml \
                sysdbd-collectd-unixsock.5.xml \
+               sysdbd-facter.5.xml \
                sysdbd-mk-livestatus.5.xml \
                sysdbd-puppet-store-configs.5.xml \
                sysdbd-syslog.5.xml \
@@ -59,6 +63,7 @@ man_MANS = \
                sysdbd.conf.5 \
                sysdbd-cname-dns.5 \
                sysdbd-collectd-unixsock.5 \
+               sysdbd-facter.5 \
                sysdbd-mk-livestatus.5 \
                sysdbd-puppet-store-configs.5 \
                sysdbd-syslog.5 \
@@ -72,6 +77,7 @@ html_DATA = \
                sysdbd.conf.5.html \
                sysdbd-cname-dns.5.html \
                sysdbd-collectd-unixsock.5.html \
+               sysdbd-facter.5.html \
                sysdbd-mk-livestatus.5.html \
                sysdbd-puppet-store-configs.5.html \
                sysdbd-syslog.5.html \
@@ -92,6 +98,7 @@ sysdbd.1.xml: sysdbd.1.txt $(MAN_DEPS)
 sysdbd.conf.5.xml: sysdbd.conf.5.txt $(MAN_DEPS)
 sysdbd-cname-dns.5.xml: sysdbd-cname-dns.5.txt $(MAN_DEPS)
 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-syslog.5.xml: sysdbd-syslog.5.txt $(MAN_DEPS)
@@ -104,6 +111,7 @@ sysdbd.1: sysdbd.1.xml
 sysdbd.conf.5: sysdbd.conf.5.xml
 sysdbd-cname-dns.5: sysdbd-cname-dns.5.xml
 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-syslog.5: sysdbd-syslog.5.xml
@@ -116,6 +124,7 @@ sysdbd.1.html: sysdbd.1.txt $(MAN_DEPS)
 sysdbd.conf.5.html: sysdbd.conf.5.txt $(MAN_DEPS)
 sysdbd-cname-dns.5.html: sysdbd-cname-dns.5.txt $(MAN_DEPS)
 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-syslog.5.html: sysdbd-syslog.5.txt $(MAN_DEPS)

diff --git a/doc/sysdbd-facter.5.txt b/doc/sysdbd-facter.5.txt
new file mode 100644 (file)
index 0000000..08271d8
--- /dev/null
+++ b/doc/sysdbd-facter.5.txt
@@ -0,0 +1,45 @@
+sysdbd-facter(5)
+================
+:doctype: manpage
+
+NAME
+----
+sysdbd-facter - query local facter fact values
+
+SYNOPSIS
+--------
+  <LoadBackend "facter">
+      Interval 3600
+  </LoadBackend>
+
+DESCRIPTION
+-----------
+*facter* is a backend module which queries facter fact values from the local
+system. It periodically retrieves the values and submits them as host
+attributes.
+
+CONFIGURATION
+-------------
+*facter* does not currently accept any configuration options.
+
+SEE ALSO
+--------
+manpage:sysdbd[1], manpage:sysdbd.conf[5],
+https://github.com/puppetlabs/cfacter
+
+The SysDB homepage: https://sysdb.io/
+
+AUTHOR
+------
+SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
+
+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 :
+

diff --git a/doc/sysdbd.conf.5.txt b/doc/sysdbd.conf.5.txt
index ed6d765fb0f293d21bcbd76f7220a537d1dd216f..ff4c7102cf90935a5c896746c410897751db57ed 100644 (file)
--- a/doc/sysdbd.conf.5.txt
+++ b/doc/sysdbd.conf.5.txt
@@ -105,10 +105,16 @@ Backends:
 *collectd::unixsock*::
 This backend module accesses the system statistics collection daemon
 *collectd* through its UNIX socket interface. It periodically queries all host
-and service information.
+and metric information.
 +
 See also: http://collectd.org
 
+*facter*::
+This backend module retrieves local facter fact values and submits them as
+host attributes.
++
+See also: https://github.com/puppetlabs/cfacter
+
 *mk-livestatus*::
 This backend modules accesses monitoring systems supporting the *livestatus*
 addon (e.g., *Nagios*, *Icinga*, and *Shinken*). It periodically queries all
@@ -152,8 +158,8 @@ The SysDB homepage: https://sysdb.io/
 Backend documentation:
 ~~~~~~~~~~~~~~~~~~~~~~
 
-manpage:sysdbd-collectd-unixsock[5], manpage:sysdbd-mk-livestatus[5],
-manpage:sysdbd-puppet-store-configs[5]
+manpage:sysdbd-collectd-unixsock[5], manpage:sysdbd-facter[5],
+manpage:sysdbd-mk-livestatus[5], manpage:sysdbd-puppet-store-configs[5]
 
 Time-series fetcher documentation:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/src/tools/sysdbd/sysdbd.conf.sample b/src/tools/sysdbd/sysdbd.conf.sample
index 0f9af625e90f2279e388a700491c4f1d6ce86e14..964901f94bc198dfd3d13584ee42994d1868ee5d 100644 (file)
--- a/src/tools/sysdbd/sysdbd.conf.sample
+++ b/src/tools/sysdbd/sysdbd.conf.sample
@@ -43,6 +43,7 @@ LoadPlugin "cname::dns"
 #   </LoadPlugin>                                                            #
 #----------------------------------------------------------------------------#
 LoadBackend "collectd::unixsock"
+LoadBackend "facter"
 LoadBackend "mk-livestatus"
 LoadBackend "puppet::store-configs"