Code

b0eceec117e9939c0986376d9c53315ba144c20b
[sysdb.git] / doc / sysdbd-puppet-store-configs.5.txt
1 sysdbd-puppet-store-configs(5)
2 ==============================
3 :doctype: manpage
5 NAME
6 ----
7 sysdbd-puppet-store-configs - puppet::store-configs plugin querying Puppet
9 SYNOPSIS
10 --------
11   <LoadBackend "puppet::store-configs">
12       Interval 300
13   </LoadBackend>
15   <Backend "puppet::store-configs">
16       <Connection "puppet">
17           DBAdapter "pgsql"
18           DBName "puppet"
19           DBServer "puppet.domain.tld"
20           DBPort "5432"
21           DBUser "puppet"
22           DBPassword "secret1"
23           DBIOption "name" "value"
24       </Connection>
25   </Backend>
27 DESCRIPTION
28 -----------
29 *puppet::store-configs* is a backend module which queries the configuration
30 management system *Puppet* using its *store configs* database. It connects to
31 the store configs database using a DBI client and periodically queries all
32 hosts and facter facts. The hosts are then stored using their fully qualified
33 domain names whereas facts are stored as host attributes.
35 CONFIGURATION
36 -------------
37 *puppet::store-configs* accepts the following configuration options:
39 *Connection* '<name>'::
40         A connection block specifies a store configs database to connect to. The
41         specified '<name>' is used to identify the connection internally but
42         otherwise has no special meaning.
43         +
44         A connection block accepts the following configuration options:
46         *DBAdapter* '<name>';;
47         *DBName* '<database>';;
48         *DBServer* '<hostname>';;
49         *DBPort* '<port>';;
50         *DBUser* '<username>';;
51         *DBPassword* '<password>';;
52         *DBIOption* '<name>' '<value>';;
53                 Connection parameters specifying which database to connect to. Each
54                 parameter is passed on to DBI when connecting to the database.
56 SEE ALSO
57 --------
58 manpage:sysdbd[1], manpage:sysdbd.conf[5],
59 http://puppetlabs.com/
61 AUTHOR
62 ------
63 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
65 COPYRIGHT
66 ---------
67 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
69 This is free software under the terms of the BSD license, see the source for
70 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
71 FITNESS FOR A PARTICULAR PURPOSE.
73 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :