puppetlabs.puppetdb.config — org.openvoxproject/puppetdb 8.12.1

Centralized place for reading a user-defined config INI file, validating, defaulting and converting into a format that can startup a PuppetDB instance.

The schemas in this file define what is expected to be present in the INI file and the format expected by the rest of the application.

add-web-routing-service-config clj

(add-web-routing-service-config config-data)

adjust-and-validate-tk-config clj

all-optional clj

(all-optional map-schema)

Returns a schema map with all the keys made optional

check-fact-regex clj

(check-fact-regex fact)

coerce-and-validate-final-config clj

(coerce-and-validate-final-config config schema-out)

command-processing-in clj

Schema for incoming command processing config (user defined) - currently incomplete

command-processing-out clj

Schema for parsed/processed command processing config - currently incomplete

config-service clj

configure-command-processing clj

(configure-command-processing config)

configure-dbs clj

(configure-dbs config)

configure-developer clj

(configure-developer config)

configure-globals clj

(configure-globals config)

Configures the global properties from the user defined config

configure-puppetdb clj

(configure-puppetdb config)

Validates the [puppetdb] section of the config

configure-read-db clj

(configure-read-db {:keys [database read-database] :as config})

Ensures that the config contains a suitable [read-database]. If the section already exists, validates and converts it to the internal format. Otherwise, creates it from values in the [database] section, which must have already been fully configured.

configure-section clj

(configure-section config section schema-in schema-out)

Validates the indicated top-level section of an incoming config and establishes defaults as specified by schema-in, and then coerces the values and validates the final result as specified by schema-out.

convert-blacklist-settings-to-blocklist clj

(convert-blacklist-settings-to-blocklist config)

convert-blocklist-config clj

(convert-blocklist-config config)

Validate and convert facts blocklist section of the config to runtime format. Throws a {:type ::cli-error :message m} exception describing errors when compiling facts-blocklist regex patterns if :facts-blocklist-type is set to "regex".

convert-certificate-whitelist-to-allowlist clj

(convert-certificate-whitelist-to-allowlist pdb-section)

convert-config clj

(convert-config config)

Given a config map (created from the user defined config), validate, default and convert it to the internal Clojure format that PuppetDB expects

convert-query-timeouts clj

(convert-query-timeouts config)

create-defaulted-config-service clj

(create-defaulted-config-service transform-config)

default-events-ttl clj

(default-events-ttl config)

default-max-command-size clj

(default-max-command-size)

Returns the max command size relative to the current max heap. This number was reached through testing of large catalogs and 1/205 was the largest catalog that could be processed without GC or out of memory errors

default-web-router-config clj

DefaultedConfig clj protocol

get-config clj

(get-config this)

developer-config-in clj

developer-config-out clj

ensure-connection-users-info clj

(ensure-connection-users-info config)

ensure-long-or-double clj

(ensure-long-or-double x)

ensure-migrator-info clj

(ensure-migrator-info config)

filter-out-non-tk-config clj

(filter-out-non-tk-config config-data)

fix-up-db-settings clj

(fix-up-db-settings section-key settings)

forbid-duplicate-write-db-subnames clj

(forbid-duplicate-write-db-subnames config)

foss? clj

(foss? config)

gc-intervals->periods clj

(gc-intervals->periods {:keys [gc-interval] :as config})

half-the-cores clj

Half the number of CPU cores, used for defaulting the number of command processors

half-the-cores* clj

(half-the-cores*)

Function for computing half the cores of the system, useful for testing.

hook-tk-parse-config-data clj

(hook-tk-parse-config-data f args)

This is a robert.hooke compatible hook that is designed to intercept trapperkeeper configuration before it is used, so that we may munge & customize it. It may throw {:type ::cli-error :message m}.

init-config-service clj

(init-config-service context config transform-config request-shutdown)

interval->period clj

(interval->period minutes)

max-command-size clj

(max-command-size config)

mq-thread-count clj

(mq-thread-count config)

Returns the desired number of MQ listener threads.

normalize-product-name clj

(normalize-product-name product-name)

Checks that product-name is specified as a legal value, throwing an exception if not. Returns product-name if it's okay.

pe? clj

(pe? config)

per-database-config-in clj

Schema for incoming database config (user defined)

per-database-config-out clj

Schema for parsed/processed database config

per-write-database-config-in clj

Includes the common database config params, also the write-db specific ones

per-write-database-config-out clj

Schema for parsed/processed database config that includes write database params

prefer-db-user-on-username-mismatch clj

(prefer-db-user-on-username-mismatch {:keys [user username] :as config}
                                     db-section-name)

process-config! clj

(process-config! config)

Accepts a map containing all of the user-provided configuration values and configures the various PuppetDB subsystems.

puppetdb-config-in clj

Schema for validating the incoming [puppetdb] block

puppetdb-config-out clj

Schema for validating the parsed/processed [puppetdb] block

redirect-obsolete-config-setting clj

(redirect-obsolete-config-setting config obsolete replacement)

reject-large-commands? clj

(reject-large-commands? config)

report-ttl-default clj

require-db-subname clj

(require-db-subname {:keys [subname] :as config} section-key)

Ensures the database config includes a subname. Throws a {:type ::cli-error :message m} on error.

require-enclosing-report-ttl clj

(require-enclosing-report-ttl {:keys [resource-events-ttl report-ttl]
                               :as config}
                              section-key)

Ensures the report-ttl is at least as long as the resource-events-ttl. Throws a {:type ::cli-error :message m} on error.

stockpile-dir clj

(stockpile-dir config)

throw-cli-error clj

(throw-cli-error msg)

using-ssl? clj

(using-ssl? config)

validate-and-default-incoming-config clj

(validate-and-default-incoming-config config schema-in)

validate-vardir clj

(validate-vardir config)

Checks that vardir is specified, exists, and is writeable, throwing appropriate exceptions if any condition is unmet.

warn-and-validate clj

(warn-and-validate schema data)

Warns a user about unknown configurations items, removes them and validates the config.

warn-if-mismatched-node-purge-ttls clj

(warn-if-mismatched-node-purge-ttls config)

Warn if the read-database has a node-purge-ttl that doesn't match the value for a database with the same subname.

warn-retirements clj

(warn-retirements config-data)

Warns about configuration retirements. Abruptly exits the entire process if a [global] url-prefix is found.

warn-unknown-keys clj

(warn-unknown-keys schema data)

write-databases clj

(write-databases config)

Inputs: [config]

Returns a map of database names to their configs. Each :database-NAME section in the config will produce a map entry with NAME as the key. If the config only contains a single :database section, its key will be "default" and its config map will have ::unnamed set to true.