cd_puppetdb – Parameters

The following parameters are used in cd_puppetdb. They editable via params.pp or can be overridden through ENC (recommended). Values changed will take immediate effect at next puppet run. Services will be restarted where necessary.

Main Parameters

The following main parameters must be reviewed and set to connect values.

  • ppdb_master_fqdn (string) (defaults to: n, $ppd)

    The FQDN of the puppet master. See README for details about how to deploy this module in environments where the PuppetDB server is running on a server separate to the puppet master.

  • ppdb_fqdn (string) (defaults to: tdb.${::domain}", $p)

    The FQDN of the PuppetDB server. See README for details about how to deploy this module in environments where the PuppetDB server is running on a server separate to the puppet master.

Other Parameters

The following parameters can also be overridden, but usually are ready ok to use as is.

  • ppdb_include_puppet (boolean) (defaults to: # p)

    Whether or not to include the cd_puppet module, which installs the yumrepo for Puppet, resulting in getting the latest available version for PuppetDB.

  • pkg_ensure (string) (defaults to: t', # f)

    Specify the package type, i.e present or latest.

  • ppdb_inc_fw (boolean) (defaults to: $ppd)

    Whether or not to enable the firewall. Requires cd_firewall or puppetdb-firewall in your catalog.

  • ppdb_fw_order (string) (defaults to: # )

    A prefix for the firewall rule ordering, Adjust to your environment to ensure the firewall rule order is correct. Builds a string together with the actual port numbers.

  • ppdb_user (string) (defaults to: tdb', $ppd)

    The name for the puppetdb service user.

  • ppdb_user_comment (string) (defaults to: tDB daemon', $ppd)

    The comment for the puppetdb service user in /etc/passwd. Shows up in email noteficiations as sender information.

  • ppdb_uid (string) (defaults to: $ppd)

    The UID for the puppetdb service user.

  • ppdb_user_home (string) (defaults to: share/puppetdb', $ppd)

    The home for the puppetdb service user.

  • ppdb_user_shell (string) (defaults to: /nologin', # t)

    The shell for the the puppetdb service user, which never should lbe allowed to login.

  • ppdb_logging_xml (string) (defaults to: ck.xml', $ppd)

    Template variable. The name of the file for the logging configuration.

  • ppdb_use_ext_db (boolean) (defaults to: $ppd)

    Whether or not to use an external database. highly recommended for increased performance.

  • ppdb_db_ssl (boolean) (defaults to: $ppd)

    Whether or not to use ssl/tls for connecting to the backend database. Defaults to true. Requires database end to be configured equally!

  • ppdb_backend (string) (defaults to: resql', $ppd)

    The type of backend database. Determins also which driver to be used.

  • ppdb_be_port (string) (defaults to: l_port, $ppd)

    Which port to use on postgresql. Depends on the Postgresql installation. Defaults to querying a global parameter, but can be overridden an ENC level if no global parameter is set.

  • ppdb_db_host (string) (defaults to: n, $ppd)

    The host for the external database. Defaults picking up the fqdn of the local host. Using an external host is recommended for better performance.

  • ppdb_database (string) (defaults to: le', $ppd)

    The name of the database to use. Should be overridden, must exist on database server.

  • ppdb_db_user (string) (defaults to: le', $ppd)

    The name of the database user. Should be overridden, must exist on database server.

  • ppdb_db_pw (string) (defaults to: le', $ppd)

    The database password. Should be overridden, must exist on database server.

  • ppdb_log_slow (string) (defaults to: $ppd)

    [Template parameter for when the database should consider the SQL query to be slow.

  • ppdb_gc_interval (string) (defaults to: $ppd)

    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.

  • ppdb_node_ttl (string) (defaults to: $ppd)

    Auto-deactivate nodes that haven’t seen any activity (no new catalogs, facts, etc) in the specified amount of time.

  • ppdb_node_purge_ttl (string) (defaults to: $ppd)

    Automatically delete nodes that have been deactivated for the specified amount of time.

  • ppdb_report_ttl (string) (defaults to: $ppd)

    Automatically delete reports that are older than the specified amount of time.

  • ppdb_conn_max_age (string) (defaults to: $ppd)

    The maximum time (in minutes), for a pooled connection to remain unused before it is closed off.

  • ppdb_conn_keep_alive (string) (defaults to: $ppd)

    This sets the time (in minutes), for a connection to remain idle before sending a test query to the DB. This is useful to prevent a DB from timing out connections on its end.

  • ppdb_conn_lifetime (string) (defaults to: $ppd)

    The maximum time (in minutes) a pooled connection should remain open. Any connections older than this setting will be closed off. Connections currently in use will not be affected until they are returned to the pool.

  • ppdb_statem_csize (string) (defaults to: , $p)

    This setting defines how many prepared statements are cached automatically. For a large amount of dynamic queries this number could be increased to increase performance, at the cost of memory consumption and database resources.

  • ppdb_jvargs (string) (defaults to: g -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/var/log/puppetdb/puppetdb-oom.hprof -Djava.security.egd=file:/dev/urandom', $ppd)

    Java arguments to pass to the PuppetDB instance.

  • ppdb_logback_scan (boolean) (defaults to: $ppd)

    Whether or not to scan the logback.

  • ppdb_verb_stor_log (string) (defaults to: $ppd)

    Whether or not to log storage-related messages in verbose mode.

  • ppdb_command_threads (string) (defaults to: ppd)

    How many command threads to establish.

  • ppdb_stor_usage (string) (defaults to: 0', $ppd)

    Maximum disk space for permanent storage to use. Must be available, otherwise puppetDB service will not start.

  • ppdb_temp_usage (string) (defaults to: ', $pp)

    Maximum disk space for temporary storage to use. Must be available, otherwise puppetDB service will not start.

  • ppdb_nossl_host (string) (defaults to: $ppd)

    This sets the IP interface 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 0.0.0.0.

  • ppdb_nossl_port (string) (defaults to: $ppd)

    What port to use for unencrypted HTTP traffic. If not supplied, we won’t listen for unencrypted traffic at all.

  • ppdb_ssl_host (string) (defaults to: .0', $ppd)

    This sets IP interface to listen on for

  • ppdb_ssl_port (string) (defaults to: , $pp)

    The port to use for encrypted HTTPS traffic. If not supplied, we won’t listen for encrypted traffic at all.

  • ppdb_repl_enable (boolean) (defaults to: $ppd)

    Whether to enable a remote REPL allows you to manipulate the behavior of PuppetDB at runtime. Should be done for debugging purpose only.

  • ppdb_repl_type (string) (defaults to: ', $ppd)

    Either nrepl or telnet

  • ppdb_repl_port (string) (defaults to: , $ppd)

    The port to use for the REPL.

  • ppdb_soft_w_fail (string) (defaults to: ) )

    Keeps the puppet master to stay partially available during Puppetdb outage.

See Also:

Leave a Reply