|
9 | 9 | * [`puppet_operational_dashboards`](#puppet_operational_dashboards): Installs Telegraf, InfluxDB, and Grafana to collect and display Puppet metrics
|
10 | 10 | * [`puppet_operational_dashboards::enterprise_infrastructure`](#puppet_operational_dashboards--enterprise_infrastructure): Installs dependancies for Operational dashboards on PE infrastructure components
|
11 | 11 | * [`puppet_operational_dashboards::profile::dashboards`](#puppet_operational_dashboards--profile--dashboards): Installs Grafana and several dashboards to display Puppet metrics. Included via the base class.
|
| 12 | +* [`puppet_operational_dashboards::profile::foss_postgres_access`](#puppet_operational_dashboards--profile--foss_postgres_access): Allows Telegraf to connect and collect metrics from postgres nodes |
12 | 13 | * [`puppet_operational_dashboards::profile::postgres_access`](#puppet_operational_dashboards--profile--postgres_access): Allows Telegraf to connect and collect metrics from postgres nodes
|
13 | 14 | * [`puppet_operational_dashboards::telegraf::agent`](#puppet_operational_dashboards--telegraf--agent): Installs and configures Telegraf to query hosts in a Puppet infrastructure. Included by the base class
|
14 | 15 |
|
@@ -194,7 +195,13 @@ Data type: `Boolean`
|
194 | 195 |
|
195 | 196 | Whether to include Filesync and Orchestrator dashboards
|
196 | 197 |
|
197 |
| -Default value: `$settings::module_groups =~ 'pe_only'` |
| 198 | +Default value: |
| 199 | + |
| 200 | +```puppet |
| 201 | +$settings::module_groups ? { |
| 202 | + /pe_only/ => true, |
| 203 | + default => false |
| 204 | +``` |
198 | 205 |
|
199 | 206 | ##### <a name="-puppet_operational_dashboards--manage_system_board"></a>`manage_system_board`
|
200 | 207 |
|
@@ -505,6 +512,41 @@ Version of the system dashboard to manage. v2 is compatible with puppet_metrics_
|
505 | 512 |
|
506 | 513 | Default value: `'v2'`
|
507 | 514 |
|
| 515 | +### <a name="puppet_operational_dashboards--profile--foss_postgres_access"></a>`puppet_operational_dashboards::profile::foss_postgres_access` |
| 516 | + |
| 517 | +Allows Telegraf to connect and collect metrics from postgres nodes |
| 518 | + |
| 519 | +#### Examples |
| 520 | + |
| 521 | +##### Basic usage |
| 522 | + |
| 523 | +```puppet |
| 524 | +include puppet_operational_dashboards::profile::foss_postgres_access |
| 525 | +``` |
| 526 | + |
| 527 | +#### Parameters |
| 528 | + |
| 529 | +The following parameters are available in the `puppet_operational_dashboards::profile::foss_postgres_access` class: |
| 530 | + |
| 531 | +* [`telegraf_hosts`](#-puppet_operational_dashboards--profile--foss_postgres_access--telegraf_hosts) |
| 532 | +* [`telegraf_user`](#-puppet_operational_dashboards--profile--foss_postgres_access--telegraf_user) |
| 533 | + |
| 534 | +##### <a name="-puppet_operational_dashboards--profile--foss_postgres_access--telegraf_hosts"></a>`telegraf_hosts` |
| 535 | + |
| 536 | +Data type: `Array` |
| 537 | + |
| 538 | +A list of FQDNs running Telegraf to allow access to |
| 539 | + |
| 540 | +Default value: `puppet_operational_dashboards::hosts_with_profile('Puppet_operational_dashboards::Telegraf::Agent')` |
| 541 | + |
| 542 | +##### <a name="-puppet_operational_dashboards--profile--foss_postgres_access--telegraf_user"></a>`telegraf_user` |
| 543 | + |
| 544 | +Data type: `String` |
| 545 | + |
| 546 | +Username for the Telegraf client to use in the postgres connection string |
| 547 | + |
| 548 | +Default value: `'telegraf'` |
| 549 | + |
508 | 550 | ### <a name="puppet_operational_dashboards--profile--postgres_access"></a>`puppet_operational_dashboards::profile::postgres_access`
|
509 | 551 |
|
510 | 552 | Allows Telegraf to connect and collect metrics from postgres nodes
|
@@ -584,6 +626,10 @@ The following parameters are available in the `puppet_operational_dashboards::te
|
584 | 626 | * [`influxdb_token_file`](#-puppet_operational_dashboards--telegraf--agent--influxdb_token_file)
|
585 | 627 | * [`http_timeout_seconds`](#-puppet_operational_dashboards--telegraf--agent--http_timeout_seconds)
|
586 | 628 | * [`include_pe_metrics`](#-puppet_operational_dashboards--telegraf--agent--include_pe_metrics)
|
| 629 | +* [`telegraf_user`](#-puppet_operational_dashboards--telegraf--agent--telegraf_user) |
| 630 | +* [`telegraf_postgres_password`](#-puppet_operational_dashboards--telegraf--agent--telegraf_postgres_password) |
| 631 | +* [`postgres_port`](#-puppet_operational_dashboards--telegraf--agent--postgres_port) |
| 632 | +* [`postgres_options`](#-puppet_operational_dashboards--telegraf--agent--postgres_options) |
587 | 633 |
|
588 | 634 | ##### <a name="-puppet_operational_dashboards--telegraf--agent--token"></a>`token`
|
589 | 635 |
|
@@ -850,6 +896,47 @@ Whether to include Filesync and Orchestrator dashboards
|
850 | 896 |
|
851 | 897 | Default value: `$puppet_operational_dashboards::include_pe_metrics`
|
852 | 898 |
|
| 899 | +##### <a name="-puppet_operational_dashboards--telegraf--agent--telegraf_user"></a>`telegraf_user` |
| 900 | + |
| 901 | +Data type: `String` |
| 902 | + |
| 903 | +Username for the Telegraf client to use in the postgres connection string |
| 904 | + |
| 905 | +Default value: `'telegraf'` |
| 906 | + |
| 907 | +##### <a name="-puppet_operational_dashboards--telegraf--agent--telegraf_postgres_password"></a>`telegraf_postgres_password` |
| 908 | + |
| 909 | +Data type: `Optional[Sensitive[String]]` |
| 910 | + |
| 911 | +Optional Sensitive password for the Telegraf client to use in the postgres connection string |
| 912 | + |
| 913 | +Default value: `undef` |
| 914 | + |
| 915 | +##### <a name="-puppet_operational_dashboards--telegraf--agent--postgres_port"></a>`postgres_port` |
| 916 | + |
| 917 | +Data type: `Integer` |
| 918 | + |
| 919 | +Port for the Telegraf client to use in the postgres connection string |
| 920 | + |
| 921 | +Default value: `5432` |
| 922 | + |
| 923 | +##### <a name="-puppet_operational_dashboards--telegraf--agent--postgres_options"></a>`postgres_options` |
| 924 | + |
| 925 | +Data type: `Hash` |
| 926 | + |
| 927 | +Hash of options for the Telegraf client to use as connection parameters in the postgres connection string |
| 928 | + |
| 929 | +Default value: |
| 930 | + |
| 931 | +```puppet |
| 932 | +{ |
| 933 | + 'sslmode' => 'verify-full', |
| 934 | + 'sslkey' => '/etc/telegraf/puppet_key.pem', |
| 935 | + 'sslcert' => '/etc/telegraf/puppet_cert.pem', |
| 936 | + 'sslrootcert' => '/etc/telegraf/puppet_ca.pem', |
| 937 | + } |
| 938 | +``` |
| 939 | + |
853 | 940 | ## Defined types
|
854 | 941 |
|
855 | 942 | ### <a name="puppet_operational_dashboards--telegraf--config"></a>`puppet_operational_dashboards::telegraf::config`
|
|
0 commit comments