- Step 1: Install plug-ins
- Step 2: Edit configuration files
- Step 3: Set security policy
- Step 4: Restart Puppet master
Note: To use PuppetDB, your site’s Puppet master(s) must be running Puppet version 4.0.0 or later.
Once PuppetDB is installed and running, configure your Puppet master(s) to use it. When properly connected to PuppetDB, Puppet masters will do the following:
- Send every node’s catalog, facts, and reports to PuppetDB
- Query PuppetDB when compiling node catalogs that collect exported resources
Note: if you’ve installed PuppetDB using the PuppetDB module, then the
puppetdb::master::configclass is taking care of all of this for you.
Working on your Puppet master server(s), follow all of the instructions below:
Step 1: Install plug-ins
Currently, Puppet masters need additional Ruby plug-ins in order to use PuppetDB. Unlike custom facts or functions, these cannot be loaded from a module and must be installed in Puppet’s main source directory.
On platforms with packages
Enable the Puppet Collection repo and then install the
$ sudo puppet resource package puppetdb-termini ensure=latest
On platforms without packages
If your Puppet master isn’t running Puppet from a supported package, you will need to install the plugins manually:
- Download the PuppetDB source code, unzip it, and navigate into the resulting directory in your terminal.
sudo cp -R puppet/lib/puppet/ /usr/lib/ruby/site_ruby/1.8/puppet. Replace the second path with the path to your Puppet installation if you have installed it somewhere other than
/usr/lib/ruby/site_ruby. If you are using Puppet version 4.0.0 or later, replace the second path with the path to the Ruby supplied by Puppet at
Step 2: Edit configuration files
Locate Puppet’s config directory
Find your Puppet master’s config directory by running
sudo puppet config print confdir. It will usually be at either
You will edit (or create) three files in this directory:
1. Edit puppetdb.conf
The puppetdb.conf file will probably not yet exist. Create it, and add the PuppetDB server’s URL that includes the hostname and port:
[main] server_urls = https://puppetdb.example.com:8081
PuppetDB’s port for secure traffic defaults to 8081 with the context root of ‘/’. If you have not changed the defaults, the above configuration (with the correct hostname) is sufficient. For more information on configuring
server_urls, including support for multiple PuppetDB backends, see configuring the PuppetDB server_urls.
2. Edit puppet.conf
To enable saving facts and catalogs in PuppetDB, edit the
[master] block of puppet.conf to reflect the following settings:
[master] storeconfigs = true storeconfigs_backend = puppetdb
async_storeconfigssettings should be absent or set to
false. If you previously used the Puppet queue daemon (puppetqd), you should now disable it.
Enabling report storage
PuppetDB includes support for storing Puppet reports. This feature can be
enabled by simply adding the
puppetdb report processor in your
file. If you don’t already have a
reports setting in your
file, you’ll probably want to add a line like this:
reports = store,puppetdb
This will retain Puppet’s default behavior of storing the reports to disk as YAML, while also sending the reports to PuppetDB.
You can configure how long PuppetDB stores these reports, and you can do some very basic querying. For more information, see:
More information about Puppet report processors in general can be found here.
3. Edit routes.yaml
The routes.yaml file will probably not yet exist. Find the path to this Puppet configuration file by running
puppet master --configprint route_file.
Create the file, if necessary, and add the following:
--- master: facts: terminus: puppetdb cache: yaml
Ensure proper ownership of the config files
The files created above need to be owned by the
puppet user. Ensure that
this ownership is applied by running the following command:
$ sudo chown -R puppet:puppet `sudo puppet config print confdir`
Step 3: Set security policy
PuppetDB listens on TCP port 8081 (HTTPS). Ensure that this port is open between the Puppet master and PuppetDB services. If the services run on the same server, additional configuration might not be needed. If the services are on separate servers, ensure that the server and network firewalls allow for traffic flow.
PuppetDB works without modification with SELinux in enforcing mode.
Step 4: Restart Puppet master
Use your system’s service tools to restart the Puppet master service. For open source Puppet users, the command to do this will vary, depending on the frontend web server being used.
Your Puppet master is now using PuppetDB to store and retrieve catalogs, facts, and exported resources. You can test your setup by triggering a Puppet agent run on an arbitrary node, then logging into your PuppetDB server and viewing the
/var/log/puppetlabs/puppetdb/puppetdb.logfile, which will include calls to the “replace facts”, “replace catalog”, and “store report” commands:
2012-05-17 13:08:41,664 INFO [command-proc-67] [puppetdb.command] [85beb105-5f4a-4257-a5ed-cdf0d07aa1a5] [replace facts] screech.example.com 2012-05-17 13:08:45,993 INFO [command-proc-67] [puppetdb.command] [3a910863-6b33-4717-95d2-39edf92c8610] [replace catalog] screech.example.com