diff --git a/REFERENCE.md b/REFERENCE.md index 4b6e50a8..8def31b6 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -150,7 +150,7 @@ The following parameters are available in the `puppetdb` class: ##### `listen_address` -Data type: `Any` +Data type: `Stdlib::Host` The address that the web server should bind to for HTTP requests. Defaults to `localhost`. Set to `0.0.0.0` to listen on all addresses. @@ -159,7 +159,7 @@ Default value: `$puppetdb::params::listen_address` ##### `listen_port` -Data type: `Any` +Data type: `Variant[Stdlib::Port::User, Pattern[/\A[0-9]+\Z/]]` The port on which the puppetdb web server should accept HTTP requests. Defaults to `8080`. @@ -168,7 +168,7 @@ Default value: `$puppetdb::params::listen_port` ##### `disable_cleartext` -Data type: `Any` +Data type: `Boolean` If `true`, the puppetdb web server will only serve HTTPS and not HTTP requests (defaults to false). @@ -176,7 +176,7 @@ Default value: `$puppetdb::params::disable_cleartext` ##### `open_listen_port` -Data type: `Any` +Data type: `Boolean` If `true`, open the `http_listen_port` on the firewall. Defaults to `false`. @@ -184,7 +184,7 @@ Default value: `$puppetdb::params::open_listen_port` ##### `ssl_listen_address` -Data type: `Any` +Data type: `Stdlib::Host` The address that the web server should bind to for HTTPS requests. Defaults to `0.0.0.0` to listen on all addresses. @@ -193,7 +193,7 @@ Default value: `$puppetdb::params::ssl_listen_address` ##### `ssl_listen_port` -Data type: `Any` +Data type: `Variant[Stdlib::Port::User, Pattern[/\A[0-9]+\Z/]]` The port on which the puppetdb web server should accept HTTPS requests. Defaults to `8081`. @@ -202,7 +202,7 @@ Default value: `$puppetdb::params::ssl_listen_port` ##### `disable_ssl` -Data type: `Any` +Data type: `Boolean` If `true`, the puppetdb web server will only serve HTTP and not HTTPS requests. Defaults to `false`. @@ -211,7 +211,7 @@ Default value: `$puppetdb::params::disable_ssl` ##### `open_ssl_listen_port` -Data type: `Any` +Data type: `Boolean` If true, open the `ssl_listen_port` on the firewall. Defaults to `undef`. @@ -219,7 +219,7 @@ Default value: `$puppetdb::params::open_ssl_listen_port` ##### `ssl_protocols` -Data type: `Any` +Data type: `Optional[String[1]]` Specify the supported SSL protocols for PuppetDB (e.g. TLSv1, TLSv1.1, TLSv1.2.) @@ -227,7 +227,7 @@ Default value: `$puppetdb::params::ssl_protocols` ##### `postgresql_ssl_on` -Data type: `Any` +Data type: `Boolean` If `true`, it configures SSL connections between PuppetDB and the PostgreSQL database. Defaults to `false`. @@ -236,7 +236,7 @@ Default value: `$puppetdb::params::postgresql_ssl_on` ##### `postgresql_ssl_folder` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to the Postgresql SSL folder. @@ -244,7 +244,7 @@ Default value: `$puppetdb::params::postgresql_ssl_folder` ##### `postgresql_ssl_cert_path` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to the Postgresql SSL certificate. @@ -252,7 +252,7 @@ Default value: `$puppetdb::params::postgresql_ssl_cert_path` ##### `postgresql_ssl_key_path` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to the Postgresql SSL key. @@ -260,7 +260,7 @@ Default value: `$puppetdb::params::postgresql_ssl_key_path` ##### `postgresql_ssl_ca_cert_path` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to the Postgresql SSL CA. @@ -268,7 +268,7 @@ Default value: `$puppetdb::params::postgresql_ssl_ca_cert_path` ##### `cipher_suites` -Data type: `Any` +Data type: `Optional[String[1]]` Configure jetty's supported `cipher-suites` (e.g. `SSL_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384`). Defaults to `undef`. @@ -277,7 +277,7 @@ Default value: `$puppetdb::params::cipher_suites` ##### `migrate` -Data type: `Any` +Data type: `Boolean` If `true`, puppetdb will automatically migrate to the latest database format at startup. If `false`, if the database format supplied by this version of PuppetDB doesn't match the version expected (whether newer or older), PuppetDB will exit with an error status. Defaults to `true`. @@ -285,7 +285,7 @@ Default value: `$puppetdb::params::migrate` ##### `manage_dbserver` -Data type: `Any` +Data type: `Boolean` If true, the PostgreSQL server will be managed by this module. Defaults to `true`. @@ -293,7 +293,7 @@ Default value: `$puppetdb::params::manage_dbserver` ##### `manage_database` -Data type: `Any` +Data type: `Boolean` If true, the PostgreSQL database will be managed by this module. Defaults to `true`. @@ -301,7 +301,7 @@ Default value: `$puppetdb::params::manage_database` ##### `manage_package_repo` -Data type: `Any` +Data type: `Boolean` If `true`, the official postgresql.org repo will be added and postgres won't be installed from the regular repository. Defaults to `true`. @@ -310,7 +310,7 @@ Default value: `$puppetdb::params::manage_pg_repo` ##### `postgres_version` -Data type: `Any` +Data type: `String[2,3]` If the postgresql.org repo is installed, you can install several versions of postgres. Defaults to `11` with PuppetDB version 7.0.0 or newer, and `9.6` in older versions. @@ -319,7 +319,7 @@ Default value: `$puppetdb::params::postgres_version` ##### `database_host` -Data type: `Any` +Data type: `Stdlib::Host` Hostname to use for the database connection. For single case installations this should be left as the default. Defaults to `localhost`. @@ -328,7 +328,7 @@ Default value: `$puppetdb::params::database_host` ##### `database_port` -Data type: `Any` +Data type: `Variant[Stdlib::Port::User, Pattern[/\A[0-9]+\Z/]]` The port that the database server listens on. Defaults to `5432`. @@ -336,7 +336,7 @@ Default value: `$puppetdb::params::database_port` ##### `database_username` -Data type: `Any` +Data type: `String[1]` The name of the database user to connect as. Defaults to `puppetdb`. @@ -352,7 +352,7 @@ Default value: `$puppetdb::params::database_password` ##### `manage_db_password` -Data type: `Any` +Data type: `Boolean` Whether or not the database password in database.ini will be managed by this module. Set this to `false` if you want to set the password some other way. @@ -362,7 +362,7 @@ Default value: `$puppetdb::params::manage_db_password` ##### `database_name` -Data type: `Any` +Data type: `String[1]` The name of the database instance to connect to. Defaults to `puppetdb`. @@ -370,7 +370,7 @@ Default value: `$puppetdb::params::database_name` ##### `jdbc_ssl_properties` -Data type: `Any` +Data type: `Variant[String[0], Boolean[false]]` The text to append to the JDBC connection URI. This should begin with a '?' character. For example, to use SSL for the PostgreSQL connection, set this @@ -380,7 +380,7 @@ Default value: `$puppetdb::params::jdbc_ssl_properties` ##### `database_listen_address` -Data type: `Any` +Data type: `String[1]` A comma-separated list of hostnames or IP addresses on which the postgres server should listen for incoming connections. This defaults to `localhost`. @@ -391,7 +391,7 @@ Default value: `$puppetdb::params::postgres_listen_addresses` ##### `database_validate` -Data type: `Any` +Data type: `Boolean` If true, the module will attempt to connect to the database using the specified settings and fail if it is not able to do so. Defaults to `true`. @@ -400,7 +400,7 @@ Default value: `$puppetdb::params::database_validate` ##### `node_ttl` -Data type: `Any` +Data type: `Pattern[/\A[0-9dhms]+\Z/]` The length of time a node can go without receiving any new data before it's automatically deactivated. (defaults to '7d', which is a 7-day period. Set to @@ -411,7 +411,7 @@ Default value: `$puppetdb::params::node_ttl` ##### `node_purge_ttl` -Data type: `Any` +Data type: `Pattern[/\A[0-9dhms]+\Z/]` The length of time a node can be deactivated before it's deleted from the database. (defaults to '14d', which is a 14-day period. Set to '0d' to disable @@ -421,7 +421,7 @@ Default value: `$puppetdb::params::node_purge_ttl` ##### `report_ttl` -Data type: `Any` +Data type: `Pattern[/\A[0-9dhms]+\Z/]` The length of time reports should be stored before being deleted. (defaults to `14d`, which is a 14-day period). This option is supported in PuppetDB >= 1.1.0. @@ -438,7 +438,7 @@ Default value: `$puppetdb::params::facts_blacklist` ##### `gc_interval` -Data type: `Any` +Data type: `Variant[Integer[0], Pattern[/\A[0-9]+\Z/]]` This controls how often (in minutes) to compact the database. The compaction process reclaims space and deletes unnecessary rows. If not supplied, the @@ -448,7 +448,7 @@ Default value: `$puppetdb::params::gc_interval` ##### `node_purge_gc_batch_limit` -Data type: `Any` +Data type: `Variant[Integer[0], Pattern[/\A[0-9]+\Z/]]` Nodes will be purged in batches of this size, one batch per gc-interval. @@ -456,7 +456,7 @@ Default value: `$puppetdb::params::node_purge_gc_batch_limit` ##### `conn_max_age` -Data type: `Any` +Data type: `Variant[Integer[0], Pattern[/\A[0-9]+\Z/]]` The maximum time (in minutes) for a pooled connection to remain unused before it is closed off. @@ -467,7 +467,7 @@ Default value: `$puppetdb::params::conn_max_age` ##### `conn_lifetime` -Data type: `Any` +Data type: `Variant[Integer[0], Pattern[/\A[0-9]+\Z/]]` The maximum time (in minutes) a pooled connection should remain open. Any connections older than this setting will be closed off. Connections currently in @@ -480,7 +480,7 @@ Default value: `$puppetdb::params::conn_lifetime` ##### `puppetdb_package` -Data type: `Any` +Data type: `String[1]` The PuppetDB package name in the package manager. Defaults to `present`. @@ -488,7 +488,7 @@ Default value: `$puppetdb::params::puppetdb_package` ##### `puppetdb_service` -Data type: `Any` +Data type: `String[1]` The name of the PuppetDB service. Defaults to `puppetdb`. @@ -496,7 +496,7 @@ Default value: `$puppetdb::params::puppetdb_service` ##### `puppetdb_service_status` -Data type: `Any` +Data type: `Enum['running', 'true', 'stopped', 'false']` Sets whether the service should be `running ` or `stopped`. When set to `stopped` the service doesn't start on boot either. Valid values are `true`, `running`, @@ -506,7 +506,7 @@ Default value: `$puppetdb::params::puppetdb_service_status` ##### `puppetdb_user` -Data type: `Any` +Data type: `String[1]` Puppetdb service user @@ -514,7 +514,7 @@ Default value: `$puppetdb::params::puppetdb_user` ##### `puppetdb_group` -Data type: `Any` +Data type: `String[1]` Puppetdb service group @@ -522,7 +522,7 @@ Default value: `$puppetdb::params::puppetdb_group` ##### `puppetdb_server` -Data type: `Any` +Data type: `Stdlib::Host` Puppetdb server hostname or IP address. @@ -530,7 +530,7 @@ Default value: `$puppetdb::params::puppetdb_server` ##### `confdir` -Data type: `Any` +Data type: `Stdlib::Absolutepath` The PuppetDB configuration directory. Defaults to `/etc/puppetdb/conf.d`. @@ -538,7 +538,7 @@ Default value: `$puppetdb::params::confdir` ##### `vardir` -Data type: `Any` +Data type: `Stdlib::Absolutepath` The parent directory for the MQ's data directory. @@ -546,7 +546,7 @@ Default value: `$puppetdb::params::vardir` ##### `java_args` -Data type: `Any` +Data type: `Hash` Java VM options used for overriding default Java VM options specified in PuppetDB package. Defaults to `{}`. See @@ -564,7 +564,7 @@ Default value: `$puppetdb::params::java_args` ##### `merge_default_java_args` -Data type: `Any` +Data type: `Boolean` Sets whether the provided java args should be merged with the defaults, or should override the defaults. This setting is necessary if any of the defaults @@ -575,7 +575,7 @@ Default value: `$puppetdb::params::merge_default_java_args` ##### `max_threads` -Data type: `Any` +Data type: `Optional[Integer[0]]` Jetty option to explicitly set `max-threads`. Defaults to `undef`, so the PuppetDB-Jetty default is used. @@ -584,7 +584,7 @@ Default value: `$puppetdb::params::max_threads` ##### `read_database_host` -Data type: `Any` +Data type: `Optional[Stdlib::Host]` *This parameter must be set to use another PuppetDB instance for queries.* @@ -596,7 +596,7 @@ Default value: `$puppetdb::params::read_database_host` ##### `read_database_port` -Data type: `Any` +Data type: `Variant[Stdlib::Port::User, Pattern[/\A[0-9]+\Z/]]` The port that the read database server listens on. If `read_database_host` is set to `undef`, and `manage_database` is set to `true`, it will use the value of @@ -606,7 +606,7 @@ Default value: `$puppetdb::params::read_database_port` ##### `read_database_username` -Data type: `Any` +Data type: `String[1]` The name of the read database user to connect as. Defaults to `puppetdb-read`. This option is supported in PuppetDB >= 1.6. @@ -624,7 +624,7 @@ Default value: `$puppetdb::params::read_database_password` ##### `manage_read_db_password` -Data type: `Any` +Data type: `Boolean` Whether or not the database password in read-database.ini will be managed by this module. Set this to `false` if you want to set the password some other way. @@ -634,7 +634,7 @@ Default value: `$puppetdb::params::manage_read_db_password` ##### `read_database_jdbc_ssl_properties` -Data type: `Any` +Data type: `Variant[String[0], Boolean[false]]` The text to append to the JDBC connection URI. This should begin with a '?' character. For example, to use SSL for the PostgreSQL connection, set this @@ -644,7 +644,7 @@ Default value: `$puppetdb::params::read_database_jdbc_ssl_properties` ##### `read_database_validate` -Data type: `Any` +Data type: `Boolean` If true, the module will attempt to connect to the database using the specified settings and fail if it is not able to do so. Defaults to `true`. @@ -653,7 +653,7 @@ Default value: `$puppetdb::params::read_database_validate` ##### `read_database_name` -Data type: `Any` +Data type: `String[1]` The name of the read database instance to connect to. If `read_database_host` is set to `undef`, and `manage_database` is set to `true`, it will use the value of @@ -663,7 +663,7 @@ Default value: `$puppetdb::params::read_database_name` ##### `read_conn_max_age` -Data type: `Any` +Data type: `Variant[Integer[0], Pattern[/\A[0-9]+\Z/]]` The maximum time (in minutes) for a pooled read database connection to remain unused before it is closed off. @@ -674,7 +674,7 @@ Default value: `$puppetdb::params::read_conn_max_age` ##### `read_conn_lifetime` -Data type: `Any` +Data type: `Variant[Integer[0], Pattern[/\A[0-9]+\Z/]]` The maximum time (in minutes) a pooled read database connection should remain open. Any connections older than this setting will be closed off. Connections @@ -687,7 +687,7 @@ Default value: `$puppetdb::params::read_conn_lifetime` ##### `ssl_dir` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Base directory for PuppetDB SSL configuration. Defaults to `/etc/puppetdb/ssl` or `/etc/puppetlabs/puppetdb/ssl` for FOSS and PE respectively. @@ -696,7 +696,7 @@ Default value: `$puppetdb::params::ssl_dir` ##### `ssl_set_cert_paths` -Data type: `Any` +Data type: `Boolean` A switch to enable or disable the management of SSL certificates in your `jetty.ini` configuration file. @@ -705,7 +705,7 @@ Default value: `$puppetdb::params::ssl_set_cert_paths` ##### `ssl_cert_path` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to your SSL certificate for populating `jetty.ini`. @@ -713,7 +713,7 @@ Default value: `$puppetdb::params::ssl_cert_path` ##### `ssl_key_pk8_path` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to the SSL pk8 key for populating `jetty.ini`, will be generated from the SSL key as needed automatically. @@ -722,7 +722,7 @@ Default value: `$puppetdb::params::ssl_key_pk8_path` ##### `ssl_key_path` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to your SSL key for populating `jetty.ini`. @@ -730,7 +730,7 @@ Default value: `$puppetdb::params::ssl_key_path` ##### `ssl_ca_cert_path` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to your SSL CA for populating `jetty.ini`. @@ -738,7 +738,7 @@ Default value: `$puppetdb::params::ssl_ca_cert_path` ##### `ssl_deploy_certs` -Data type: `Any` +Data type: `Boolean` A boolean switch to enable or disable the management of SSL keys in your `ssl_dir`. Default is `false`. @@ -747,7 +747,7 @@ Default value: `$puppetdb::params::ssl_deploy_certs` ##### `ssl_key` -Data type: `Any` +Data type: `Optional[String[1]]` Contents of your SSL key, as a string. @@ -755,7 +755,7 @@ Default value: `$puppetdb::params::ssl_key` ##### `ssl_cert` -Data type: `Any` +Data type: `Optional[String[1]]` Contents of your SSL certificate, as a string. @@ -763,7 +763,7 @@ Default value: `$puppetdb::params::ssl_cert` ##### `ssl_ca_cert` -Data type: `Any` +Data type: `Optional[String[1]]` Contents of your SSL CA certificate, as a string. @@ -771,7 +771,7 @@ Default value: `$puppetdb::params::ssl_ca_cert` ##### `manage_firewall` -Data type: `Any` +Data type: `Boolean` If `true`, puppet will manage your iptables rules for PuppetDB via the [puppetlabs-firewall](https://forge.puppetlabs.com/puppetlabs/firewall) class. @@ -780,7 +780,7 @@ Default value: `$puppetdb::params::manage_firewall` ##### `command_threads` -Data type: `Any` +Data type: `Optional[Integer[0]]` The number of command processing threads to use. Defaults to `undef`, using the PuppetDB built-in default. @@ -789,7 +789,7 @@ Default value: `$puppetdb::params::command_threads` ##### `concurrent_writes` -Data type: `Any` +Data type: `Optional[Integer[0]]` The number of threads allowed to write to disk at any one time. Defaults to `undef`, which uses the PuppetDB built-in default. @@ -798,7 +798,7 @@ Default value: `$puppetdb::params::concurrent_writes` ##### `store_usage` -Data type: `Any` +Data type: `Optional[Integer[0]]` The amount of disk space (in MB) to allow for persistent message storage. Defaults to `undef`, using the PuppetDB built-in default. @@ -807,7 +807,7 @@ Default value: `$puppetdb::params::store_usage` ##### `temp_usage` -Data type: `Any` +Data type: `Optional[Integer[0]]` The amount of disk space (in MB) to allow for temporary message storage. Defaults to `undef`, using the PuppetDB built-in default. @@ -816,7 +816,7 @@ Default value: `$puppetdb::params::temp_usage` ##### `disable_update_checking` -Data type: `Any` +Data type: `Optional[Boolean]` Setting this to true disables checking for updated versions of PuppetDB and sending basic analytics data to Puppet. Defaults to `undef`, using the PuppetDB built-in default. @@ -825,7 +825,7 @@ Default value: `$puppetdb::params::disable_update_checking` ##### `certificate_whitelist_file` -Data type: `Any` +Data type: `Stdlib::Absolutepath` The name of the certificate whitelist file to set up and configure in PuppetDB. Defaults to `/etc/puppetdb/certificate-whitelist` or `/etc/puppetlabs/puppetdb/certificate-whitelist` for FOSS and PE respectively. @@ -833,7 +833,7 @@ Default value: `$puppetdb::params::certificate_whitelist_file` ##### `certificate_whitelist` -Data type: `Any` +Data type: `Array` Array of the X.509 certificate Common Names of clients allowed to connect to PuppetDB. Defaults to empty. Be aware that this permits full access to all Puppet clients to download anything contained in PuppetDB, including the full catalogs of all nodes, which possibly contain sensitive information. Set to `[ $::servername ]` to allow access only from your (single) Puppet master, which is enough for normal operation. Set to a list of Puppet masters if you have multiple. @@ -841,7 +841,7 @@ Default value: `$puppetdb::params::certificate_whitelist` ##### `database_max_pool_size` -Data type: `Any` +Data type: `Optional[Variant[Integer[0], Enum['absent'], Pattern[/\A[0-9]+\Z/]]]` When the pool reaches this size, and no idle connections are available, attempts to get a connection will wait for connection-timeout milliseconds before timing out. Note that PuppetDB will use one pool for writes and another for reads, so the total number of connections used will be twice this setting. @@ -850,7 +850,7 @@ Default value: `$puppetdb::params::database_max_pool_size` ##### `read_database_max_pool_size` -Data type: `Any` +Data type: `Optional[Variant[Integer[0], Enum['absent'], Pattern[/\A[0-9]+\Z/]]]` When the pool reaches this size, and no idle connections are available, attempts to get a connection will wait for connection-timeout milliseconds before timing out. Note that PuppetDB will use one pool for writes and another for reads, so the total number of connections used will be twice this setting. @@ -938,7 +938,7 @@ The following parameters are available in the `puppetdb::database::postgresql` c ##### `listen_addresses` -Data type: `Any` +Data type: `Stdlib::Host` The `listen_address` is a comma-separated list of hostnames or IP addresses on which the postgres server should listen for incoming connections. This defaults @@ -949,7 +949,7 @@ Default value: `$puppetdb::params::database_host` ##### `puppetdb_server` -Data type: `Any` +Data type: `Stdlib::Host` Hostname or IP address to configure for SSL rules. @@ -957,7 +957,7 @@ Default value: `$puppetdb::params::puppetdb_server` ##### `database_name` -Data type: `Any` +Data type: `String[1]` Sets the name of the database. Defaults to `puppetdb`. @@ -965,7 +965,7 @@ Default value: `$puppetdb::params::database_name` ##### `database_username` -Data type: `Any` +Data type: `String[1]` Creates a user for access the database. Defaults to `puppetdb`. @@ -981,7 +981,7 @@ Default value: `$puppetdb::params::database_password` ##### `database_port` -Data type: `Any` +Data type: `Variant[Stdlib::Port::User, Pattern[/\A[0-9]+\Z/]]` The port that the database server listens on. Defaults to `5432`. @@ -989,7 +989,7 @@ Default value: `$puppetdb::params::database_port` ##### `manage_database` -Data type: `Any` +Data type: `Boolean` If true, the PostgreSQL database will be managed by this module. Defaults to `true`. @@ -997,7 +997,7 @@ Default value: `$puppetdb::params::manage_database` ##### `manage_server` -Data type: `Any` +Data type: `Boolean` Conditionally manages the PostgreSQL server via `postgresql::server`. Defaults to `true`. If set to `false`, this class will create the database and user via @@ -1007,7 +1007,7 @@ Default value: `$puppetdb::params::manage_dbserver` ##### `manage_package_repo` -Data type: `Any` +Data type: `Boolean` If `true`, the official postgresql.org repo will be added and postgres won't be installed from the regular repository. Defaults to `true`. @@ -1016,7 +1016,7 @@ Default value: `$puppetdb::params::manage_pg_repo` ##### `postgres_version` -Data type: `Any` +Data type: `String[2,3]` If the postgresql.org repo is installed, you can install several versions of postgres. Defaults to `11` with PuppetDB version 7.0.0 or newer, and `9.6` in older versions. @@ -1025,7 +1025,7 @@ Default value: `$puppetdb::params::postgres_version` ##### `postgresql_ssl_on` -Data type: `Any` +Data type: `Boolean` If `true`, it configures SSL connections between PuppetDB and the PostgreSQL database. Defaults to `false`. @@ -1034,7 +1034,7 @@ Default value: `$puppetdb::params::postgresql_ssl_on` ##### `postgresql_ssl_cert_path` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to the Postgresql SSL certificate. @@ -1042,7 +1042,7 @@ Default value: `$puppetdb::params::postgresql_ssl_cert_path` ##### `postgresql_ssl_key_path` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to the Postgresql SSL key. @@ -1050,7 +1050,7 @@ Default value: `$puppetdb::params::postgresql_ssl_key_path` ##### `postgresql_ssl_ca_cert_path` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Path to the Postgresql SSL CA. @@ -1058,7 +1058,7 @@ Default value: `$puppetdb::params::postgresql_ssl_ca_cert_path` ##### `read_database_username` -Data type: `Any` +Data type: `String[1]` The name of the read database user to connect as. Defaults to `puppetdb-read`. This option is supported in PuppetDB >= 1.6. @@ -1076,7 +1076,7 @@ Default value: `$puppetdb::params::read_database_password` ##### `read_database_host` -Data type: `Any` +Data type: `Optional[Stdlib::Host]` *This parameter must be set to use another PuppetDB instance for queries.* @@ -1115,7 +1115,7 @@ The following parameters are available in the `puppetdb::globals` class: ##### `version` -Data type: `Any` +Data type: `String[1]` The version of the `puppetdb` package that should be installed. You may specify an explicit version number, 'present', or 'latest' (defaults to 'present'). @@ -1161,7 +1161,7 @@ The following parameters are available in the `puppetdb::master::config` class: ##### `puppetdb_server` -Data type: `Any` +Data type: `Stdlib::Host` The dns name or ip of the PuppetDB server. Defaults to the hostname of the current node, i.e. `$::fqdn`. @@ -1170,7 +1170,7 @@ Default value: `fact('networking.fqdn')` ##### `puppetdb_port` -Data type: `Any` +Data type: `Variant[Stdlib::Port::User, Pattern[/\A[0-9]+\Z/]]` The port that the PuppetDB server is running on. Defaults to `8081`. @@ -1187,7 +1187,7 @@ defined(Class['puppetdb']) ? { ##### `puppetdb_disable_ssl` -Data type: `Any` +Data type: `Boolean` If true, use plain HTTP to talk to PuppetDB. Defaults to the value of `disable_ssl` if PuppetDB is on the same server as the Puppet Master, or else @@ -1204,7 +1204,7 @@ defined(Class['puppetdb']) ? { ##### `puppetdb_soft_write_failure` -Data type: `Any` +Data type: `Boolean` Boolean to fail in a soft manner if PuppetDB is not accessible for command submission Defaults to `false`. @@ -1213,7 +1213,7 @@ Default value: `false` ##### `manage_routes` -Data type: `Any` +Data type: `Boolean` If `true`, the module will overwrite the Puppet master's routes file to configure it to use PuppetDB. Defaults to `true`. @@ -1222,7 +1222,7 @@ Default value: `true` ##### `manage_storeconfigs` -Data type: `Any` +Data type: `Boolean` If `true`, the module will manage the Puppet master's storeconfig settings. Defaults to `true`. @@ -1231,7 +1231,7 @@ Default value: `true` ##### `manage_report_processor` -Data type: `Any` +Data type: `Boolean` If `true`, the module will manage the 'reports' field in the puppet.conf file to enable or disable the PuppetDB report processor. Defaults to `false`. @@ -1240,7 +1240,7 @@ Default value: `false` ##### `manage_config` -Data type: `Any` +Data type: `Boolean` If `true`, the module will store values from `puppetdb_server` and `puppetdb_port` parameters in the PuppetDB configuration file. If `false`, an existing PuppetDB @@ -1250,7 +1250,7 @@ Default value: `true` ##### `create_puppet_service_resource` -Data type: `Any` +Data type: `Boolean` If `true`, AND if `restart_puppet` is true, then the module will create a service resource for `puppet_service_name` if it has not been defined. Defaults to `true`. @@ -1262,7 +1262,7 @@ Default value: `true` ##### `strict_validation` -Data type: `Any` +Data type: `Boolean` If `true`, the module will fail if PuppetDB is not reachable, otherwise it will preconfigure PuppetDB without checking. @@ -1271,7 +1271,7 @@ Default value: `true` ##### `enable_reports` -Data type: `Any` +Data type: `Boolean` Ignored unless `manage_report_processor` is `true`, in which case this setting will determine whether or not the PuppetDB report processor is enabled (`true`) @@ -1281,7 +1281,7 @@ Default value: `false` ##### `enable_storeconfigs` -Data type: `Any` +Data type: `Boolean` Ignored unless `manage_storeconfigs` is `true`, in which case this setting will determine whether or not client configuration storage is enabled (`true`) @@ -1291,7 +1291,7 @@ Default value: `true` ##### `puppet_confdir` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Puppet's config directory. Defaults to `/etc/puppetlabs/puppet`. @@ -1299,7 +1299,7 @@ Default value: `$puppetdb::params::puppet_confdir` ##### `puppet_conf` -Data type: `Any` +Data type: `Stdlib::Absolutepath` Puppet's config file. Defaults to `${puppet_confdir}/puppet.conf`. @@ -1307,7 +1307,7 @@ Default value: `$puppetdb::params::puppet_conf` ##### `masterless` -Data type: `Any` +Data type: `Boolean` A boolean switch to enable or disable the masterless setup of PuppetDB. Defaults to `false`. @@ -1316,7 +1316,7 @@ Default value: `$puppetdb::params::masterless` ##### `terminus_package` -Data type: `Any` +Data type: `String[1]` Name of the package to use that represents the PuppetDB terminus code. Defaults to `puppetdb-termini`, when `puppetdb_version` is set to `<= 2.3.x` the default @@ -1326,7 +1326,7 @@ Default value: `$puppetdb::params::terminus_package` ##### `puppet_service_name` -Data type: `Any` +Data type: `String[1]` Name of the service that represents Puppet. You can change this to `apache2` or `httpd` depending on your operating system, if you plan on having Puppet run @@ -1336,17 +1336,17 @@ Default value: `$puppetdb::params::puppet_service_name` ##### `puppetdb_startup_timeout` -Data type: `Any` +Data type: `Integer[0]` The maximum amount of time that the module should wait for PuppetDB to start up. -This is most important during the initial install of PuppetDB (defaults to 15 +This is most important during the initial install of PuppetDB (defaults to 120 seconds). Default value: `$puppetdb::params::puppetdb_startup_timeout` ##### `test_url` -Data type: `Any` +Data type: `String[1]` The URL to use for testing if the PuppetDB instance is running. @@ -1354,7 +1354,7 @@ Default value: `$puppetdb::params::test_url` ##### `restart_puppet` -Data type: `Any` +Data type: `Boolean` If `true`, the module will restart the Puppet master when PuppetDB configuration files are changed by the module. Defaults to `true`. If set to `false`, you @@ -1447,7 +1447,7 @@ The following parameters are available in the `puppetdb::server` class: ##### `listen_address` -Data type: `Any` +Data type: `Stdlib::Host` The address that the web server should bind to for HTTP requests. Defaults to `localhost`. Set to `0.0.0.0` to listen on all addresses. @@ -1456,7 +1456,7 @@ Default value: `$puppetdb::params::listen_address` ##### `listen_port` -Data type: `Any` +Data type: `Variant[Stdlib::Port::User, Pattern[/\A[0-9]+\Z/]]` The port on which the puppetdb web server should accept HTTP requests. Defaults to `8080`. @@ -1465,7 +1465,7 @@ Default value: `$puppetdb::params::listen_port` ##### `disable_cleartext` -Data type: `Any` +Data type: `Boolean` If `true`, the puppetdb web server will only serve HTTPS and not HTTP requests (defaults to false). @@ -1473,7 +1473,7 @@ Default value: `$puppetdb::params::disable_cleartext` ##### `open_listen_port` -Data type: `Any` +Data type: `Boolean` If `true`, open the `http_listen_port` on the firewall. Defaults to `false`. @@ -1481,7 +1481,7 @@ Default value: `$puppetdb::params::open_listen_port` ##### `ssl_listen_address` -Data type: `Any` +Data type: `Stdlib::Host` The address that the web server should bind to for HTTPS requests. Defaults to `0.0.0.0` to listen on all addresses. @@ -1490,7 +1490,7 @@ Default value: `$puppetdb::params::ssl_listen_address` ##### `ssl_listen_port` -Data type: `Any` +Data type: `Variant[Stdlib::Port::User, Pattern[/\A[0-9]+\Z/]]` The port on which the puppetdb web server should accept HTTPS requests. Defaults to `8081`. @@ -1499,7 +1499,7 @@ Default value: `$puppetdb::params::ssl_listen_port` ##### `disable_ssl` -Data type: `Any` +Data type: `Boolean` If `true`, the puppetdb web server will only serve HTTP and not HTTPS requests. Defaults to `false`. @@ -1508,7 +1508,7 @@ Default value: `$puppetdb::params::disable_ssl` ##### `open_ssl_listen_port` -Data type: `Any` +Data type: `Boolean` If true, open the `ssl_listen_port` on the firewall. Defaults to `undef`. @@ -1516,7 +1516,7 @@ Default value: `$puppetdb::params::open_ssl_listen_port` ##### `ssl_protocols` -Data type: `Any` +Data type: `Optional[String[1]]` Specify the supported SSL protocols for PuppetDB (e.g. TLSv1, TLSv1.1, TLSv1.2.) @@ -1524,7 +1524,7 @@ Default value: `$puppetdb::params::ssl_protocols` ##### `postgresql_ssl_on` -Data type: `Any` +Data type: `Boolean` If `true`, it configures SSL connections between PuppetDB and the PostgreSQL database. Defaults to `false`. @@ -1533,7 +1533,7 @@ Default value: `$puppetdb::params::postgresql_ssl_on` ##### `cipher_suites` -Data type: `Any` +Data type: `Optional[String[1]]` Configure jetty's supported `cipher-suites` (e.g. `SSL_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384`). Defaults to `undef`. @@ -1542,7 +1542,7 @@ Default value: `$puppetdb::params::cipher_suites` ##### `migrate` -Data type: `Any` +Data type: `Boolean` If `true`, puppetdb will automatically migrate to the latest database format at startup. If `false`, if the database format supplied by this version of PuppetDB doesn't match the version expected (whether newer or older), PuppetDB will exit with an error status. Defaults to `true`. @@ -1550,7 +1550,7 @@ Default value: `$puppetdb::params::migrate` ##### `manage_database` -Data type: `Any` +Data type: `Boolean` If true, the PostgreSQL database will be managed by this module. Defaults to `true`. @@ -1558,7 +1558,7 @@ Default value: `$puppetdb::params::manage_database` ##### `database_host` -Data type: `Any` +Data type: `Stdlib::Host` Hostname to use for the database connection. For single case installations this should be left as the default. Defaults to `localhost`. @@ -1567,7 +1567,7 @@ Default value: `$puppetdb::params::database_host` ##### `database_port` -Data type: `Any` +Data type: `Variant[Stdlib::Port::User, Pattern[/\A[0-9]+\Z/]]` The port that the database server listens on. Defaults to `5432`. @@ -1575,7 +1575,7 @@ Default value: `$puppetdb::params::database_port` ##### `database_username` -Data type: `Any` +Data type: `String[1]` The name of the database user to connect as. Defaults to `puppetdb`. @@ -1591,7 +1591,7 @@ Default value: `$puppetdb::params::database_password` ##### `manage_db_password` -Data type: `Any` +Data type: `Boolean` Whether or not the database password in database.ini will be managed by this module. Set this to `false` if you want to set the password some other way. @@ -1601,7 +1601,7 @@ Default value: `$puppetdb::params::manage_db_password` ##### `database_name` -Data type: `Any` +Data type: `String[1]` The name of the database instance to connect to. Defaults to `puppetdb`. @@ -1609,7 +1609,7 @@ Default value: `$puppetdb::params::database_name` ##### `jdbc_ssl_properties` -Data type: `Any` +Data type: `Variant[String[0], Boolean[false]]` The text to append to the JDBC connection URI. This should begin with a '?' character. For example, to use SSL for the PostgreSQL connection, set this @@ -1619,7 +1619,7 @@ Default value: `$puppetdb::params::jdbc_ssl_properties` ##### `database_validate` -Data type: `Any` +Data type: `Boolean` If true, the module will attempt to connect to the database using the specified settings and fail if it is not able to do so. Defaults to `true`. @@ -1628,7 +1628,7 @@ Default value: `$puppetdb::params::database_validate` ##### `node_ttl` -Data type: `Any` +Data type: `Pattern[/\A[0-9dhms]+\Z/]` The length of time a node can go without receiving any new data before it's automatically deactivated. (defaults to '7d', which is a 7-day period. Set to @@ -1639,7 +1639,7 @@ Default value: `$puppetdb::params::node_ttl` ##### `node_purge_ttl` -Data type: `Any` +Data type: `Pattern[/\A[0-9dhms]+\Z/]` The length of time a node can be deactivated before it's deleted from the database. (defaults to '14d', which is a 14-day period. Set to '0d' to disable @@ -1649,7 +1649,7 @@ Default value: `$puppetdb::params::node_purge_ttl` ##### `report_ttl` -Data type: `Any` +Data type: `Pattern[/\A[0-9dhms]+\Z/]` The length of time reports should be stored before being deleted. (defaults to `14d`, which is a 14-day period). This option is supported in PuppetDB >= 1.1.0. @@ -1666,7 +1666,7 @@ Default value: `$puppetdb::params::facts_blacklist` ##### `gc_interval` -Data type: `Any` +Data type: `Variant[Integer[0], Pattern[/\A[0-9]+\Z/]]` This controls how often (in minutes) to compact the database. The compaction process reclaims space and deletes unnecessary rows. If not supplied, the @@ -1676,7 +1676,7 @@ Default value: `$puppetdb::params::gc_interval` ##### `node_purge_gc_batch_limit` -Data type: `Any` +Data type: `Variant[Integer[0], Pattern[/\A[0-9]+\Z/]]` Nodes will be purged in batches of this size, one batch per gc-interval. @@ -1684,7 +1684,7 @@ Default value: `$puppetdb::params::node_purge_gc_batch_limit` ##### `conn_max_age` -Data type: `Any` +Data type: `Variant[Integer[0], Pattern[/\A[0-9]+\Z/]]` The maximum time (in minutes) for a pooled connection to remain unused before it is closed off. @@ -1695,7 +1695,7 @@ Default value: `$puppetdb::params::conn_max_age` ##### `conn_lifetime` -Data type: `Any` +Data type: `Variant[Integer[0], Pattern[/\A[0-9]+\Z/]]` The maximum time (in minutes) a pooled connection should remain open. Any connections older than this setting will be closed off. Connections currently in @@ -1708,7 +1708,7 @@ Default value: `$puppetdb::params::conn_lifetime` ##### `puppetdb_package` -Data type: `Any` +Data type: `String[1]` The PuppetDB package name in the package manager. Defaults to `present`. @@ -1716,7 +1716,7 @@ Default value: `$puppetdb::params::puppetdb_package` ##### `puppetdb_service` -Data type: `Any` +Data type: `String[1]` The name of the PuppetDB service. Defaults to `puppetdb`. @@ -1724,7 +1724,7 @@ Default value: `$puppetdb::params::puppetdb_service` ##### `puppetdb_service_status` -Data type: `Any` +Data type: `Enum['running', 'true', 'stopped', 'false']` Sets whether the service should be `running ` or `stopped`. When set to `stopped` the service doesn't start on boot either. Valid values are `true`, `running`, @@ -1734,7 +1734,7 @@ Default value: `$puppetdb::params::puppetdb_service_status` ##### `puppetdb_user` -Data type: `Any` +Data type: `String[1]` Puppetdb service user @@ -1742,7 +1742,7 @@ Default value: `$puppetdb::params::puppetdb_user` ##### `puppetdb_group` -Data type: `Any` +Data type: `String[1]` Puppetdb service group @@ -1750,7 +1750,7 @@ Default value: `$puppetdb::params::puppetdb_group` ##### `confdir` -Data type: `Any` +Data type: `Stdlib::Absolutepath` The PuppetDB configuration directory. Defaults to `/etc/puppetdb/conf.d`. @@ -1758,7 +1758,7 @@ Default value: `$puppetdb::params::confdir` ##### `vardir` -Data type: `Any` +Data type: `Stdlib::Absolutepath` The parent directory for the MQ's data directory. @@ -1766,7 +1766,7 @@ Default value: `$puppetdb::params::vardir` ##### `java_args` -Data type: `Any` +Data type: `Hash` Java VM options used for overriding default Java VM options specified in PuppetDB package. Defaults to `{}`. See @@ -1784,7 +1784,7 @@ Default value: `$puppetdb::params::java_args` ##### `merge_default_java_args` -Data type: `Any` +Data type: `Boolean` Sets whether the provided java args should be merged with the defaults, or should override the defaults. This setting is necessary if any of the defaults @@ -1795,7 +1795,7 @@ Default value: `$puppetdb::params::merge_default_java_args` ##### `max_threads` -Data type: `Any` +Data type: `Optional[Integer[0]]` Jetty option to explicitly set `max-threads`. Defaults to `undef`, so the PuppetDB-Jetty default is used. @@ -1804,7 +1804,7 @@ Default value: `$puppetdb::params::max_threads` ##### `read_database_host` -Data type: `Any` +Data type: `Optional[Stdlib::Host]` *This parameter must be set to use another PuppetDB instance for queries.* @@ -1816,7 +1816,7 @@ Default value: `$puppetdb::params::read_database_host` ##### `read_database_port` -Data type: `Any` +Data type: `Variant[Stdlib::Port::User, Pattern[/\A[0-9]+\Z/]]` The port that the read database server listens on. If `read_database_host` is set to `undef`, and `manage_database` is set to `true`, it will use the value of @@ -1826,7 +1826,7 @@ Default value: `$puppetdb::params::read_database_port` ##### `read_database_username` -Data type: `Any` +Data type: `String[1]` The name of the read database user to connect as. Defaults to `puppetdb-read`. This option is supported in PuppetDB >= 1.6. @@ -1844,7 +1844,7 @@ Default value: `$puppetdb::params::read_database_password` ##### `manage_read_db_password` -Data type: `Any` +Data type: `Boolean` Whether or not the database password in read-database.ini will be managed by this module. Set this to `false` if you want to set the password some other way. @@ -1854,7 +1854,7 @@ Default value: `$puppetdb::params::manage_read_db_password` ##### `read_database_jdbc_ssl_properties` -Data type: `Any` +Data type: `Variant[String[0], Boolean[false]]` The text to append to the JDBC connection URI. This should begin with a '?' character. For example, to use SSL for the PostgreSQL connection, set this @@ -1864,7 +1864,7 @@ Default value: `$puppetdb::params::read_database_jdbc_ssl_properties` ##### `read_database_validate` -Data type: `Any` +Data type: `Boolean` If true, the module will attempt to connect to the database using the specified settings and fail if it is not able to do so. Defaults to `true`. @@ -1873,7 +1873,7 @@ Default value: `$puppetdb::params::read_database_validate` ##### `read_database_name` -Data type: `Any` +Data type: `String[1]` The name of the read database instance to connect to. If `read_database_host` is set to `undef`, and `manage_database` is set to `true`, it will use the value of @@ -1883,7 +1883,7 @@ Default value: `$puppetdb::params::read_database_name` ##### `read_conn_max_age` -Data type: `Any` +Data type: `Variant[Integer, Pattern[/\A[0-9]+\Z/]]` The maximum time (in minutes) for a pooled read database connection to remain unused before it is closed off. @@ -1894,7 +1894,7 @@ Default value: `$puppetdb::params::read_conn_max_age` ##### `read_conn_lifetime` -Data type: `Any` +Data type: `Variant[Integer, Pattern[/\A[0-9]+\Z/]]` The maximum time (in minutes) a pooled read database connection should remain open. Any connections older than this setting will be closed off. Connections @@ -1967,7 +1967,7 @@ Default value: `$puppetdb::params::ssl_deploy_certs` ##### `ssl_key` -Data type: `Any` +Data type: `Optional[String[1]]` Contents of your SSL key, as a string. @@ -1975,7 +1975,7 @@ Default value: `$puppetdb::params::ssl_key` ##### `ssl_cert` -Data type: `Any` +Data type: `Optional[String[1]]` Contents of your SSL certificate, as a string. @@ -1983,7 +1983,7 @@ Default value: `$puppetdb::params::ssl_cert` ##### `ssl_ca_cert` -Data type: `Any` +Data type: `Optional[String[1]]` Contents of your SSL CA certificate, as a string. @@ -1991,7 +1991,7 @@ Default value: `$puppetdb::params::ssl_ca_cert` ##### `manage_firewall` -Data type: `Any` +Data type: `Boolean` If `true`, puppet will manage your iptables rules for PuppetDB via the [puppetlabs-firewall](https://forge.puppetlabs.com/puppetlabs/firewall) class. @@ -2000,7 +2000,7 @@ Default value: `$puppetdb::params::manage_firewall` ##### `command_threads` -Data type: `Any` +Data type: `Optional[Integer[0]]` The number of command processing threads to use. Defaults to `undef`, using the PuppetDB built-in default. @@ -2009,7 +2009,7 @@ Default value: `$puppetdb::params::command_threads` ##### `concurrent_writes` -Data type: `Any` +Data type: `Optional[Integer[0]]` The number of threads allowed to write to disk at any one time. Defaults to `undef`, which uses the PuppetDB built-in default. @@ -2018,7 +2018,7 @@ Default value: `$puppetdb::params::concurrent_writes` ##### `store_usage` -Data type: `Any` +Data type: `Optional[Integer[0]]` The amount of disk space (in MB) to allow for persistent message storage. Defaults to `undef`, using the PuppetDB built-in default. @@ -2027,7 +2027,7 @@ Default value: `$puppetdb::params::store_usage` ##### `temp_usage` -Data type: `Any` +Data type: `Optional[Integer[0]]` The amount of disk space (in MB) to allow for temporary message storage. Defaults to `undef`, using the PuppetDB built-in default. @@ -2036,7 +2036,7 @@ Default value: `$puppetdb::params::temp_usage` ##### `disable_update_checking` -Data type: `Any` +Data type: `Optional[Boolean]` Setting this to true disables checking for updated versions of PuppetDB and sending basic analytics data to Puppet. Defaults to `undef`, using the PuppetDB built-in default. @@ -2045,7 +2045,7 @@ Default value: `$puppetdb::params::disable_update_checking` ##### `certificate_whitelist_file` -Data type: `Any` +Data type: `Stdlib::Absolutepath` The name of the certificate whitelist file to set up and configure in PuppetDB. Defaults to `/etc/puppetdb/certificate-whitelist` or `/etc/puppetlabs/puppetdb/certificate-whitelist` for FOSS and PE respectively. @@ -2053,7 +2053,7 @@ Default value: `$puppetdb::params::certificate_whitelist_file` ##### `certificate_whitelist` -Data type: `Any` +Data type: `Array` Array of the X.509 certificate Common Names of clients allowed to connect to PuppetDB. Defaults to empty. Be aware that this permits full access to all Puppet clients to download anything contained in PuppetDB, including the full catalogs of all nodes, which possibly contain sensitive information. Set to `[ $::servername ]` to allow access only from your (single) Puppet master, which is enough for normal operation. Set to a list of Puppet masters if you have multiple. @@ -2061,7 +2061,7 @@ Default value: `$puppetdb::params::certificate_whitelist` ##### `database_max_pool_size` -Data type: `Any` +Data type: `Optional[Variant[Integer[0], Enum['absent'], Pattern[/\A[0-9]+\Z/]]]` When the pool reaches this size, and no idle connections are available, attempts to get a connection will wait for connection-timeout milliseconds before timing out. Note that PuppetDB will use one pool for writes and another for reads, so the total number of connections used will be twice this setting. @@ -2070,7 +2070,7 @@ Default value: `$puppetdb::params::database_max_pool_size` ##### `read_database_max_pool_size` -Data type: `Any` +Data type: `Optional[Variant[Integer[0], Enum['absent'], Pattern[/\A[0-9]+\Z/]]]` When the pool reaches this size, and no idle connections are available, attempts to get a connection will wait for connection-timeout milliseconds before timing out. Note that PuppetDB will use one pool for writes and another for reads, so the total number of connections used will be twice this setting.