PuppetDB 1.1 » Configuration
This version of PuppetDB is not included in Puppet Enterprise. The latest version of PE includes PuppetDB 4.4. A newer version is available; see the version menu above for details.
PuppetDB has three main groups of settings:
- The init script’s configuration file, which sets the Java heap size and the location of PuppetDB’s main config file
- Logging settings, which go in the log4j.properties file and can be changed without restarting PuppetDB
- All other settings, which go in PuppetDB’s configuration file(s) and take effect after the service is restarted
Init Script Config File
If you installed PuppetDB from packages or used the
rake install installation method, an init script was created for PuppetDB. This script has its own configuration file, whose location varies by platform and by package:
|OS and Package||File|
|Redhat-like (open source)||
|Debian/Ubuntu (open source)||
In this file, you can change the following settings:
The location of the Java binary.
Command line options for the Java binary, most notably the
-Xmx(max heap size) flag.
The user PuppetDB should be running as.
The directory into which PuppetDB is installed.
The location of the PuppetDB config file, which may be a single file or a directory of .ini files.
Configuring the Java Heap Size
To change the JVM heap size for PuppetDB, edit the init script config file by setting a new value for the
-Xmx flag in the
For example, to cap PuppetDB at 192MB of memory:
To use 1GB of memory:
Configuring JMX Access
While all JMX metrics are exposed using the
/metrics namespace, you can also
expose direct JMX access using standard JVM means as documented
This can be done using the
JAVA_ARGS init script setting, similar to configuring the heap size.
For example, adding the following JVM options will open up a JMX socket on port 1099:
The log4j Logging Config File
Logging is configured with a log4j.properties file, whose location is defined with the
logging-config setting. If you change the log settings while PuppetDB is running, it will apply the new settings without requiring a restart.
See the log4j documentation for more information about logging options.
The PuppetDB Configuration File(s)
PuppetDB is configured using an INI-style config format with several
[sections]. This is very similar to the format used by Puppet. All of the sections and settings described below belong in the PuppetDB config file(s).
Whenever you change PuppetDB’s configuration settings, you must restart the service for the changes to take effect.
You can change the location of the main config file in the init script config file. This location can point to a single configuration file or a directory of .ini files. If you specify a directory (conf.d style), PuppetDB will merge the .ini files in alphabetical order.
If you’ve installed PuppetDB from a package, by default it will use the conf.d config style. The default config directory is
/etc/puppetlabs/puppetdb/conf.d for Puppet Enterprise). If you’re running from source, you may use the
-c command-line argument to specify your config file or directory.
An example configuration file:
[global] vardir = /var/lib/puppetdb logging-config = /var/lib/puppetdb/log4j.properties resource-query-limit = 20000 [database] classname = org.postgresql.Driver subprotocol = postgresql subname = //localhost:5432/puppetdb [jetty] port = 8080
Playing Nice With the PuppetDB Module
If you installed PuppetDB with the puppetlabs-puppetdb module, the config file(s) will be managed by Puppet. However, since the module manages these files on a per-setting basis, you can still configure additional settings that the module doesn’t set.
To do this, you should create a new class (something like
site::puppetdb::server::extra), declare any number of
ini_setting resources as shown below, set the class to refresh the
puppetdb::server class, and assign it to your PuppetDB server.
[global] section is used to configure application-wide behavior.
This defines the parent directory for the MQ’s data directory. Also, if a database isn’t specified, the default database’s files will be stored in
<vardir>/db. The directory must exist and be writable by the PuppetDB user in order for the application to run.
This describes the full path to a log4j.properties file. Covering all the options available for configuring log4j is outside the scope of this document; see the aforementioned link for exhaustive information.
If this setting isn’t provided, PuppetDB defaults to logging at INFO level to standard out.
If you installed from packages, PuppetDB will use the log4j.properties file in the
/etc/puppetlabs/puppetdb directory. Otherwise, you can find an example file in the
ext directory of the source.
You can edit the logging configuration file while PuppetDB is running, and it will automatically react to changes after a few seconds.
The maximum number of legal results that a resource query can return. If you issue a query that would result in more results than this value, the query will simply return an error. (This can be used to prevent accidental queries that would yield huge numbers of results from consuming undesirable amounts of resources on the server.)
The default value is 20000.
The URL to query when checking for newer versions; defaults to
Overriding this setting may be useful if your PuppetDB server is firewalled and can’t make external HTTP requests, in which case you could
configure a proxy server to send requests to the
and override this setting to point to your proxy server.
[database] section configures PuppetDB’s database settings.
PuppetDB can use either a built-in HSQLDB database or a PostgreSQL database. If no database information is supplied, an HSQLDB database at
<vardir>/db will be used.
FAQ: Why no MySQL or Oracle support?
MySQL lacks several features that PuppetDB relies on; the most notable is recursive queries. We have no plans to ever support MySQL.
Depending on demand, Oracle support may be forthcoming in a future version of PuppetDB. This hasn’t been decided yet.
Using Built-in HSQLDB
To use an HSQLDB database at the default
<vardir>/db, you can simply remove all database settings. To configure the DB for a different location, put the following in the
classname = org.hsqldb.jdbcDriver subprotocol = hsqldb subname = file:</PATH/TO/DB>;hsqldb.tx=mvcc;sql.syntax_pgs=true
</PATH/TO/DB> with the filesystem location in which you’d like to persist the database.
Do not use the
Before using the PostgreSQL backend, you must set up a PostgreSQL server, ensure that it will accept incoming connections, create a user for PuppetDB to use when connecting, and create a database for PuppetDB. Completely configuring PostgreSQL is beyond the scope of this manual, but if you are logged in as root on a running Postgres server, you can create a user and database as follows:
$ sudo -u postgres sh $ createuser -DRSP puppetdb $ createdb -E UTF8 -O puppetdb puppetdb $ exit
Ensure you can log in by running:
$ psql -h localhost puppetdb puppetdb
To configure PuppetDB to use this database, put the following in the
classname = org.postgresql.Driver subprotocol = postgresql subname = //<HOST>:<PORT>/<DATABASE> username = <USERNAME> password = <PASSWORD>
<HOST> with the DB server’s hostname. Replace
<PORT> with the port on which PostgreSQL is listening. Replace
<DATABASE> with the name of the database you’ve created for use with PuppetDB.
Using SSL With PostgreSQL
It’s possible to use SSL to protect connections to the database. There are several extra steps and considerations when doing so; see the PostgreSQL SSL setup page for complete details.
The main difference in the config file is that you must be sure to add
?ssl=true to the
subname = //<HOST>:<PORT>/<DATABASE>?ssl=true
This controls how often, in minutes, to compact the database. The compaction process reclaims space and deletes unnecessary rows. If not supplied, the default is every 60 minutes.
Auto-deactivate nodes that haven’t seen any activity (no new catalogs, facts, etc) in the specified amount of time. You may specify the time as a string using any of the following suffixes:
`d` - days `h` - hours `m` - minutes `s` - seconds `ms` - milliseconds
So, e.g., a value of
30d would set the time-to-live to 30 days, and a value of
48h would set the time-to-live to 48 hours.
Nodes will be checked for staleness every
gc-interval minutes. Manual
deactivation will continue to work as always.
If unset, auto-deactivation of nodes is disabled.
Automatically delete reports that are older than the specified amount of time.
You may specify the time as a string using any of the suffixes described in the
node-ttl section above.
Outdated reports will be deleted during the database garbage collection, which
If unset, the default value is 7 days.
This sets the number of seconds before an SQL query is considered “slow.” Slow SQL queries are logged as warnings, to assist in debugging and tuning. Note PuppetDB does not interrupt slow queries; it simply reports them after they complete.
The default value is 10 seconds. A value of 0 will disable logging of slow queries.
This sets the JDBC class to use. Set this to:
org.hsqldb.jdbcDriverwhen using the embedded database
org.postgresql.Driverwhen using PostgreSQL
Set this to:
hsqldbwhen using the embedded database
postgresqlwhen using PostgreSQL
This describes where to find the database. Set this to:
file:</PATH/TO/DB>;hsqldb.tx=mvcc;sql.syntax_pgs=truewhen using the embedded database, replacing
</PATH/TO/DB>with a local filesystem path
//<HOST>:<PORT>/<DATABASE>when using PostgreSQL, replacing
<HOST>with the DB server’s hostname,
<PORT>with the port on which PostgreSQL is listening, and
<DATABASE>with the name of the database
?ssl=trueto this if your PostgreSQL server is using SSL.
This is the username to use when connecting. Only used with PostgreSQL.
This is the password to use when connecting. Only used with PostgreSQL.
[command-processing] section configures the command-processing subsystem.
Every change to PuppetDB’s data stores arrives via commands that are inserted into a message queue (MQ). Command processor threads pull items off of that queue, persisting those changes.
This defines how many command processing threads to use. Each thread can process a single command at a time. The number of threads can be tuned based on what you see in the performance dashboard.
This setting defaults to half the number of cores in your system.
This setting sets the maximum amount of space in megabytes that PuppetDB’s ActiveMQ can use for persistent message storage.
This setting sets the maximum amount of space in megabytes that PuppetDB’s ActiveMQ can use for temporary message storage.
[jetty] (HTTP) Settings
[jetty] section configures HTTP for PuppetDB.
This sets the hostname to listen on for unencrypted HTTP traffic. If not supplied, we bind to
localhost, which will reject connections from anywhere but the PuppetDB server itself. To listen on all available interfaces, use
Note: Unencrypted HTTP is the only way to view the performance dashboard, since PuppetDB uses host verification for SSL. However, it can also be used to make any call to PuppetDB’s API, including inserting exported resources and retrieving arbitrary data about your Puppet-managed nodes. If you enable cleartext HTTP, you MUST configure your firewall to protect unverified access to PuppetDB.
This sets what port to use for unencrypted HTTP traffic. If not supplied, we won’t listen for unencrypted traffic at all.
This sets the maximum number of threads assigned to responding to HTTP and HTTPS requests, effectively changing how many concurrent requests can be made at one time. Defaults to 50.
Note: Due to how our web-server (Jetty 7) behaves, this setting must be higher then the number of CPU’s on your system or it will stop processing any HTTP requests.
This sets the hostname to listen on for encrypted HTTPS traffic. If not supplied, we bind to
localhost. To listen on all available interfaces, use
This sets the port to use for encrypted HTTPS traffic. If not supplied, we won’t listen for encrypted traffic at all.
This sets the path to a Java keystore file containing the key and certificate to be used for HTTPS.
This sets the passphrase to use for unlocking the keystore file.
This describes the path to a Java keystore file containing the CA certificate(s) for your puppet infrastructure.
This sets the passphrase to use for unlocking the truststore file.
Optional. This describes the path to a file that contains a list of certificate names, one per line. Incoming HTTPS requests will have their certificates validated against this list of names and only those with an exact matching entry will be allowed through. (For a puppet master, this compares against the value of the
certname setting, rather than the
If not supplied, PuppetDB uses standard HTTPS without any additional authorization. All HTTPS clients must still supply valid, verifiable SSL client certificates.
[repl] section configures remote runtime modification. For more detailed info, see Debugging with the Remote REPL.
Enabling a remote REPL allows you to manipulate the behavior of PuppetDB at runtime. This should only be done for debugging purposes, and is thus disabled by default. An example configuration stanza:
[repl] enabled = true type = nrepl port = 8081
true to enable the REPL. Defaults to false.
The nrepl repl type opens up a socket you can connect to via telnet.
The swank type allows emacs’ clojure-mode to connect directly to a running PuppetDB instance by using
M-x slime-connect. This is much more user-friendly than telnet.
The port to use for the REPL.