doc/sysdbd-puppet-store-configs.5.txt

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