diff --git a/REFERENCE.md b/REFERENCE.md index 7f05b8b9..ec6c4545 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -80,100 +80,15 @@ This can be used to make prometheus find instances of your running service or ap ## Classes -### `prometheus` +### `prometheus` This module manages prometheus #### Parameters -The following parameters are available in the `prometheus` class: - -* [`configname`](#configname) -* [`manage_user`](#manage_user) -* [`user`](#user) -* [`manage_group`](#manage_group) -* [`purge_config_dir`](#purge_config_dir) -* [`group`](#group) -* [`bin_dir`](#bin_dir) -* [`shared_dir`](#shared_dir) -* [`arch`](#arch) -* [`version`](#version) -* [`install_method`](#install_method) -* [`os`](#os) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`download_extension`](#download_extension) -* [`package_name`](#package_name) -* [`package_ensure`](#package_ensure) -* [`config_dir`](#config_dir) -* [`localstorage`](#localstorage) -* [`extra_options`](#extra_options) -* [`config_hash`](#config_hash) -* [`config_defaults`](#config_defaults) -* [`config_template`](#config_template) -* [`config_mode`](#config_mode) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`manage_service`](#manage_service) -* [`restart_on_change`](#restart_on_change) -* [`init_style`](#init_style) -* [`global_config`](#global_config) -* [`rule_files`](#rule_files) -* [`scrape_configs`](#scrape_configs) -* [`include_default_scrape_configs`](#include_default_scrape_configs) -* [`remote_read_configs`](#remote_read_configs) -* [`remote_write_configs`](#remote_write_configs) -* [`alerts`](#alerts) -* [`extra_alerts`](#extra_alerts) -* [`alert_relabel_config`](#alert_relabel_config) -* [`alertmanagers_config`](#alertmanagers_config) -* [`storage_retention`](#storage_retention) -* [`external_url`](#external_url) -* [`extract_command`](#extract_command) -* [`collect_tag`](#collect_tag) -* [`collect_scrape_jobs`](#collect_scrape_jobs) -* [`max_open_files`](#max_open_files) -* [`usershell`](#usershell) -* [`web_listen_address`](#web_listen_address) -* [`web_read_timeout`](#web_read_timeout) -* [`web_max_connections`](#web_max_connections) -* [`web_route_prefix`](#web_route_prefix) -* [`web_user_assets`](#web_user_assets) -* [`web_enable_lifecycle`](#web_enable_lifecycle) -* [`web_enable_admin_api`](#web_enable_admin_api) -* [`web_page_title`](#web_page_title) -* [`web_cors_origin`](#web_cors_origin) -* [`storage_retention_size`](#storage_retention_size) -* [`storage_no_lockfile`](#storage_no_lockfile) -* [`storage_allow_overlapping_blocks`](#storage_allow_overlapping_blocks) -* [`storage_wal_compression`](#storage_wal_compression) -* [`storage_flush_deadline`](#storage_flush_deadline) -* [`storage_read_sample_limit`](#storage_read_sample_limit) -* [`storage_read_concurrent_limit`](#storage_read_concurrent_limit) -* [`storage_read_max_bytes_in_frame`](#storage_read_max_bytes_in_frame) -* [`alert_for_outage_tolerance`](#alert_for_outage_tolerance) -* [`alert_for_grace_period`](#alert_for_grace_period) -* [`alert_resend_delay`](#alert_resend_delay) -* [`alertmanager_notification_queue_capacity`](#alertmanager_notification_queue_capacity) -* [`alertmanager_timeout`](#alertmanager_timeout) -* [`alertmanager_url`](#alertmanager_url) -* [`query_lookback_delta`](#query_lookback_delta) -* [`query_timeout`](#query_timeout) -* [`query_max_concurrency`](#query_max_concurrency) -* [`query_max_samples`](#query_max_samples) -* [`query_staleness_delta`](#query_staleness_delta) -* [`web_telemetry_path`](#web_telemetry_path) -* [`web_enable_remote_shutdown`](#web_enable_remote_shutdown) -* [`log_level`](#log_level) -* [`log_format`](#log_format) -* [`config_show_diff`](#config_show_diff) -* [`extra_groups`](#extra_groups) -* [`env_file_path`](#env_file_path) -* [`manage_prometheus_server`](#manage_prometheus_server) -* [`manage_config`](#manage_config) - -##### `configname` +The following parameters are available in the `prometheus` class. + +##### `configname` Data type: `String[1]` @@ -181,7 +96,7 @@ the name of the configfile, defaults to prometheus.yaml or prometheus.yml on mos Default value: `'prometheus.yaml'` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -189,13 +104,13 @@ Whether to create user for prometheus or rely on external code for that Default value: ``true`` -##### `user` +##### `user` Data type: `String` User running prometheus -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -203,7 +118,7 @@ Whether to create user for prometheus or rely on external code for that Default value: ``true`` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -211,25 +126,25 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `group` +##### `group` Data type: `String` Group under which prometheus is running -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` Directory where binaries are located -##### `shared_dir` +##### `shared_dir` Data type: `Stdlib::Absolutepath` Directory where shared files are located -##### `arch` +##### `arch` Data type: `String[1]` @@ -237,19 +152,19 @@ Architecture (amd64 or i386) Default value: `$facts['os']['architecture']` -##### `version` +##### `version` Data type: `String` Prometheus release -##### `install_method` +##### `install_method` Data type: `String` Installation method: url or package (only url is supported currently) -##### `os` +##### `os` Data type: `String[1]` @@ -257,55 +172,55 @@ Operating system (linux is supported) Default value: `downcase($facts['kernel'])` -##### `download_url` +##### `download_url` Data type: `Optional[String]` Complete URL corresponding to the Prometheus release, default to undef -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for prometheus -##### `download_extension` +##### `download_extension` Data type: `String` Extension of Prometheus binaries archive -##### `package_name` +##### `package_name` Data type: `String` Prometheus package name - not available yet -##### `package_ensure` +##### `package_ensure` Data type: `String` If package, then use this for package ensurel default 'latest' -##### `config_dir` +##### `config_dir` Data type: `String` Prometheus configuration directory (default /etc/prometheus) -##### `localstorage` +##### `localstorage` Data type: `Stdlib::Absolutepath` Location of prometheus local storage (storage.local argument) -##### `extra_options` +##### `extra_options` Data type: `Optional[String[1]]` Extra options added to prometheus startup command -##### `config_hash` +##### `config_hash` Data type: `Hash` @@ -313,7 +228,7 @@ Startup config hash Default value: `{}` -##### `config_defaults` +##### `config_defaults` Data type: `Hash` @@ -321,19 +236,19 @@ Startup config defaults Default value: `{}` -##### `config_template` +##### `config_template` Data type: `String` Configuration template to use (template/prometheus.yaml.erb) -##### `config_mode` +##### `config_mode` Data type: `String` Configuration file mode (default 0660) -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -341,7 +256,7 @@ Whether to enable or not prometheus service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -349,13 +264,13 @@ State ensured from prometheus service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String` Name of the prometheus service (default 'prometheus') -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -363,7 +278,7 @@ Should puppet manage the prometheus service? (default true) Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -373,7 +288,7 @@ options are always *reloaded* without restarting. Default value: ``true`` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -381,25 +296,25 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `global_config` +##### `global_config` Data type: `Hash` Prometheus global configuration variables -##### `rule_files` +##### `rule_files` Data type: `Array` Prometheus rule files -##### `scrape_configs` +##### `scrape_configs` Data type: `Array` Prometheus scrape configs -##### `include_default_scrape_configs` +##### `include_default_scrape_configs` Data type: `Boolean` @@ -407,25 +322,25 @@ Include the module default scrape configs Default value: ``true`` -##### `remote_read_configs` +##### `remote_read_configs` Data type: `Array` Prometheus remote_read config to scrape prometheus 1.8+ instances -##### `remote_write_configs` +##### `remote_write_configs` Data type: `Array` Prometheus remote_write config to scrape prometheus 1.8+ instances -##### `alerts` +##### `alerts` Data type: `Variant[Array,Hash]` alert rules to put in alerts.rules -##### `extra_alerts` +##### `extra_alerts` Data type: `Hash` @@ -433,19 +348,19 @@ Hash with extra alert rules to put in separate files. Default value: `{}` -##### `alert_relabel_config` +##### `alert_relabel_config` Data type: `Array` Prometheus alert relabel config under alerting -##### `alertmanagers_config` +##### `alertmanagers_config` Data type: `Array` Prometheus managers config under alerting -##### `storage_retention` +##### `storage_retention` Data type: `String` @@ -453,7 +368,7 @@ How long to keep timeseries data. This is given as a duration like "100h" or "14 prometheus 1.8.*, only durations understood by golang's time.ParseDuration are supported. Starting with prometheus 2, durations can also be given in days, weeks and years. -##### `external_url` +##### `external_url` Data type: `Optional[Variant[Stdlib::HTTPUrl, Stdlib::Unixpath, String[1]]]` @@ -463,13 +378,13 @@ If omitted, relevant URL components will be derived automatically. Default value: ``undef`` -##### `extract_command` +##### `extract_command` Data type: `Optional[String[1]]` Custom command passed to the archive resource to extract the downloaded archive. -##### `collect_tag` +##### `collect_tag` Data type: `Optional[String[1]]` @@ -477,7 +392,7 @@ Only collect scrape jobs tagged with this label. Allowing to split jobs over mul Default value: ``undef`` -##### `collect_scrape_jobs` +##### `collect_scrape_jobs` Data type: `Array[Hash[String[1], Any]]` @@ -490,7 +405,7 @@ options can be passed as hash elements. Only the job_name is mandatory. Default value: `[]` -##### `max_open_files` +##### `max_open_files` Data type: `Optional[Integer]` @@ -500,14 +415,14 @@ Currently only implemented for systemd based service. Default value: ``undef`` -##### `usershell` +##### `usershell` Data type: `Stdlib::Absolutepath` if requested, we create a user for prometheus or the exporters. The default shell is nologin. It can be overwritten to any valid path. -##### `web_listen_address` +##### `web_listen_address` Data type: `Optional[String[1]]` @@ -516,7 +431,7 @@ Address to listen on for UI, API, and telemetry. Default value: ``undef`` -##### `web_read_timeout` +##### `web_read_timeout` Data type: `Optional[String[1]]` @@ -525,7 +440,7 @@ Maximum duration before timing out read of the request, and closing idle connect Default value: ``undef`` -##### `web_max_connections` +##### `web_max_connections` Data type: `Optional[String[1]]` @@ -534,7 +449,7 @@ Maximum number of simultaneous connections. Default value: ``undef`` -##### `web_route_prefix` +##### `web_route_prefix` Data type: `Optional[String[1]]` @@ -543,7 +458,7 @@ Prefix for the internal routes of web endpoints. Defaults to path of --web.exter Default value: ``undef`` -##### `web_user_assets` +##### `web_user_assets` Data type: `Optional[String[1]]` @@ -552,7 +467,7 @@ Path to static asset directory, available at /user. Default value: ``undef`` -##### `web_enable_lifecycle` +##### `web_enable_lifecycle` Data type: `Boolean` @@ -561,7 +476,7 @@ Enable shutdown and reload via HTTP request Default value: ``false`` -##### `web_enable_admin_api` +##### `web_enable_admin_api` Data type: `Boolean` @@ -570,7 +485,7 @@ Enable API endpoints for admin control actions. Default value: ``false`` -##### `web_page_title` +##### `web_page_title` Data type: `Optional[String[1]]` @@ -579,7 +494,7 @@ Document title of Prometheus instance. Default value: ``undef`` -##### `web_cors_origin` +##### `web_cors_origin` Data type: `Optional[String[1]]` @@ -588,7 +503,7 @@ Regex for CORS origin. It is fully anchored. Example: 'https?://(domain1|domain2 Default value: ``undef`` -##### `storage_retention_size` +##### `storage_retention_size` Data type: `Optional[String[1]]` @@ -598,7 +513,7 @@ MB, GB, TB, PB. This flag is experimental and can be changed in future releases. Default value: ``undef`` -##### `storage_no_lockfile` +##### `storage_no_lockfile` Data type: `Boolean` @@ -607,7 +522,7 @@ Do not create lockfile in data directory. Default value: ``false`` -##### `storage_allow_overlapping_blocks` +##### `storage_allow_overlapping_blocks` Data type: `Boolean` @@ -617,7 +532,7 @@ vertical query merge. Default value: ``false`` -##### `storage_wal_compression` +##### `storage_wal_compression` Data type: `Boolean` @@ -626,7 +541,7 @@ Compress the tsdb WAL. Default value: ``false`` -##### `storage_flush_deadline` +##### `storage_flush_deadline` Data type: `Optional[String[1]]` @@ -635,7 +550,7 @@ How long to wait flushing sample on shutdown or config reload. Default value: ``undef`` -##### `storage_read_sample_limit` +##### `storage_read_sample_limit` Data type: `Optional[String[1]]` @@ -645,7 +560,7 @@ query. 0 means no limit. This limit is ignored for streamed response types. Default value: ``undef`` -##### `storage_read_concurrent_limit` +##### `storage_read_concurrent_limit` Data type: `Optional[String[1]]` @@ -654,7 +569,7 @@ Maximum number of concurrent remote read calls. 0 means no limit. Default value: ``undef`` -##### `storage_read_max_bytes_in_frame` +##### `storage_read_max_bytes_in_frame` Data type: `Optional[String[1]]` @@ -665,7 +580,7 @@ by protobuf by default. Default value: ``undef`` -##### `alert_for_outage_tolerance` +##### `alert_for_outage_tolerance` Data type: `Optional[String[1]]` @@ -674,7 +589,7 @@ Max time to tolerate prometheus outage for restoring "for" state of alert. Default value: ``undef`` -##### `alert_for_grace_period` +##### `alert_for_grace_period` Data type: `Optional[String[1]]` @@ -684,7 +599,7 @@ alerts with configured "for" time greater than grace period. Default value: ``undef`` -##### `alert_resend_delay` +##### `alert_resend_delay` Data type: `Optional[String[1]]` @@ -693,7 +608,7 @@ Minimum amount of time to wait before resending an alert to Alertmanager. Default value: ``undef`` -##### `alertmanager_notification_queue_capacity` +##### `alertmanager_notification_queue_capacity` Data type: `Optional[String[1]]` @@ -702,7 +617,7 @@ The capacity of the queue for pending Alertmanager notifications. Default value: ``undef`` -##### `alertmanager_timeout` +##### `alertmanager_timeout` Data type: `Optional[String[1]]` @@ -711,7 +626,7 @@ Timeout for sending alerts to Alertmanager. Default value: ``undef`` -##### `alertmanager_url` +##### `alertmanager_url` Data type: `Optional[String[1]]` @@ -721,7 +636,7 @@ In Prometheus v2, Alertmanager must be discovered via service discovery Default value: ``undef`` -##### `query_lookback_delta` +##### `query_lookback_delta` Data type: `Optional[String[1]]` @@ -730,7 +645,7 @@ The maximum lookback duration for retrieving metrics during expression evaluatio Default value: ``undef`` -##### `query_timeout` +##### `query_timeout` Data type: `Optional[String[1]]` @@ -739,7 +654,7 @@ Maximum time a query may take before being aborted. Default value: ``undef`` -##### `query_max_concurrency` +##### `query_max_concurrency` Data type: `Optional[String[1]]` @@ -748,7 +663,7 @@ Maximum number of queries executed concurrently. Default value: ``undef`` -##### `query_max_samples` +##### `query_max_samples` Data type: `Optional[String[1]]` @@ -759,7 +674,7 @@ samples a query can return. Default value: ``undef`` -##### `query_staleness_delta` +##### `query_staleness_delta` Data type: `Optional[String[1]]` @@ -768,7 +683,7 @@ Staleness delta allowance during expression evaluations. Default value: ``undef`` -##### `web_telemetry_path` +##### `web_telemetry_path` Data type: `Optional[String[1]]` @@ -777,7 +692,7 @@ Path under which to expose metrics Default value: ``undef`` -##### `web_enable_remote_shutdown` +##### `web_enable_remote_shutdown` Data type: `Boolean` @@ -786,7 +701,7 @@ Enable remote service shutdown. Default value: ``false`` -##### `log_level` +##### `log_level` Data type: `Optional[Enum['debug', 'info', 'warn', 'error', 'fatal']]` @@ -796,7 +711,7 @@ Value of 'fatal' is also allowed in prometheus v1 Default value: ``undef`` -##### `log_format` +##### `log_format` Data type: `Optional[Enum['logfmt', 'json']]` @@ -805,7 +720,7 @@ Output format of log messages. One of: [logfmt, json] Default value: ``undef`` -##### `config_show_diff` +##### `config_show_diff` Data type: `Boolean` @@ -813,76 +728,39 @@ Whether to show prometheus configuration file diff in the Puppet logs. Default value: ``true`` -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups of which the user should be a part -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` -##### `manage_prometheus_server` +##### `manage_prometheus_server` Data type: `Boolean` -##### `manage_config` +##### `manage_config` Data type: `Boolean` -### `prometheus::alertmanager` +### `prometheus::alertmanager` This module manages prometheus alertmanager #### Parameters -The following parameters are available in the `prometheus::alertmanager` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_file`](#config_file) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`global`](#global) -* [`group`](#group) -* [`inhibit_rules`](#inhibit_rules) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`mute_time_intervals`](#mute_time_intervals) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`manage_config`](#manage_config) -* [`validate_config`](#validate_config) -* [`receivers`](#receivers) -* [`restart_on_change`](#restart_on_change) -* [`route`](#route) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`storage_path`](#storage_path) -* [`templates`](#templates) -* [`user`](#user) -* [`version`](#version) -* [`config_dir`](#config_dir) -* [`reload_on_change`](#reload_on_change) - -##### `arch` +The following parameters are available in the `prometheus::alertmanager` class. + +##### `arch` Data type: `String[1]` @@ -890,7 +768,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -898,13 +776,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `Stdlib::Absolutepath` The path to put the configuration file -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -912,13 +790,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String[1]` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[String]` @@ -926,19 +804,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -946,7 +824,7 @@ Extra options added to the startup command Default value: `''` -##### `global` +##### `global` Data type: `Hash` @@ -956,13 +834,13 @@ prometheus::alertmanager::global: smtp_smarthost: 'localhost:25' smtp_from: 'alertmanager@localhost' -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `inhibit_rules` +##### `inhibit_rules` Data type: `Array` @@ -978,7 +856,7 @@ prometheus::alertmanager::inhibit_rules: - 'cluster' - 'service' -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -986,7 +864,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `String[1]` @@ -994,7 +872,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -1002,7 +880,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -1010,7 +888,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -1018,7 +896,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `mute_time_intervals` +##### `mute_time_intervals` Data type: `Array[Hash]` @@ -1028,7 +906,7 @@ prometheus::alertmanager::mute_time_intervals: - name: weekend weekdays: ['saturday','sunday'] -##### `os` +##### `os` Data type: `String[1]` @@ -1036,19 +914,19 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -1056,7 +934,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `manage_config` +##### `manage_config` Data type: `Boolean` @@ -1064,7 +942,7 @@ Whether Puppet should manage Alertmanager config Default value: ``true`` -##### `validate_config` +##### `validate_config` Data type: `Boolean` @@ -1072,7 +950,7 @@ Whether Puppet should validate the config with amtool when it is not installed w Default value: ``false`` -##### `receivers` +##### `receivers` Data type: `Array` @@ -1083,7 +961,7 @@ prometheus::alertmanager::receivers: email_configs: - to: 'root@localhost' -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -1091,7 +969,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `route` +##### `route` Data type: `Hash` @@ -1107,7 +985,7 @@ prometheus::alertmanager::route: repeat_interval: '3h' receiver: 'Admin' -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -1115,7 +993,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -1123,7 +1001,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -1131,37 +1009,37 @@ Name of the alertmanager service (default 'alertmanager') Default value: `'alertmanager'` -##### `storage_path` +##### `storage_path` Data type: `Stdlib::Absolutepath` The storage path to pass to the alertmanager. Defaults to '/var/lib/alertmanager' -##### `templates` +##### `templates` Data type: `Array` The array of template files. Defaults to [ "${config_dir}/*.tmpl" ] -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `config_dir` +##### `config_dir` Data type: `Stdlib::Absolutepath` -##### `reload_on_change` +##### `reload_on_change` Data type: `Boolean` @@ -1169,46 +1047,15 @@ Data type: `Boolean` Default value: ``false`` -### `prometheus::apache_exporter` +### `prometheus::apache_exporter` This module manages prometheus apache_exporter #### Parameters -The following parameters are available in the `prometheus::apache_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`scrape_uri`](#scrape_uri) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::apache_exporter` class. + +##### `arch` Data type: `String[1]` @@ -1216,7 +1063,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -1224,7 +1071,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -1232,13 +1079,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -1246,19 +1093,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -1266,13 +1113,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -1280,7 +1127,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -1288,7 +1135,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -1296,7 +1143,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -1304,7 +1151,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -1312,7 +1159,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -1320,19 +1167,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -1340,7 +1187,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -1348,13 +1195,13 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `scrape_uri` +##### `scrape_uri` Data type: `String[1]` The URI for the Apache status page -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -1362,7 +1209,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -1370,7 +1217,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -1378,19 +1225,19 @@ Name of the node exporter service (default 'apache_exporter') Default value: `'apache_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -1398,7 +1245,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -1406,7 +1253,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -1414,7 +1261,7 @@ Data type: `Stdlib::Port` Default value: `9117` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -1422,7 +1269,7 @@ Data type: `String[1]` Default value: `'apache'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -1430,48 +1277,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::beanstalkd_exporter` +### `prometheus::beanstalkd_exporter` This module manages prometheus beanstalkd_exporter #### Parameters -The following parameters are available in the `prometheus::beanstalkd_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config`](#config) -* [`mapping_config`](#mapping_config) -* [`beanstalkd_address`](#beanstalkd_address) -* [`exporter_listen`](#exporter_listen) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::beanstalkd_exporter` class. + +##### `arch` Data type: `String[1]` @@ -1479,7 +1293,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -1487,37 +1301,37 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config` +##### `config` Data type: `String[1]` Path to configuration file that stores beanstalkd address -##### `mapping_config` +##### `mapping_config` Data type: `String[1]` Path to configuration file with tubes mappings (not implemented) -##### `beanstalkd_address` +##### `beanstalkd_address` Data type: `String[1]` Address of beanstalkd, defaults to localhost -##### `exporter_listen` +##### `exporter_listen` Data type: `String[1]` Address to bind beanstalkd_exporter to. Default is different than upstream (*:9371) -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Variant[Undef,String]` @@ -1525,19 +1339,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -1545,13 +1359,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -1559,7 +1373,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -1567,7 +1381,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -1575,7 +1389,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -1583,7 +1397,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -1591,7 +1405,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -1599,19 +1413,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -1619,7 +1433,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -1627,7 +1441,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -1635,7 +1449,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -1643,25 +1457,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the beanstalkd exporter service (default 'beanstalkd_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -1669,7 +1483,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -1677,7 +1491,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -1685,7 +1499,7 @@ Data type: `Stdlib::Port` Default value: `8080` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -1693,7 +1507,7 @@ Data type: `String[1]` Default value: `'beanstalkd'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -1701,7 +1515,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::bind_exporter` +### `prometheus::bind_exporter` Class: prometheus::bind_exporter @@ -1709,39 +1523,9 @@ This module manages prometheus bind_exporter #### Parameters -The following parameters are available in the `prometheus::bind_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`env_vars`](#env_vars) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_port`](#scrape_port) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::bind_exporter` class. + +##### `arch` Data type: `String[1]` @@ -1749,7 +1533,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -1757,7 +1541,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -1765,7 +1549,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -1773,7 +1557,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Stdlib::HTTPSUrl]` @@ -1781,7 +1565,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Stdlib::HTTPSUrl` @@ -1789,7 +1573,7 @@ Base URL for the binary archive Default value: `'https://github.com/prometheus-community/bind_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` @@ -1797,7 +1581,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -1805,7 +1589,7 @@ Extra options added to the startup command Default value: `''` -##### `env_vars` +##### `env_vars` Data type: `Hash[String, Scalar]` @@ -1813,7 +1597,7 @@ The environment variable to pass to the daemon Default value: `{}` -##### `group` +##### `group` Data type: `String[1]` @@ -1821,7 +1605,7 @@ Group under which the binary is running Default value: `'bind-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -1829,7 +1613,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$prometheus::init_style` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -1837,7 +1621,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -1845,7 +1629,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -1853,7 +1637,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -1861,7 +1645,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -1869,7 +1653,7 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -1877,7 +1661,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -1885,7 +1669,7 @@ The binary package name - not available yet Default value: `'bind_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -1893,7 +1677,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -1901,7 +1685,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -1909,7 +1693,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `String[1]` @@ -1917,7 +1701,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String` @@ -1925,7 +1709,7 @@ Name of the node exporter service (default 'bind_exporter') Default value: `'bind_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -1933,7 +1717,7 @@ User which runs the service Default value: `'bind-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -1941,7 +1725,7 @@ The binary release version Default value: `'0.4.0'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -1950,7 +1734,7 @@ collecting on your prometheus server. Default value: ``false`` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -1960,7 +1744,7 @@ puppet module, the jobs to be collected are configured with Default value: `'bind'` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -1970,7 +1754,7 @@ overriding `extra_options`. Default value: `9119` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -1980,7 +1764,7 @@ be used. Default value: ``undef`` -### `prometheus::bird_exporter` +### `prometheus::bird_exporter` This module manages prometheus bird exporter @@ -2000,41 +1784,9 @@ class { 'prometheus::bird_exporter': #### Parameters -The following parameters are available in the `prometheus::bird_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`env_vars`](#env_vars) -* [`env_file_path`](#env_file_path) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) - -##### `arch` +The following parameters are available in the `prometheus::bird_exporter` class. + +##### `arch` Data type: `String[1]` @@ -2042,7 +1794,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -2050,7 +1802,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -2058,7 +1810,7 @@ Extension for the release binary archive Default value: `''` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -2066,7 +1818,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -2074,7 +1826,7 @@ Base URL for the binary archive Default value: `'https://github.com/czerwonk/bird_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -2082,7 +1834,7 @@ Extra groups to add the binary user to Default value: `['bird']` -##### `extra_options` +##### `extra_options` Data type: `String[1]` @@ -2090,7 +1842,7 @@ Extra options added to the startup command Default value: `'-bird.v2 -web.listen-address=127.0.0.1:9324 -format.new=true'` -##### `group` +##### `group` Data type: `String[1]` @@ -2098,7 +1850,7 @@ Group under which the binary is running Default value: `'bird-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -2106,7 +1858,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -2114,7 +1866,7 @@ Installation method: url or package (only url is supported currently) Default value: `'url'` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -2122,7 +1874,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -2130,7 +1882,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -2138,7 +1890,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -2146,7 +1898,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -2154,7 +1906,7 @@ If package, then use this for package ensure default 'latest' Default value: `'installed'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -2162,7 +1914,7 @@ The binary package name - not available yet Default value: `'bird_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -2170,7 +1922,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -2178,7 +1930,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -2186,7 +1938,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -2194,7 +1946,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -2202,7 +1954,7 @@ Name of the bird exporter service (default 'bird_exporter') Default value: `'bird_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -2210,7 +1962,7 @@ User which runs the service Default value: `'bird-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -2218,7 +1970,7 @@ The binary release version Default value: `'1.2.5'` -##### `env_vars` +##### `env_vars` Data type: `Hash[String[1], Scalar]` @@ -2226,7 +1978,7 @@ hash with custom environment variables thats passed to the exporter via init scr Default value: `{}` -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` @@ -2234,7 +1986,7 @@ The path to the file with the environmetn variable that is read from the init sc Default value: `$prometheus::env_file_path` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -2242,7 +1994,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -2250,7 +2002,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -2258,7 +2010,7 @@ Data type: `Stdlib::Port` Default value: `9324` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -2266,7 +2018,7 @@ Data type: `String[1]` Default value: `'bird'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -2274,7 +2026,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -2282,7 +2034,7 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::blackbox_exporter` +### `prometheus::blackbox_exporter` Example for configuring named blackbox modules via hiera details of the format: https://github.com/prometheus/blackbox_exporter/blob/master/CONFIGURATION.md @@ -2299,40 +2051,9 @@ prometheus::blackbox_exporter::modules: #### Parameters -The following parameters are available in the `prometheus::blackbox_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_file`](#config_file) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`modules`](#modules) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`config_mode`](#config_mode) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::blackbox_exporter` class. + +##### `arch` Data type: `String[1]` @@ -2340,7 +2061,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -2348,19 +2069,19 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `String[1]` Absolute path to configuration file (blackbox module definitions) -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -2368,19 +2089,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -2388,13 +2109,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -2402,7 +2123,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -2410,7 +2131,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -2418,7 +2139,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -2426,7 +2147,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -2434,7 +2155,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `modules` +##### `modules` Data type: `Hash` @@ -2442,7 +2163,7 @@ Structured, array of blackbox module definitions for different probe types Default value: `{}` -##### `os` +##### `os` Data type: `String[1]` @@ -2450,19 +2171,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -2470,7 +2191,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -2478,7 +2199,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -2486,7 +2207,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -2494,19 +2215,19 @@ Name of the node exporter service (default 'blackbox_exporter') Default value: `'blackbox_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -2514,7 +2235,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -2522,7 +2243,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -2530,7 +2251,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -2538,7 +2259,7 @@ Data type: `Stdlib::Port` Default value: `9115` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -2546,7 +2267,7 @@ Data type: `String[1]` Default value: `'blackbox'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -2554,43 +2275,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::collectd_exporter` +### `prometheus::collectd_exporter` This module manages prometheus node collectd_exporter #### Parameters -The following parameters are available in the `prometheus::collectd_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`options`](#options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::collectd_exporter` class. + +##### `arch` Data type: `String[1]` @@ -2598,7 +2291,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -2606,13 +2299,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[String[1]]` @@ -2620,25 +2313,25 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `options` +##### `options` Data type: `String` Options added to the startup command -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -2646,7 +2339,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -2654,7 +2347,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -2662,7 +2355,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -2670,7 +2363,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -2678,7 +2371,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -2686,19 +2379,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -2706,7 +2399,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -2714,7 +2407,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -2722,7 +2415,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -2730,25 +2423,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the collectd exporter service (default 'collectd_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -2756,7 +2449,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -2764,7 +2457,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -2772,7 +2465,7 @@ Data type: `Stdlib::Port` Default value: `9103` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -2780,7 +2473,7 @@ Data type: `String[1]` Default value: `'collectd'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -2788,53 +2481,19 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::config` +### `prometheus::config` Configuration class for prometheus monitoring system -### `prometheus::consul_exporter` +### `prometheus::consul_exporter` This module manages prometheus node consul_exporter #### Parameters -The following parameters are available in the `prometheus::consul_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`consul_server`](#consul_server) -* [`consul_health_summary`](#consul_health_summary) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`log_level`](#log_level) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`web_listen_address`](#web_listen_address) -* [`web_telemetry_path`](#web_telemetry_path) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::consul_exporter` class. + +##### `arch` Data type: `String[1]` @@ -2842,7 +2501,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -2850,25 +2509,25 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `consul_server` +##### `consul_server` Data type: `String[1]` HTTP API address of a Consul server or agent. (prefix with https:// to connect over HTTPS) (default "http://localhost:8500") -##### `consul_health_summary` +##### `consul_health_summary` Data type: `Boolean` Generate a health summary for each service instance. Needs n+1 queries to collect all information. (default true) -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -2876,19 +2535,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -2896,13 +2555,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -2910,7 +2569,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -2918,13 +2577,13 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `log_level` +##### `log_level` Data type: `String[1]` Only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal] (default "info") -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -2932,7 +2591,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -2940,7 +2599,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -2948,7 +2607,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -2956,19 +2615,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -2976,7 +2635,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -2984,7 +2643,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -2992,7 +2651,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -3000,37 +2659,37 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the consul exporter service (default 'consul_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `web_listen_address` +##### `web_listen_address` Data type: `String[1]` Address to listen on for web interface and telemetry. (default ":9107") -##### `web_telemetry_path` +##### `web_telemetry_path` Data type: `String[1]` Path under which to expose metrics. (default "/metrics") -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -3038,7 +2697,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -3046,7 +2705,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -3054,7 +2713,7 @@ Data type: `Stdlib::Port` Default value: `9107` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -3062,7 +2721,7 @@ Data type: `String[1]` Default value: `'consul'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -3070,47 +2729,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::dellhw_exporter` +### `prometheus::dellhw_exporter` This module manages prometheus node dellhw_exporter #### Parameters -The following parameters are available in the `prometheus::dellhw_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`omreport_path`](#omreport_path) -* [`scrape_ipadress`](#scrape_ipadress) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) - -##### `arch` +The following parameters are available in the `prometheus::dellhw_exporter` class. + +##### `arch` Data type: `String[1]` @@ -3118,7 +2745,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -3126,7 +2753,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -3134,7 +2761,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -3142,7 +2769,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -3150,7 +2777,7 @@ Base URL for the binary archive Default value: `'https://github.com/galexrt/dellhw_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -3158,7 +2785,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -3166,7 +2793,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -3174,7 +2801,7 @@ Group under which the binary is running Default value: `'dellhw-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -3182,7 +2809,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -3190,7 +2817,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -3198,7 +2825,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -3206,7 +2833,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -3214,7 +2841,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -3222,7 +2849,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -3230,7 +2857,7 @@ If package, then use this for package ensure default 'latest' Default value: `'present'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -3238,7 +2865,7 @@ The binary package name - not available yet Default value: `'dellhw_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -3246,7 +2873,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -3254,7 +2881,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -3262,7 +2889,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -3270,7 +2897,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -3278,7 +2905,7 @@ Name of the dellhw exporter service (default 'dellhw_exporter') Default value: `'dellhw_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -3286,7 +2913,7 @@ User which runs the service Default value: `'dellhw-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -3294,7 +2921,7 @@ The binary release version Default value: `'1.6.0'` -##### `omreport_path` +##### `omreport_path` Data type: `Stdlib::Unixpath` @@ -3302,7 +2929,7 @@ The file path to the omReport executable (default "/opt/dell/srvadmin/bin/omrepo Default value: `'/opt/dell/srvadmin/bin/omreport'` -##### `scrape_ipadress` +##### `scrape_ipadress` Data type: `String` @@ -3310,7 +2937,7 @@ The ip address that the exporter will to listen to (default '') Default value: `''` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -3318,7 +2945,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -3326,7 +2953,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -3334,7 +2961,7 @@ Data type: `Stdlib::Port` Default value: `9137` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -3342,7 +2969,7 @@ Data type: `String[1]` Default value: `'dellhw'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -3350,7 +2977,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -3358,47 +2985,15 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::elasticsearch_exporter` +### `prometheus::elasticsearch_exporter` This module manages prometheus elasticsearch_exporter #### Parameters -The following parameters are available in the `prometheus::elasticsearch_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`cnf_uri`](#cnf_uri) -* [`cnf_timeout`](#cnf_timeout) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`user`](#user) -* [`version`](#version) -* [`use_kingpin`](#use_kingpin) -* [`service_name`](#service_name) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::elasticsearch_exporter` class. + +##### `arch` Data type: `String[1]` @@ -3406,7 +3001,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -3414,25 +3009,25 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `cnf_uri` +##### `cnf_uri` Data type: `String[1]` The URI to obtain elasticsearch stats from -##### `cnf_timeout` +##### `cnf_timeout` Data type: `String[1]` Timeout for trying to get stats from elasticsearch URI -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -3440,19 +3035,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -3460,13 +3055,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -3474,7 +3069,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -3482,7 +3077,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -3490,7 +3085,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -3498,7 +3093,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -3506,7 +3101,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -3514,19 +3109,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -3534,7 +3129,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -3542,7 +3137,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -3550,7 +3145,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -3558,19 +3153,19 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `use_kingpin` +##### `use_kingpin` Data type: `Boolean` @@ -3578,13 +3173,13 @@ Since version 1.1.0, the elasticsearch exporter uses kingpin, thus this param to define how we call the es.uri and es.timeout in the $options https://github.com/justwatchcom/elasticsearch_exporter/blob/v1.1.0/CHANGELOG.md -##### `service_name` +##### `service_name` Data type: `String[1]` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -3592,7 +3187,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -3600,7 +3195,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -3608,7 +3203,7 @@ Data type: `Stdlib::Port` Default value: `9114` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -3616,7 +3211,7 @@ Data type: `String[1]` Default value: `'elasticsearch'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -3624,43 +3219,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::graphite_exporter` +### `prometheus::graphite_exporter` This module manages prometheus node graphite_exporter #### Parameters -The following parameters are available in the `prometheus::graphite_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`options`](#options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::graphite_exporter` class. + +##### `arch` Data type: `String[1]` @@ -3668,7 +3235,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -3676,13 +3243,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -3690,25 +3257,25 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `options` +##### `options` Data type: `String` Options added to the startup command -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -3716,7 +3283,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -3724,7 +3291,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -3732,7 +3299,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -3740,7 +3307,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -3748,7 +3315,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -3756,19 +3323,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -3776,7 +3343,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -3784,7 +3351,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -3792,7 +3359,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -3800,25 +3367,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the graphite exporter service (default 'graphite_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -3826,7 +3393,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -3834,7 +3401,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -3842,7 +3409,7 @@ Data type: `Stdlib::Port` Default value: `9108` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -3850,7 +3417,7 @@ Data type: `String[1]` Default value: `'graphite'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -3858,47 +3425,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::grok_exporter` +### `prometheus::grok_exporter` This module manages prometheus grok_exporter #### Parameters -The following parameters are available in the `prometheus::grok_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config`](#config) -* [`config_file`](#config_file) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::grok_exporter` class. + +##### `arch` Data type: `String[1]` @@ -3906,7 +3441,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -3914,20 +3449,20 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config` +##### `config` Data type: `Hash` Hash of configuration, see https://github.com/fstab/grok_exporter/blob/master/CONFIG.md for available options -##### `config_file` +##### `config_file` Data type: `String[1]` Path to config file, it will be generated from config param -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -3935,13 +3470,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -3949,19 +3484,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -3969,13 +3504,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -3983,7 +3518,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -3991,7 +3526,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -3999,7 +3534,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -4007,7 +3542,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -4015,7 +3550,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -4023,19 +3558,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -4043,7 +3578,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -4051,7 +3586,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -4059,7 +3594,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -4067,7 +3602,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -4075,19 +3610,19 @@ Name of the node exporter service (default 'grok_exporter') Default value: `'grok_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -4095,7 +3630,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -4103,7 +3638,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -4111,7 +3646,7 @@ Data type: `Stdlib::Port` Default value: `9144` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -4119,7 +3654,7 @@ Data type: `String[1]` Default value: `'grok'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -4127,45 +3662,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::haproxy_exporter` +### `prometheus::haproxy_exporter` This module manages prometheus haproxy_exporter #### Parameters -The following parameters are available in the `prometheus::haproxy_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`cnf_scrape_uri`](#cnf_scrape_uri) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::haproxy_exporter` class. + +##### `arch` Data type: `String[1]` @@ -4173,7 +3678,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -4181,19 +3686,19 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `cnf_scrape_uri` +##### `cnf_scrape_uri` Data type: `Variant[Stdlib::HTTPUrl, Pattern[/unix:(?:\/.+)+/]]` The URI to obtain HAProxy stats from -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -4201,19 +3706,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -4221,13 +3726,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -4235,7 +3740,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -4243,7 +3748,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -4251,7 +3756,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -4259,7 +3764,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -4267,7 +3772,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -4275,19 +3780,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -4295,7 +3800,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -4303,7 +3808,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -4311,7 +3816,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -4319,25 +3824,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the haproxy exporter service (default 'haproxy_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -4345,7 +3850,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -4353,7 +3858,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -4361,7 +3866,7 @@ Data type: `Stdlib::Port` Default value: `9101` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -4369,7 +3874,7 @@ Data type: `String[1]` Default value: `'haproxy'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -4377,57 +3882,22 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::install` +### `prometheus::install` Install prometheus via different methods with parameters from init Currently only the install from url is implemented, when Prometheus will deliver packages for some Linux distros I will implement the package install method as well The package method needs specific yum or apt repo settings which are not made yet by the module -### `prometheus::ipmi_exporter` +### `prometheus::ipmi_exporter` This module manages prometheus node ipmi_exporter (https://github.com/soundcloud/ipmi_exporter) #### Parameters -The following parameters are available in the `prometheus::ipmi_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_file`](#config_file) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`modules`](#modules) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`scrape_host`](#scrape_host) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) -* [`unprivileged`](#unprivileged) -* [`script_dir`](#script_dir) - -##### `arch` +The following parameters are available in the `prometheus::ipmi_exporter` class. + +##### `arch` Data type: `String[1]` @@ -4435,7 +3905,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -4443,7 +3913,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `Stdlib::Absolutepath` @@ -4451,7 +3921,7 @@ Path to IPMI exporter configuration file Default value: `'/etc/ipmi_exporter.yaml'` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -4459,7 +3929,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -4467,7 +3937,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -4475,7 +3945,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -4483,7 +3953,7 @@ Base URL for the binary archive Default value: `'https://github.com/soundcloud/ipmi_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -4491,7 +3961,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -4499,7 +3969,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -4507,7 +3977,7 @@ Group under which the binary is running Default value: `'ipmi-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -4515,7 +3985,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -4523,7 +3993,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -4531,7 +4001,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -4539,7 +4009,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -4547,7 +4017,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `modules` +##### `modules` Data type: `Hash` @@ -4555,7 +4025,7 @@ Hash of IPMI exporter modules Default value: `{}` -##### `os` +##### `os` Data type: `String[1]` @@ -4563,7 +4033,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -4571,7 +4041,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -4579,7 +4049,7 @@ The binary package name - not available yet Default value: `'ipmi_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -4587,7 +4057,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -4595,7 +4065,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -4603,7 +4073,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -4611,7 +4081,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -4619,7 +4089,7 @@ Name of the node exporter service (default 'ipmi_exporter') Default value: `'ipmi_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -4627,7 +4097,7 @@ User which runs the service Default value: `'ipmi-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -4635,7 +4105,7 @@ The binary release version Default value: `'1.4.0'` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -4643,7 +4113,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -4651,7 +4121,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -4659,7 +4129,7 @@ Data type: `Stdlib::Port` Default value: `9290` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -4667,7 +4137,7 @@ Data type: `String[1]` Default value: `'ipmi'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -4675,7 +4145,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -4683,7 +4153,7 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -##### `unprivileged` +##### `unprivileged` Data type: `Boolean` @@ -4691,7 +4161,7 @@ Data type: `Boolean` Default value: ``true`` -##### `script_dir` +##### `script_dir` Data type: `Stdlib::Absolutepath` @@ -4699,44 +4169,15 @@ Data type: `Stdlib::Absolutepath` Default value: `'/usr/local/bin'` -### `prometheus::ipsec_exporter` +### `prometheus::ipsec_exporter` This module manages prometheus node ipsec_exporter #### Parameters -The following parameters are available in the `prometheus::ipsec_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`options`](#options) -* [`extra_groups`](#extra_groups) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::ipsec_exporter` class. + +##### `arch` Data type: `String[1]` @@ -4744,7 +4185,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::AbsolutePath` @@ -4752,7 +4193,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String[1]` @@ -4760,7 +4201,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -4768,7 +4209,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -4776,7 +4217,7 @@ Base URL for the binary archive Default value: `'https://github.com/dennisstritzke/ipsec_exporter/releases'` -##### `options` +##### `options` Data type: `String` @@ -4784,7 +4225,7 @@ Options added to the startup command Default value: `''` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` @@ -4792,7 +4233,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `group` +##### `group` Data type: `String[1]` @@ -4800,7 +4241,7 @@ Group under which the binary is running Default value: `'ipsec-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -4808,7 +4249,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -4816,7 +4257,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -4824,7 +4265,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -4832,7 +4273,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -4840,7 +4281,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -4848,7 +4289,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -4856,7 +4297,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -4864,7 +4305,7 @@ The binary package name - not available yet Default value: `'ipsec_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -4872,7 +4313,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -4880,7 +4321,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -4888,7 +4329,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -4896,7 +4337,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -4904,7 +4345,7 @@ Name of the ipsec exporter service (default 'ipsec_exporter') Default value: `'ipsec_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -4912,7 +4353,7 @@ User which runs the service Default value: `'ipsec-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -4920,7 +4361,7 @@ The binary release version Default value: `'0.3.2'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -4928,7 +4369,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -4936,7 +4377,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -4944,7 +4385,7 @@ Data type: `Stdlib::Port` Default value: `9536` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -4952,7 +4393,7 @@ Data type: `String[1]` Default value: `'ipsec'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -4960,45 +4401,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::memcached_exporter` +### `prometheus::memcached_exporter` This module manages prometheus node memcached_exporter #### Parameters -The following parameters are available in the `prometheus::memcached_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) - -##### `arch` +The following parameters are available in the `prometheus::memcached_exporter` class. + +##### `arch` Data type: `String[1]` @@ -5006,7 +4417,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -5014,7 +4425,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -5022,7 +4433,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -5030,7 +4441,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -5038,7 +4449,7 @@ Base URL for the binary archive Default value: `'https://github.com/prometheus/memcached_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -5046,7 +4457,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -5054,7 +4465,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -5062,7 +4473,7 @@ Group under which the binary is running Default value: `'memcached-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -5070,7 +4481,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -5078,7 +4489,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -5086,7 +4497,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -5094,7 +4505,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -5102,7 +4513,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -5110,7 +4521,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -5118,7 +4529,7 @@ If package, then use this for package ensure default 'latest' Default value: `'present'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -5126,7 +4537,7 @@ The binary package name - not available yet Default value: `'memcached_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -5134,7 +4545,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -5142,7 +4553,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -5150,7 +4561,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -5158,7 +4569,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -5166,7 +4577,7 @@ Name of the memcached exporter service (default 'memcached_exporter') Default value: `'memcached_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -5174,7 +4585,7 @@ User which runs the service Default value: `'memcached-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -5182,7 +4593,7 @@ The binary release version Default value: `'0.6.0'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -5190,7 +4601,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -5198,7 +4609,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -5206,7 +4617,7 @@ Data type: `Stdlib::Port` Default value: `9150` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -5214,7 +4625,7 @@ Data type: `String[1]` Default value: `'memcached'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -5222,7 +4633,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -5230,46 +4641,15 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::mesos_exporter` +### `prometheus::mesos_exporter` This module manages prometheus mesos_exporter #### Parameters -The following parameters are available in the `prometheus::mesos_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`server_type`](#server_type) -* [`cnf_scrape_uri`](#cnf_scrape_uri) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::mesos_exporter` class. + +##### `arch` Data type: `String[1]` @@ -5277,7 +4657,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -5285,25 +4665,25 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `server_type` +##### `server_type` Data type: `String[1]` Specify target type master or slave -##### `cnf_scrape_uri` +##### `cnf_scrape_uri` Data type: `String[1]` The URI to obtain mesos stats from -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -5311,19 +4691,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -5331,13 +4711,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -5345,7 +4725,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -5353,7 +4733,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -5361,7 +4741,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -5369,7 +4749,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -5377,7 +4757,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -5385,19 +4765,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -5405,7 +4785,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -5413,7 +4793,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -5421,7 +4801,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -5429,25 +4809,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the mesos exporter service (default 'mesos_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -5455,7 +4835,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -5463,7 +4843,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -5471,7 +4851,7 @@ Data type: `Stdlib::Port` Default value: `9105` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -5479,7 +4859,7 @@ Data type: `String[1]` Default value: `'mesos'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -5487,46 +4867,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::mongodb_exporter` +### `prometheus::mongodb_exporter` This module manages prometheus mongodb_exporter #### Parameters -The following parameters are available in the `prometheus::mongodb_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`cnf_uri`](#cnf_uri) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`use_kingpin`](#use_kingpin) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::mongodb_exporter` class. + +##### `arch` Data type: `String[1]` @@ -5534,7 +4883,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -5542,7 +4891,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `cnf_uri` +##### `cnf_uri` Data type: `String[1]` @@ -5550,7 +4899,7 @@ The URI to obtain MongoDB stats from Default value: `'mongodb://localhost:27017'` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -5558,7 +4907,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -5566,7 +4915,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -5574,7 +4923,7 @@ Base URL for the binary archive Default value: `'https://github.com/percona/mongodb_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array` @@ -5582,7 +4931,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -5590,7 +4939,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -5598,7 +4947,7 @@ Group under which the binary is running Default value: `'mongodb-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -5606,7 +4955,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -5614,7 +4963,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -5622,7 +4971,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -5630,7 +4979,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -5638,7 +4987,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -5646,7 +4995,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -5654,7 +5003,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -5662,7 +5011,7 @@ The binary package name - not available yet Default value: `'mongodb_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -5670,7 +5019,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -5678,7 +5027,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -5686,7 +5035,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -5694,7 +5043,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -5702,7 +5051,7 @@ Name of the mongodb exporter service (default 'mongodb_exporter') Default value: `'mongodb_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -5710,7 +5059,7 @@ User which runs the service Default value: `'mongodb-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -5718,7 +5067,7 @@ The binary release version Default value: `'0.20.4'` -##### `use_kingpin` +##### `use_kingpin` Data type: `Boolean` @@ -5728,7 +5077,7 @@ https://github.com/percona/mongodb_exporter/blob/v0.7.0/CHANGELOG.md Default value: ``true`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -5736,7 +5085,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -5744,7 +5093,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -5752,7 +5101,7 @@ Data type: `Stdlib::Port` Default value: `9216` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -5760,7 +5109,7 @@ Data type: `String[1]` Default value: `'mongodb'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -5768,7 +5117,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::mysqld_exporter` +### `prometheus::mysqld_exporter` manages prometheus mysqld_exporter @@ -5777,45 +5126,9 @@ manages prometheus mysqld_exporter #### Parameters -The following parameters are available in the `prometheus::mysqld_exporter` class: - -* [`cnf_config_path`](#cnf_config_path) -* [`cnf_host`](#cnf_host) -* [`cnf_password`](#cnf_password) -* [`cnf_port`](#cnf_port) -* [`cnf_socket`](#cnf_socket) -* [`cnf_user`](#cnf_user) -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `cnf_config_path` +The following parameters are available in the `prometheus::mysqld_exporter` class. + +##### `cnf_config_path` Data type: `Stdlib::Absolutepath` @@ -5823,7 +5136,7 @@ The path to put the my.cnf file Default value: `'/etc/.my.cnf'` -##### `cnf_host` +##### `cnf_host` Data type: `Stdlib::Host` @@ -5831,7 +5144,7 @@ The mysql host. Default value: `localhost` -##### `cnf_password` +##### `cnf_password` Data type: `Variant[Sensitive[String],String]` @@ -5839,7 +5152,7 @@ The mysql user password. Default value: `'password'` -##### `cnf_port` +##### `cnf_port` Data type: `Stdlib::Port` @@ -5847,7 +5160,7 @@ The port for which the mysql host is running. Default value: `3306` -##### `cnf_socket` +##### `cnf_socket` Data type: `Optional[Stdlib::Absolutepath]` @@ -5855,7 +5168,7 @@ The socket which the mysql host is running. If defined, host and port are not us Default value: ``undef`` -##### `cnf_user` +##### `cnf_user` Data type: `String[1]` @@ -5863,7 +5176,7 @@ The mysql user to use when connecting. Default value: `login` -##### `arch` +##### `arch` Data type: `String[1]` @@ -5871,7 +5184,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -5879,7 +5192,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -5887,13 +5200,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -5901,19 +5214,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -5921,13 +5234,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -5935,7 +5248,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -5943,7 +5256,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -5951,7 +5264,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -5959,7 +5272,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -5967,7 +5280,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -5975,19 +5288,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -5995,7 +5308,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -6003,7 +5316,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -6011,7 +5324,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -6019,25 +5332,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the mysqld exporter service (default 'mysqld_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -6045,7 +5358,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -6053,7 +5366,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -6061,7 +5374,7 @@ Data type: `Stdlib::Port` Default value: `9104` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -6069,7 +5382,7 @@ Data type: `String[1]` Default value: `'mysql'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -6077,49 +5390,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::nginx_prometheus_exporter` +### `prometheus::nginx_prometheus_exporter` This module manages prometheus nginx exporter #### Parameters -The following parameters are available in the `prometheus::nginx_prometheus_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`scrape_uri`](#scrape_uri) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) -* [`env_vars`](#env_vars) -* [`env_file_path`](#env_file_path) - -##### `arch` +The following parameters are available in the `prometheus::nginx_prometheus_exporter` class. + +##### `arch` Data type: `String[1]` @@ -6127,7 +5406,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -6135,7 +5414,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -6143,7 +5422,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -6151,7 +5430,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -6159,7 +5438,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -6167,7 +5446,7 @@ Base URL for the binary archive Default value: `'https://github.com/nginxinc/nginx-prometheus-exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` @@ -6175,7 +5454,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -6183,7 +5462,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -6191,7 +5470,7 @@ Group under which the binary is running Default value: `'nginx-prometheus-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -6199,7 +5478,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -6207,7 +5486,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -6215,7 +5494,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -6223,7 +5502,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -6231,7 +5510,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -6239,7 +5518,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -6247,7 +5526,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -6255,7 +5534,7 @@ The binary package name - not available yet Default value: `'nginx-prometheus-exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -6263,7 +5542,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -6271,7 +5550,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `scrape_uri` +##### `scrape_uri` Data type: `String[1]` @@ -6279,7 +5558,7 @@ The URI for the nginx status or nginx plus api page Default value: `'http://localhost:8080/stub_status'` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -6287,7 +5566,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -6295,7 +5574,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -6303,7 +5582,7 @@ Name of the node exporter service (default 'nginx_prometheus_exporter') Default value: `'nginx_prometheus_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -6311,7 +5590,7 @@ User which runs the service Default value: `'nginx-prometheus-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -6319,7 +5598,7 @@ The binary release version Default value: `'0.9.0'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -6327,7 +5606,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -6335,7 +5614,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -6343,7 +5622,7 @@ Data type: `Stdlib::Port` Default value: `9113` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -6351,7 +5630,7 @@ Data type: `String[1]` Default value: `'nginx'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -6359,7 +5638,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `String[1]` @@ -6367,7 +5646,7 @@ Data type: `String[1]` Default value: `'nginx-prometheus-exporter'` -##### `env_vars` +##### `env_vars` Data type: `Hash[String[1], Scalar]` @@ -6375,7 +5654,7 @@ Data type: `Hash[String[1], Scalar]` Default value: `{}` -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` @@ -6383,45 +5662,15 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::env_file_path` -### `prometheus::nginx_vts_exporter` +### `prometheus::nginx_vts_exporter` This module manages prometheus nginx_vts_exporter #### Parameters -The following parameters are available in the `prometheus::nginx_vts_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`nginx_scrape_uri`](#nginx_scrape_uri) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::nginx_vts_exporter` class. + +##### `arch` Data type: `String` @@ -6429,7 +5678,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `String` @@ -6437,19 +5686,19 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `nginx_scrape_uri` +##### `nginx_scrape_uri` Data type: `String` The URI to obtain nginx JSON stats from -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -6457,19 +5706,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `String` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -6477,13 +5726,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -6491,7 +5740,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -6499,7 +5748,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -6507,7 +5756,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -6515,7 +5764,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -6523,7 +5772,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String` @@ -6531,19 +5780,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -6551,7 +5800,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -6559,7 +5808,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -6567,7 +5816,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `String` @@ -6575,25 +5824,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the nginx-vts exporter service (default 'nginx-vts-exporter') -##### `user` +##### `user` Data type: `String` User which runs the service -##### `version` +##### `version` Data type: `String` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -6601,7 +5850,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -6609,7 +5858,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -6617,7 +5866,7 @@ Data type: `Stdlib::Port` Default value: `9913` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -6625,7 +5874,7 @@ Data type: `String[1]` Default value: `'nginx_vts'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -6633,50 +5882,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::node_exporter` +### `prometheus::node_exporter` This module manages prometheus node node_exporter #### Parameters -The following parameters are available in the `prometheus::node_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`collectors`](#collectors) -* [`collectors_enable`](#collectors_enable) -* [`collectors_disable`](#collectors_disable) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`env_vars`](#env_vars) -* [`env_file_path`](#env_file_path) -* [`scrape_host`](#scrape_host) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) - -##### `arch` +The following parameters are available in the `prometheus::node_exporter` class. + +##### `arch` Data type: `String[1]` @@ -6684,7 +5898,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -6692,7 +5906,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `collectors` +##### `collectors` Data type: `Optional[Array[String]]` @@ -6701,7 +5915,7 @@ will be removed in next release Default value: ``undef`` -##### `collectors_enable` +##### `collectors_enable` Data type: `Array[String]` @@ -6710,7 +5924,7 @@ https://github.com/prometheus/node_exporter#enabled-by-default Default value: `[]` -##### `collectors_disable` +##### `collectors_disable` Data type: `Array[String]` @@ -6719,13 +5933,13 @@ https://github.com/prometheus/node_exporter#enabled-by-default Default value: `[]` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -6733,19 +5947,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -6753,13 +5967,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -6767,7 +5981,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$prometheus::init_style` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -6775,7 +5989,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -6783,7 +5997,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -6791,7 +6005,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -6799,7 +6013,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -6807,19 +6021,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -6827,7 +6041,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -6835,7 +6049,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -6843,7 +6057,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -6851,7 +6065,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -6859,19 +6073,19 @@ Name of the node exporter service (default 'node_exporter') Default value: `'node_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `env_vars` +##### `env_vars` Data type: `Hash[String[1], Scalar]` @@ -6879,7 +6093,7 @@ hash with custom environment variables thats passed to the exporter via init scr Default value: `{}` -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` @@ -6887,7 +6101,7 @@ The path to the file with the environmetn variable that is read from the init sc Default value: `$prometheus::env_file_path` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -6895,7 +6109,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -6903,7 +6117,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -6911,7 +6125,7 @@ Data type: `Stdlib::Port` Default value: `9100` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -6919,7 +6133,7 @@ Data type: `String[1]` Default value: `'node'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -6927,7 +6141,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -6935,44 +6149,15 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::openldap_exporter` +### `prometheus::openldap_exporter` This module manages prometheus openldap_exporter #### Parameters -The following parameters are available in the `prometheus::openldap_exporter` class: - -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`options`](#options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`ldap_binddn`](#ldap_binddn) -* [`ldap_password`](#ldap_password) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `bin_dir` +The following parameters are available in the `prometheus::openldap_exporter` class. + +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -6980,7 +6165,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -6988,7 +6173,7 @@ Extension for the release binary archive Default value: `''` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -6996,7 +6181,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -7004,7 +6189,7 @@ Base URL for the binary archive Default value: `'https://github.com/tomcz/openldap_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -7012,7 +6197,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `options` +##### `options` Data type: `String` @@ -7021,7 +6206,7 @@ Do not use for user/password authentication Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -7029,7 +6214,7 @@ Group under which the binary is running Default value: `'openldap-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -7037,7 +6222,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -7045,7 +6230,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -7053,7 +6238,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -7061,7 +6246,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -7069,7 +6254,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -7077,7 +6262,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -7085,7 +6270,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -7093,7 +6278,7 @@ The binary package name - not available yet Default value: `'openldap_exporter'` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -7101,7 +6286,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -7109,7 +6294,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -7117,7 +6302,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -7125,7 +6310,7 @@ Name of the node exporter service (default 'openldap_exporter') Default value: `'openldap_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -7133,7 +6318,7 @@ User which runs the service Default value: `'openldap-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -7141,7 +6326,7 @@ The binary release version Default value: `'2.1'` -##### `ldap_binddn` +##### `ldap_binddn` Data type: `Optional[String[1]]` @@ -7149,7 +6334,7 @@ DN (LDAP User) used to authenticate to openldap cn=monitor tree Default value: ``undef`` -##### `ldap_password` +##### `ldap_password` Data type: `Optional[String[1]]` @@ -7157,7 +6342,7 @@ Password used to authenticate to openldap cn=monitor tree Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -7165,7 +6350,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -7173,7 +6358,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -7181,7 +6366,7 @@ Data type: `Stdlib::Port` Default value: `9330` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -7189,7 +6374,7 @@ Data type: `String[1]` Default value: `'openldap'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -7197,46 +6382,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::openvpn_exporter` +### `prometheus::openvpn_exporter` This module manages prometheus node openvpn_exporter #### Parameters -The following parameters are available in the `prometheus::openvpn_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`status_paths`](#status_paths) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`scrape_host`](#scrape_host) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) - -##### `arch` +The following parameters are available in the `prometheus::openvpn_exporter` class. + +##### `arch` Data type: `String[1]` @@ -7244,7 +6398,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -7252,7 +6406,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `status_paths` +##### `status_paths` Data type: `Array[Stdlib::Absolutepath]` @@ -7260,7 +6414,7 @@ The openvpn status files to monitor with this exporter Default value: `[]` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -7268,7 +6422,7 @@ Extension for the release binary archive Default value: `''` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -7276,7 +6430,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -7284,7 +6438,7 @@ Base URL for the binary archive Default value: `'https://github.com/wandera/openvpn_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` @@ -7292,7 +6446,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -7300,7 +6454,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -7308,7 +6462,7 @@ Group under which the binary is running Default value: `'openvpn-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -7316,7 +6470,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -7324,7 +6478,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -7332,7 +6486,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -7340,7 +6494,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -7348,7 +6502,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -7356,7 +6510,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -7364,7 +6518,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -7372,7 +6526,7 @@ The binary package name - not available yet Default value: `'openvpn_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -7380,7 +6534,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -7388,7 +6542,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -7396,7 +6550,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -7404,7 +6558,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -7412,7 +6566,7 @@ Name of the openvpn exporter service (default 'openvpn_exporter') Default value: `'openvpn_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -7420,7 +6574,7 @@ User which runs the service Default value: `'openvpn-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -7428,7 +6582,7 @@ The binary release version Default value: `'v0.3.0.3'` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -7436,7 +6590,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -7444,7 +6598,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -7452,7 +6606,7 @@ Data type: `Stdlib::Port` Default value: `9176` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -7460,7 +6614,7 @@ Data type: `String[1]` Default value: `'node'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -7468,7 +6622,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -7476,7 +6630,7 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::postfix_exporter` +### `prometheus::postfix_exporter` manages prometheus postfix_exporter @@ -7493,34 +6647,9 @@ include prometheus::postfix_exporter #### Parameters -The following parameters are available in the `prometheus::postfix_exporter` class: - -* [`install_method`](#install_method) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`download_extension`](#download_extension) -* [`version`](#version) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`manage_user`](#manage_user) -* [`user`](#user) -* [`manage_group`](#manage_group) -* [`group`](#group) -* [`extra_groups`](#extra_groups) -* [`manage_service`](#manage_service) -* [`init_style`](#init_style) -* [`service_name`](#service_name) -* [`service_ensure`](#service_ensure) -* [`service_enable`](#service_enable) -* [`extra_options`](#extra_options) -* [`restart_on_change`](#restart_on_change) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`scrape_host`](#scrape_host) - -##### `install_method` +The following parameters are available in the `prometheus::postfix_exporter` class. + +##### `install_method` Data type: `Prometheus::Install` @@ -7528,7 +6657,7 @@ Installation method: `url` or `package`. (Note `package` is not available on mos Default value: `'url'` -##### `download_url` +##### `download_url` Data type: `Optional[Stdlib::HTTPUrl]` @@ -7536,7 +6665,7 @@ Complete URL corresponding to the where the release can be downloaded. (This opt Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Stdlib::HTTPUrl` @@ -7544,7 +6673,7 @@ Base URL for the binary archive. (This option is only relevant when `install_met Default value: `'https://github.com/kumina/postfix_exporter/releases'` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -7552,7 +6681,7 @@ Extension for the release binary archive. (This option is only relevant when `in Default value: `''` -##### `version` +##### `version` Data type: `String[1]` @@ -7560,7 +6689,7 @@ The binary release version. (This option is only relevant when `install_method` Default value: `'0.2.0'` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -7568,7 +6697,7 @@ Used when `install_method` is `package`. Default value: `'installed'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -7576,7 +6705,7 @@ Used when `install_method` is `package`. Default value: `'postfix_exporter'` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -7584,7 +6713,7 @@ Whether to create and manage the exporter's user. This can eg. be set to `false` Default value: ``true`` -##### `user` +##### `user` Data type: `String[1]` @@ -7592,7 +6721,7 @@ User which runs the service. Default value: `'postfix-exporter'` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -7600,7 +6729,7 @@ Whether to create and manage the exporter's group. This can eg. be set to `false Default value: ``true`` -##### `group` +##### `group` Data type: `String[1]` @@ -7608,7 +6737,7 @@ Group to run the service as. Default value: `'postfix-exporter'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` @@ -7616,7 +6745,7 @@ Extra groups to add the exporter user to. Default value: `[]` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -7624,7 +6753,7 @@ Should puppet manage the service? Default value: ``true`` -##### `init_style` +##### `init_style` Data type: `Optional[Prometheus::Initstyle]` @@ -7634,7 +6763,7 @@ Typically this can be used when a package is already providing the file. Default value: ``undef`` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -7642,7 +6771,7 @@ The name of the service. Default value: `'postfix_exporter'` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -7650,7 +6779,7 @@ Desired state for the service. Default value: `'running'` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -7658,7 +6787,7 @@ Whether to enable the service from puppet. Default value: ``true`` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -7666,7 +6795,7 @@ Extra options added to the startup command. Override these if you want to monito Default value: `'--systemd.enable --systemd.unit=\'postfix.service\' --postfix.logfile_path=\'\''` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -7674,7 +6803,7 @@ Should puppet restart the service on configuration change? Default value: ``true`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -7682,7 +6811,7 @@ Whether to export a `prometheus::scrape_job` to puppetDB for collecting on your Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -7690,7 +6819,7 @@ The port to use in the scrape job. This won't normally need to be changed unles Default value: `9154` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -7698,7 +6827,7 @@ The name of the scrape job. When configuring prometheus with this puppet module, Default value: `'postfix'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -7706,7 +6835,7 @@ Labels to configure on the scrape job. If not set, the `prometheus::daemon` defa Default value: ``undef`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -7714,49 +6843,15 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -### `prometheus::postgres_exporter` +### `prometheus::postgres_exporter` This module manages prometheus node postgres_exporter #### Parameters -The following parameters are available in the `prometheus::postgres_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`data_source_custom`](#data_source_custom) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`postgres_user`](#postgres_user) -* [`postgres_pass`](#postgres_pass) -* [`postgres_auth_method`](#postgres_auth_method) -* [`data_source_uri`](#data_source_uri) -* [`options`](#options) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::postgres_exporter` class. + +##### `arch` Data type: `String[1]` @@ -7764,7 +6859,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -7772,7 +6867,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `data_source_custom` +##### `data_source_custom` Data type: `Hash[String[1],String[1]]` @@ -7780,13 +6875,13 @@ Hash of key:value pair to use for alternate environment variables when using par Default value: `{}` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -7794,25 +6889,25 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` Extra groups to add the binary user to -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -7820,7 +6915,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -7828,7 +6923,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -7836,7 +6931,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -7844,7 +6939,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -7852,7 +6947,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -7860,19 +6955,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -7880,7 +6975,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -7888,7 +6983,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -7896,7 +6991,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -7904,7 +6999,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -7912,19 +7007,19 @@ Name of the node exporter service (default 'postgres_exporter') Default value: `'postgres_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `postgres_user` +##### `postgres_user` Data type: `Optional[String]` @@ -7932,7 +7027,7 @@ User to authenticate against postgres Default value: ``undef`` -##### `postgres_pass` +##### `postgres_pass` Data type: `Optional[String]` @@ -7940,7 +7035,7 @@ Password to authenticate against postgres Default value: ``undef`` -##### `postgres_auth_method` +##### `postgres_auth_method` Data type: `Enum['custom', 'env', 'file']` @@ -7948,13 +7043,13 @@ method for presenting username and password to the exporter This can be file, or env (default 'env') Using 'custom' requires 'data_source_custom' values -##### `data_source_uri` +##### `data_source_uri` Data type: `String[1]` Uri on howto connect to the database -##### `options` +##### `options` Data type: `String` @@ -7962,7 +7057,7 @@ Data type: `String` Default value: `''` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -7970,7 +7065,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -7978,7 +7073,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -7986,7 +7081,7 @@ Data type: `Stdlib::Port` Default value: `9187` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -7994,7 +7089,7 @@ Data type: `String[1]` Default value: `'postgres'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -8002,7 +7097,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::process_exporter` +### `prometheus::process_exporter` This module manages prometheus process_exporter @@ -8033,42 +7128,9 @@ class { 'prometheus::process_exporter': #### Parameters -The following parameters are available in the `prometheus::process_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`hash_watched_processes`](#hash_watched_processes) -* [`watched_processes`](#watched_processes) -* [`config_path`](#config_path) -* [`config_mode`](#config_mode) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::process_exporter` class. + +##### `arch` Data type: `String[1]` @@ -8076,7 +7138,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -8084,13 +7146,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -8098,19 +7160,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -8118,13 +7180,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -8132,7 +7194,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -8140,7 +7202,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -8148,7 +7210,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -8156,7 +7218,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -8164,7 +7226,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -8172,19 +7234,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -8192,7 +7254,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -8200,7 +7262,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -8208,7 +7270,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -8216,25 +7278,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the process exporter service (default 'process-exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `hash_watched_processes` +##### `hash_watched_processes` Data type: `Hash` @@ -8243,7 +7305,7 @@ Don't set if you want to use only the Array version of it (watched_processes) Default value: `{}` -##### `watched_processes` +##### `watched_processes` Data type: `Array` @@ -8252,13 +7314,13 @@ Has no effect if hash_watched_processes is set Default value: `[]` -##### `config_path` +##### `config_path` Data type: `Stdlib::Absolutepath` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -8266,7 +7328,7 @@ Data type: `String[1]` Default value: `$prometheus::config_mode` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -8274,7 +7336,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -8282,7 +7344,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -8290,7 +7352,7 @@ Data type: `Stdlib::Port` Default value: `9256` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -8298,7 +7360,7 @@ Data type: `String[1]` Default value: `'process'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -8306,46 +7368,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::puppetdb_exporter` +### `prometheus::puppetdb_exporter` This module manages prometheus node puppetdb_exporter #### Parameters -The following parameters are available in the `prometheus::puppetdb_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`puppetdb_url`](#puppetdb_url) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) - -##### `arch` +The following parameters are available in the `prometheus::puppetdb_exporter` class. + +##### `arch` Data type: `String[1]` @@ -8353,7 +7384,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -8361,7 +7392,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -8369,7 +7400,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -8377,7 +7408,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -8385,7 +7416,7 @@ Base URL for the binary archive Default value: `'https://github.com/camptocamp/prometheus-puppetdb-exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -8393,7 +7424,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -8401,7 +7432,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -8409,7 +7440,7 @@ Group under which the binary is running Default value: `'puppetdb-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -8417,7 +7448,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -8425,7 +7456,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -8433,7 +7464,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -8441,7 +7472,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -8449,7 +7480,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -8457,7 +7488,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -8465,7 +7496,7 @@ If package, then use this for package ensure default 'latest' Default value: `'present'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -8473,7 +7504,7 @@ The binary package name - not available yet Default value: `'puppetdb_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -8481,7 +7512,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -8489,7 +7520,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -8497,7 +7528,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -8505,7 +7536,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -8513,7 +7544,7 @@ Name of the puppetdb exporter service (default 'puppetdb_exporter') Default value: `'puppetdb_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -8521,7 +7552,7 @@ User which runs the service Default value: `'puppetdb-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -8529,7 +7560,7 @@ The binary release version Default value: `'1.1.0'` -##### `puppetdb_url` +##### `puppetdb_url` Data type: `Stdlib::HTTPUrl` @@ -8537,7 +7568,7 @@ The URI to PuppetDB with http/https protocol at the beginning and `/pdb/query` a Default value: `'http://127.0.0.1:8080/pdb/query'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -8545,7 +7576,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -8553,7 +7584,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -8561,7 +7592,7 @@ Data type: `Stdlib::Port` Default value: `9635` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -8569,7 +7600,7 @@ Data type: `String[1]` Default value: `'puppetdb'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -8577,7 +7608,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -8585,38 +7616,15 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::pushgateway` +### `prometheus::pushgateway` This module manages prometheus node pushgateway #### Parameters -The following parameters are available in the `prometheus::pushgateway` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) - -##### `arch` +The following parameters are available in the `prometheus::pushgateway` class. + +##### `arch` Data type: `String[1]` @@ -8624,7 +7632,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `String[1]` @@ -8632,13 +7640,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String[1]` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[String]` @@ -8646,19 +7654,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `String[1]` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -8666,13 +7674,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -8680,7 +7688,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `String[1]` @@ -8688,7 +7696,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -8696,7 +7704,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -8704,7 +7712,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -8712,7 +7720,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -8720,19 +7728,19 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -8740,7 +7748,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -8748,7 +7756,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -8756,7 +7764,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -8764,54 +7772,27 @@ Name of the node exporter service (default 'pushgateway') Default value: `'pushgateway'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -### `prometheus::pushprox_client` +### `prometheus::pushprox_client` This module manages prometheus pushprox_client #### Parameters -The following parameters are available in the `prometheus::pushprox_client` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`env_vars`](#env_vars) -* [`proxy_url`](#proxy_url) - -##### `arch` +The following parameters are available in the `prometheus::pushprox_client` class. + +##### `arch` Data type: `String[1]` @@ -8819,7 +7800,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -8827,7 +7808,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -8835,13 +7816,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String[1]` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[String]` @@ -8849,19 +7830,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -8869,13 +7850,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -8883,7 +7864,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `String[1]` @@ -8891,7 +7872,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -8899,7 +7880,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -8907,7 +7888,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -8915,7 +7896,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -8923,19 +7904,19 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -8943,7 +7924,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -8951,7 +7932,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -8959,7 +7940,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -8967,7 +7948,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -8975,19 +7956,19 @@ Name of the pushprox_client service (default 'pushprox_client') Default value: `'pushprox_client'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `env_vars` +##### `env_vars` Data type: `Hash[String, Scalar]` @@ -8995,46 +7976,21 @@ The environment variable to pass to the daemon Default value: `{}` -##### `proxy_url` +##### `proxy_url` Data type: `String[1]` -### `prometheus::pushprox_proxy` +### `prometheus::pushprox_proxy` This module manages prometheus pushprox_proxy #### Parameters -The following parameters are available in the `prometheus::pushprox_proxy` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) - -##### `arch` +The following parameters are available in the `prometheus::pushprox_proxy` class. + +##### `arch` Data type: `String[1]` @@ -9042,7 +7998,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -9050,7 +8006,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -9058,13 +8014,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String[1]` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[String]` @@ -9072,19 +8028,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -9092,13 +8048,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -9106,7 +8062,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$prometheus::init_style` -##### `install_method` +##### `install_method` Data type: `String[1]` @@ -9114,7 +8070,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -9122,7 +8078,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -9130,7 +8086,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -9138,7 +8094,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -9146,19 +8102,19 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -9166,7 +8122,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -9174,7 +8130,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -9182,7 +8138,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -9190,7 +8146,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -9198,64 +8154,27 @@ Name of the pushprox_proxy service (default 'pushprox_proxy') Default value: `'pushprox_proxy'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -### `prometheus::rabbitmq_exporter` +### `prometheus::rabbitmq_exporter` This module manages prometheus rabbitmq_exporter #### Parameters -The following parameters are available in the `prometheus::rabbitmq_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`rabbit_url`](#rabbit_url) -* [`rabbit_user`](#rabbit_user) -* [`rabbit_password`](#rabbit_password) -* [`queues_include_regex`](#queues_include_regex) -* [`queues_exclude_regex`](#queues_exclude_regex) -* [`rabbit_capabilities`](#rabbit_capabilities) -* [`rabbit_exporters`](#rabbit_exporters) -* [`extra_env_vars`](#extra_env_vars) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::rabbitmq_exporter` class. + +##### `arch` Data type: `String[1]` @@ -9263,7 +8182,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -9271,13 +8190,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -9285,19 +8204,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -9305,13 +8224,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -9319,7 +8238,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -9327,7 +8246,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -9335,7 +8254,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -9343,7 +8262,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -9351,7 +8270,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -9359,19 +8278,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -9379,7 +8298,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -9387,7 +8306,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -9395,7 +8314,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -9403,69 +8322,69 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the rabbitmq exporter service (default 'rabbitmq_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `rabbit_url` +##### `rabbit_url` Data type: `String[1]` URL of the RabbitMQ management plugin -##### `rabbit_user` +##### `rabbit_user` Data type: `String[1]` User to authenticate against RabbitMQ -##### `rabbit_password` +##### `rabbit_password` Data type: `String[1]` Password to authenticate against RabbitMQ -##### `queues_include_regex` +##### `queues_include_regex` Data type: `String[1]` Regular expression used by the exported to chose which queues to export -##### `queues_exclude_regex` +##### `queues_exclude_regex` Data type: `String[1]` Regular expression used by the exported to chose which queues NOT to export -##### `rabbit_capabilities` +##### `rabbit_capabilities` Data type: `Array[String]` Special capabilities supported by the RabbitMQ version. See README for more details. (default '') -##### `rabbit_exporters` +##### `rabbit_exporters` Data type: `Array[String]` Which exporter modules should be loaded by default (default 'exchange,node,overview,queue') -##### `extra_env_vars` +##### `extra_env_vars` Data type: `Hash[String,String]` @@ -9474,7 +8393,7 @@ Additional environment variables that should be supplied to the exporter, as a h Default value: `{}` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -9482,7 +8401,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -9490,7 +8409,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -9498,7 +8417,7 @@ Data type: `Stdlib::Port` Default value: `9090` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -9506,7 +8425,7 @@ Data type: `String[1]` Default value: `'rabbitmq'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -9514,46 +8433,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::redis_exporter` +### `prometheus::redis_exporter` This module manages prometheus node redis_exporter #### Parameters -The following parameters are available in the `prometheus::redis_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`addr`](#addr) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`namespace`](#namespace) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::redis_exporter` class. + +##### `arch` Data type: `String[1]` @@ -9561,7 +8449,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -9569,19 +8457,19 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `addr` +##### `addr` Data type: `Array[String]` Array of address of one or more redis nodes. Defaults to redis://localhost:6379 -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -9589,19 +8477,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -9611,13 +8499,13 @@ please refer to https://github.com/oliver006/redis_exporter Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -9625,7 +8513,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -9633,7 +8521,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -9641,7 +8529,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -9649,7 +8537,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -9657,7 +8545,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `namespace` +##### `namespace` Data type: `String[1]` @@ -9665,7 +8553,7 @@ Namespace for the metrics, defaults to `redis`. Default value: `'redis'` -##### `os` +##### `os` Data type: `String[1]` @@ -9673,19 +8561,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -9693,7 +8581,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -9701,7 +8589,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -9709,7 +8597,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -9717,7 +8605,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -9725,19 +8613,19 @@ Name of the node exporter service (default 'redis_exporter') Default value: `'redis_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -9745,7 +8633,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -9753,7 +8641,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -9761,7 +8649,7 @@ Data type: `Stdlib::Port` Default value: `9121` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -9769,7 +8657,7 @@ Data type: `String[1]` Default value: `'redis'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -9777,51 +8665,19 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::run_service` +### `prometheus::run_service` This class is meant to be called from prometheus. It ensure the service is running -### `prometheus::sachet` +### `prometheus::sachet` This module manages prometheus sachet (https://github.com/messagebird/sachet) #### Parameters -The following parameters are available in the `prometheus::sachet` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`templates`](#templates) -* [`receivers`](#receivers) -* [`providers`](#providers) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`config_dir`](#config_dir) -* [`config_file`](#config_file) -* [`config_mode`](#config_mode) -* [`listen_port`](#listen_port) -* [`bin_name`](#bin_name) - -##### `arch` +The following parameters are available in the `prometheus::sachet` class. + +##### `arch` Data type: `String[1]` @@ -9829,7 +8685,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -9837,7 +8693,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -9845,7 +8701,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -9853,7 +8709,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -9861,7 +8717,7 @@ Base URL for the binary archive Default value: `'https://github.com/messagebird/sachet/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -9869,7 +8725,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -9877,7 +8733,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -9885,7 +8741,7 @@ Group under which the binary is running Default value: `'sachet'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -9893,7 +8749,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$prometheus::init_style` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -9901,7 +8757,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -9909,7 +8765,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -9917,7 +8773,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -9925,7 +8781,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -9933,7 +8789,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -9941,7 +8797,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -9949,7 +8805,7 @@ The binary package name - not available yet Default value: `'sachet'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -9957,7 +8813,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `templates` +##### `templates` Data type: `Array` @@ -9983,7 +8839,7 @@ prometheus::sachet::templates: Default value: `[]` -##### `receivers` +##### `receivers` Data type: `Array` @@ -9996,7 +8852,7 @@ prometheus::sachet::receivers: Default value: `[]` -##### `providers` +##### `providers` Data type: `Hash` @@ -10009,7 +8865,7 @@ prometheus::sachet::providers: Default value: `{}` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -10017,7 +8873,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -10025,7 +8881,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -10033,7 +8889,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -10041,7 +8897,7 @@ Name of the node exporter service (default 'sachet') Default value: `'sachet'` -##### `user` +##### `user` Data type: `String[1]` @@ -10049,7 +8905,7 @@ User which runs the service Default value: `'sachet'` -##### `version` +##### `version` Data type: `String[1]` @@ -10057,7 +8913,7 @@ The binary release version Default value: `'0.2.6'` -##### `config_dir` +##### `config_dir` Data type: `Stdlib::Absolutepath` @@ -10065,7 +8921,7 @@ Data type: `Stdlib::Absolutepath` Default value: `'/etc/sachet'` -##### `config_file` +##### `config_file` Data type: `Stdlib::Absolutepath` @@ -10073,7 +8929,7 @@ Data type: `Stdlib::Absolutepath` Default value: `'/etc/sachet/sachet.yaml'` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -10081,7 +8937,7 @@ Data type: `String[1]` Default value: `$prometheus::config_mode` -##### `listen_port` +##### `listen_port` Data type: `Stdlib::Port` @@ -10089,7 +8945,7 @@ Data type: `Stdlib::Port` Default value: `9876` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -10097,65 +8953,15 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::server` +### `prometheus::server` class to manage the actual prometheus server. This class gets called from the init.pp #### Parameters -The following parameters are available in the `prometheus::server` class: - -* [`configname`](#configname) -* [`user`](#user) -* [`group`](#group) -* [`extra_groups`](#extra_groups) -* [`bin_dir`](#bin_dir) -* [`shared_dir`](#shared_dir) -* [`version`](#version) -* [`install_method`](#install_method) -* [`download_url_base`](#download_url_base) -* [`download_extension`](#download_extension) -* [`package_name`](#package_name) -* [`package_ensure`](#package_ensure) -* [`config_dir`](#config_dir) -* [`localstorage`](#localstorage) -* [`config_template`](#config_template) -* [`config_mode`](#config_mode) -* [`global_config`](#global_config) -* [`rule_files`](#rule_files) -* [`scrape_configs`](#scrape_configs) -* [`include_default_scrape_configs`](#include_default_scrape_configs) -* [`remote_read_configs`](#remote_read_configs) -* [`remote_write_configs`](#remote_write_configs) -* [`alerts`](#alerts) -* [`alert_relabel_config`](#alert_relabel_config) -* [`alertmanagers_config`](#alertmanagers_config) -* [`storage_retention`](#storage_retention) -* [`env_file_path`](#env_file_path) -* [`extra_alerts`](#extra_alerts) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`manage_service`](#manage_service) -* [`restart_on_change`](#restart_on_change) -* [`init_style`](#init_style) -* [`extra_options`](#extra_options) -* [`config_hash`](#config_hash) -* [`config_defaults`](#config_defaults) -* [`os`](#os) -* [`download_url`](#download_url) -* [`arch`](#arch) -* [`manage_group`](#manage_group) -* [`purge_config_dir`](#purge_config_dir) -* [`manage_user`](#manage_user) -* [`manage_config`](#manage_config) -* [`external_url`](#external_url) -* [`collect_scrape_jobs`](#collect_scrape_jobs) -* [`collect_tag`](#collect_tag) -* [`max_open_files`](#max_open_files) -* [`usershell`](#usershell) - -##### `configname` +The following parameters are available in the `prometheus::server` class. + +##### `configname` Data type: `String` @@ -10163,7 +8969,7 @@ Data type: `String` Default value: `$prometheus::configname` -##### `user` +##### `user` Data type: `String` @@ -10171,7 +8977,7 @@ Data type: `String` Default value: `$prometheus::user` -##### `group` +##### `group` Data type: `String` @@ -10179,7 +8985,7 @@ Data type: `String` Default value: `$prometheus::group` -##### `extra_groups` +##### `extra_groups` Data type: `Array` @@ -10187,7 +8993,7 @@ Data type: `Array` Default value: `$prometheus::extra_groups` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -10195,7 +9001,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::bin_dir` -##### `shared_dir` +##### `shared_dir` Data type: `Stdlib::Absolutepath` @@ -10203,7 +9009,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::shared_dir` -##### `version` +##### `version` Data type: `String` @@ -10211,7 +9017,7 @@ Data type: `String` Default value: `$prometheus::version` -##### `install_method` +##### `install_method` Data type: `String` @@ -10219,7 +9025,7 @@ Data type: `String` Default value: `$prometheus::install_method` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -10227,7 +9033,7 @@ Data type: `Prometheus::Uri` Default value: `$prometheus::download_url_base` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -10235,7 +9041,7 @@ Data type: `String` Default value: `$prometheus::download_extension` -##### `package_name` +##### `package_name` Data type: `String` @@ -10243,7 +9049,7 @@ Data type: `String` Default value: `$prometheus::package_name` -##### `package_ensure` +##### `package_ensure` Data type: `String` @@ -10251,7 +9057,7 @@ Data type: `String` Default value: `$prometheus::package_ensure` -##### `config_dir` +##### `config_dir` Data type: `String` @@ -10259,15 +9065,15 @@ Data type: `String` Default value: `$prometheus::config_dir` -##### `localstorage` +##### `localstorage` -Data type: `Stdlib::Absolutepath` +Data type: `Variant[Stdlib::Absolutepath, Boolean[false]]` Default value: `$prometheus::localstorage` -##### `config_template` +##### `config_template` Data type: `String` @@ -10275,7 +9081,7 @@ Data type: `String` Default value: `$prometheus::config_template` -##### `config_mode` +##### `config_mode` Data type: `String` @@ -10283,7 +9089,7 @@ Data type: `String` Default value: `$prometheus::config_mode` -##### `global_config` +##### `global_config` Data type: `Hash` @@ -10291,7 +9097,7 @@ Data type: `Hash` Default value: `$prometheus::global_config` -##### `rule_files` +##### `rule_files` Data type: `Array` @@ -10299,7 +9105,7 @@ Data type: `Array` Default value: `$prometheus::rule_files` -##### `scrape_configs` +##### `scrape_configs` Data type: `Array` @@ -10307,7 +9113,7 @@ Data type: `Array` Default value: `$prometheus::scrape_configs` -##### `include_default_scrape_configs` +##### `include_default_scrape_configs` Data type: `Boolean` @@ -10315,7 +9121,7 @@ Data type: `Boolean` Default value: `$prometheus::include_default_scrape_configs` -##### `remote_read_configs` +##### `remote_read_configs` Data type: `Array` @@ -10323,7 +9129,7 @@ Data type: `Array` Default value: `$prometheus::remote_read_configs` -##### `remote_write_configs` +##### `remote_write_configs` Data type: `Array` @@ -10331,7 +9137,7 @@ Data type: `Array` Default value: `$prometheus::remote_write_configs` -##### `alerts` +##### `alerts` Data type: `Variant[Array,Hash]` @@ -10339,7 +9145,7 @@ Data type: `Variant[Array,Hash]` Default value: `$prometheus::alerts` -##### `alert_relabel_config` +##### `alert_relabel_config` Data type: `Array` @@ -10347,7 +9153,7 @@ Data type: `Array` Default value: `$prometheus::alert_relabel_config` -##### `alertmanagers_config` +##### `alertmanagers_config` Data type: `Array` @@ -10355,15 +9161,15 @@ Data type: `Array` Default value: `$prometheus::alertmanagers_config` -##### `storage_retention` +##### `storage_retention` -Data type: `String` +Data type: `Variant[String, Boolean[false]]` Default value: `$prometheus::storage_retention` -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` @@ -10371,7 +9177,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::env_file_path` -##### `extra_alerts` +##### `extra_alerts` Data type: `Hash` @@ -10379,7 +9185,7 @@ Data type: `Hash` Default value: `$prometheus::extra_alerts` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -10387,7 +9193,7 @@ Data type: `Boolean` Default value: `$prometheus::service_enable` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -10395,7 +9201,7 @@ Data type: `Stdlib::Ensure::Service` Default value: `$prometheus::service_ensure` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -10403,7 +9209,7 @@ Data type: `String[1]` Default value: `$prometheus::service_name` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -10411,7 +9217,7 @@ Data type: `Boolean` Default value: `$prometheus::manage_service` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -10419,7 +9225,7 @@ Data type: `Boolean` Default value: `$prometheus::restart_on_change` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -10427,7 +9233,7 @@ Data type: `Prometheus::Initstyle` Default value: `$facts['service_provider']` -##### `extra_options` +##### `extra_options` Data type: `Optional[String[1]]` @@ -10435,7 +9241,7 @@ Data type: `Optional[String[1]]` Default value: `$prometheus::extra_options` -##### `config_hash` +##### `config_hash` Data type: `Hash` @@ -10443,7 +9249,7 @@ Data type: `Hash` Default value: `$prometheus::config_hash` -##### `config_defaults` +##### `config_defaults` Data type: `Hash` @@ -10451,7 +9257,7 @@ Data type: `Hash` Default value: `$prometheus::config_defaults` -##### `os` +##### `os` Data type: `String[1]` @@ -10459,7 +9265,7 @@ Data type: `String[1]` Default value: `$prometheus::os` -##### `download_url` +##### `download_url` Data type: `Optional[String]` @@ -10467,7 +9273,7 @@ Data type: `Optional[String]` Default value: `$prometheus::download_url` -##### `arch` +##### `arch` Data type: `String[1]` @@ -10475,7 +9281,7 @@ Data type: `String[1]` Default value: `$prometheus::real_arch` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -10483,7 +9289,7 @@ Data type: `Boolean` Default value: `$prometheus::manage_group` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -10491,7 +9297,7 @@ Data type: `Boolean` Default value: `$prometheus::purge_config_dir` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -10499,7 +9305,7 @@ Data type: `Boolean` Default value: `$prometheus::manage_user` -##### `manage_config` +##### `manage_config` Data type: `Boolean` @@ -10507,7 +9313,7 @@ Data type: `Boolean` Default value: `$prometheus::manage_config` -##### `external_url` +##### `external_url` Data type: `Optional[Variant[Stdlib::HTTPurl, Stdlib::Unixpath, String[1]]]` @@ -10515,7 +9321,7 @@ Data type: `Optional[Variant[Stdlib::HTTPurl, Stdlib::Unixpath, String[1]]]` Default value: `$prometheus::external_url` -##### `collect_scrape_jobs` +##### `collect_scrape_jobs` Data type: `Optional[Array[Hash[String[1], Any]]]` @@ -10523,7 +9329,7 @@ Data type: `Optional[Array[Hash[String[1], Any]]]` Default value: `$prometheus::collect_scrape_jobs` -##### `collect_tag` +##### `collect_tag` Data type: `Optional[String[1]]` @@ -10531,7 +9337,7 @@ Data type: `Optional[String[1]]` Default value: `$prometheus::collect_tag` -##### `max_open_files` +##### `max_open_files` Data type: `Optional[Integer]` @@ -10539,7 +9345,7 @@ Data type: `Optional[Integer]` Default value: `$prometheus::max_open_files` -##### `usershell` +##### `usershell` Data type: `Stdlib::Absolutepath` @@ -10547,47 +9353,15 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::usershell` -### `prometheus::snmp_exporter` +### `prometheus::snmp_exporter` This module manages prometheus snmp_exporter #### Parameters -The following parameters are available in the `prometheus::snmp_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_file`](#config_file) -* [`config_mode`](#config_mode) -* [`config_template`](#config_template) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::snmp_exporter` class. + +##### `arch` Data type: `String[1]` @@ -10595,7 +9369,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -10603,13 +9377,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `String[1]` Absolute path to configuration file -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -10617,19 +9391,19 @@ Configuration file mode (default 0660) Default value: `$prometheus::config_mode` -##### `config_template` +##### `config_template` Data type: `String` Configuration template to use. If empty, uses upstream config (default "") -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -10637,19 +9411,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -10657,13 +9431,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -10671,7 +9445,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -10679,7 +9453,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -10687,7 +9461,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -10695,7 +9469,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -10703,7 +9477,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -10711,19 +9485,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -10731,7 +9505,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -10739,7 +9513,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -10747,7 +9521,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -10755,25 +9529,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the snmp exporter service (default 'snmp_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -10781,7 +9555,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -10789,7 +9563,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -10797,7 +9571,7 @@ Data type: `Stdlib::Port` Default value: `9116` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -10805,7 +9579,7 @@ Data type: `String[1]` Default value: `'snmp'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -10813,48 +9587,15 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::ssh_exporter` +### `prometheus::ssh_exporter` This module manages prometheus ssh_exporter (https://github.com/treydock/ssh_exporter) #### Parameters -The following parameters are available in the `prometheus::ssh_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_file`](#config_file) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`modules`](#modules) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`scrape_host`](#scrape_host) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) - -##### `arch` +The following parameters are available in the `prometheus::ssh_exporter` class. + +##### `arch` Data type: `String[1]` @@ -10862,7 +9603,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -10870,7 +9611,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `Stdlib::Absolutepath` @@ -10878,7 +9619,7 @@ Path to SSH exporter configuration file Default value: `'/etc/ssh_exporter.yaml'` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -10886,7 +9627,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -10894,7 +9635,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -10902,7 +9643,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -10910,7 +9651,7 @@ Base URL for the binary archive Default value: `'https://github.com/treydock/ssh_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -10918,7 +9659,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -10926,7 +9667,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -10934,7 +9675,7 @@ Group under which the binary is running Default value: `'ssh-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -10942,7 +9683,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -10950,7 +9691,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -10958,7 +9699,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -10966,7 +9707,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -10974,7 +9715,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `modules` +##### `modules` Data type: `Hash` @@ -10982,7 +9723,7 @@ Hash of SSH exporter modules Default value: `{}` -##### `os` +##### `os` Data type: `String[1]` @@ -10990,7 +9731,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -10998,7 +9739,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -11006,7 +9747,7 @@ The binary package name - not available yet Default value: `'ssh_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -11014,7 +9755,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -11022,7 +9763,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -11030,7 +9771,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -11038,7 +9779,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -11046,7 +9787,7 @@ Name of the node exporter service (default 'ssh_exporter') Default value: `'ssh_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -11054,7 +9795,7 @@ User which runs the service Default value: `'ssh-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -11062,7 +9803,7 @@ The binary release version Default value: `'1.2.0'` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -11070,7 +9811,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -11078,7 +9819,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -11086,7 +9827,7 @@ Data type: `Stdlib::Port` Default value: `9312` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -11094,7 +9835,7 @@ Data type: `String[1]` Default value: `'ssh'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -11102,7 +9843,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -11110,48 +9851,15 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::ssl_exporter` +### `prometheus::ssl_exporter` This module manages prometheus ssl_exporter (https://github.com/ribbybibby/ssl_exporter) #### Parameters -The following parameters are available in the `prometheus::ssl_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_file`](#config_file) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`modules`](#modules) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`scrape_host`](#scrape_host) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) - -##### `arch` +The following parameters are available in the `prometheus::ssl_exporter` class. + +##### `arch` Data type: `String[1]` @@ -11159,7 +9867,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -11167,7 +9875,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `Stdlib::Absolutepath` @@ -11175,7 +9883,7 @@ Path to SSL exporter configuration file Default value: `'/etc/ssl_exporter.yaml'` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -11183,7 +9891,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -11191,7 +9899,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -11199,7 +9907,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -11207,7 +9915,7 @@ Base URL for the binary archive Default value: `'https://github.com/ribbybibby/ssl_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -11215,7 +9923,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -11223,7 +9931,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -11231,7 +9939,7 @@ Group under which the binary is running Default value: `'ssl-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -11239,7 +9947,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -11247,7 +9955,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -11255,7 +9963,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -11263,7 +9971,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -11271,7 +9979,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `modules` +##### `modules` Data type: `Hash` @@ -11279,7 +9987,7 @@ Hash of SSL exporter modules Default value: `{}` -##### `os` +##### `os` Data type: `String[1]` @@ -11287,7 +9995,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -11295,7 +10003,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -11303,7 +10011,7 @@ The binary package name - not available yet Default value: `'ssl_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -11311,7 +10019,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -11319,7 +10027,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -11327,7 +10035,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -11335,7 +10043,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -11343,7 +10051,7 @@ Name of the node exporter service (default 'ssk_exporter') Default value: `'ssl_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -11351,7 +10059,7 @@ User which runs the service Default value: `'ssl-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -11359,7 +10067,7 @@ The binary release version Default value: `'2.2.1'` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -11367,7 +10075,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -11375,7 +10083,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -11383,7 +10091,7 @@ Data type: `Stdlib::Port` Default value: `9219` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -11391,7 +10099,7 @@ Data type: `String[1]` Default value: `'ssl'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -11399,7 +10107,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -11407,47 +10115,15 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::statsd_exporter` +### `prometheus::statsd_exporter` This module manages prometheus statsd_exporter #### Parameters -The following parameters are available in the `prometheus::statsd_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`config_mode`](#config_mode) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`mappings`](#mappings) -* [`user`](#user) -* [`version`](#version) -* [`mapping_config_path`](#mapping_config_path) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::statsd_exporter` class. + +##### `arch` Data type: `String[1]` @@ -11455,7 +10131,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -11463,7 +10139,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -11471,13 +10147,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -11485,19 +10161,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -11505,13 +10181,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -11519,7 +10195,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -11527,7 +10203,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -11535,7 +10211,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -11543,7 +10219,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -11551,7 +10227,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -11559,19 +10235,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -11579,7 +10255,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -11587,7 +10263,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -11595,7 +10271,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -11603,13 +10279,13 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the statsd exporter service (default 'statsd_exporter') -##### `mappings` +##### `mappings` Data type: `Array[Hash]` @@ -11620,25 +10296,25 @@ The hiera array for mappings: processor: '$2' action: '$1' -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `mapping_config_path` +##### `mapping_config_path` Data type: `Stdlib::Absolutepath` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -11646,7 +10322,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -11654,7 +10330,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -11662,7 +10338,7 @@ Data type: `Stdlib::Port` Default value: `9102` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -11670,7 +10346,7 @@ Data type: `String[1]` Default value: `'statsd'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -11678,7 +10354,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::unbound_exporter` +### `prometheus::unbound_exporter` This module manages prometheus unbound exporter. The exporter needs to be compiled by hand! (https://github.com/kumina/unbound_exporter/issues/21) @@ -11687,39 +10363,9 @@ This module manages prometheus unbound exporter. The exporter needs to be compil #### Parameters -The following parameters are available in the `prometheus::unbound_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`bin_name`](#bin_name) -* [`env_vars`](#env_vars) - -##### `arch` +The following parameters are available in the `prometheus::unbound_exporter` class. + +##### `arch` Data type: `String[1]` @@ -11727,7 +10373,7 @@ Architecture Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -11735,7 +10381,7 @@ Directory where binaries are located Default value: `'/usr/local/bin'` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -11743,7 +10389,7 @@ Extension for the release binary archive Default value: `''` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -11751,7 +10397,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -11759,7 +10405,7 @@ Base URL for the binary archive Default value: `'https://github.com/kumina/unbound_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -11767,7 +10413,7 @@ Extra groups to add the binary user to Default value: `['unbound']` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -11775,7 +10421,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -11783,7 +10429,7 @@ Group under which the binary is running Default value: `'unbound-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -11791,7 +10437,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -11799,7 +10445,7 @@ Installation method: url or package (only url is supported currently) Default value: `'none'` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -11807,7 +10453,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -11815,7 +10461,7 @@ Should puppet manage the service? Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -11823,7 +10469,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -11831,7 +10477,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -11839,7 +10485,7 @@ If package, then use this for package ensure Default value: `'installed'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -11847,7 +10493,7 @@ The binary package name - not available yet Default value: `'unbound_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -11855,7 +10501,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -11863,7 +10509,7 @@ Should puppet restart the service on configuration change? Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -11871,7 +10517,7 @@ Whether to enable the service from puppet Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -11879,7 +10525,7 @@ State ensured for the service Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -11887,7 +10533,7 @@ Name of the unbound exporter service Default value: `'unbound_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -11895,7 +10541,7 @@ User which runs the service Default value: `'unbound-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -11903,7 +10549,7 @@ The binary release version Default value: `'0.3'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -11911,7 +10557,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -11919,7 +10565,7 @@ Data type: `Stdlib::Port` Default value: `9167` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -11927,7 +10573,7 @@ Data type: `String[1]` Default value: `'unbound'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -11935,7 +10581,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -11943,7 +10589,7 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -##### `env_vars` +##### `env_vars` Data type: `Hash` @@ -11951,44 +10597,15 @@ Data type: `Hash` Default value: `{ 'GODEBUG' => 'x509ignoreCN=0' }` -### `prometheus::varnish_exporter` +### `prometheus::varnish_exporter` This module manages prometheus varnish_exporter #### Parameters -The following parameters are available in the `prometheus::varnish_exporter` class: - -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`download_extension`](#download_extension) -* [`download_url`](#download_url) -* [`download_url_base`](#download_url_base) -* [`extra_groups`](#extra_groups) -* [`extra_options`](#extra_options) -* [`group`](#group) -* [`init_style`](#init_style) -* [`install_method`](#install_method) -* [`manage_group`](#manage_group) -* [`manage_service`](#manage_service) -* [`manage_user`](#manage_user) -* [`os`](#os) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`purge_config_dir`](#purge_config_dir) -* [`restart_on_change`](#restart_on_change) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`user`](#user) -* [`version`](#version) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) - -##### `arch` +The following parameters are available in the `prometheus::varnish_exporter` class. + +##### `arch` Data type: `String[1]` @@ -11996,7 +10613,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -12004,13 +10621,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -12018,19 +10635,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -12038,13 +10655,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -12052,7 +10669,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -12060,7 +10677,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -12068,7 +10685,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -12076,7 +10693,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -12084,7 +10701,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -12092,19 +10709,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -12112,7 +10729,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -12120,7 +10737,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -12128,7 +10745,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -12136,25 +10753,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the varnish exporter service (default 'varnish_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -12162,7 +10779,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -12170,7 +10787,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -12178,7 +10795,7 @@ Data type: `Stdlib::Port` Default value: `9131` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -12186,7 +10803,7 @@ Data type: `String[1]` Default value: `'varnish'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -12196,28 +10813,21 @@ Default value: ``undef`` ## Defined types -### `prometheus::alerts` +### `prometheus::alerts` This module manages prometheus alert files for prometheus #### Parameters -The following parameters are available in the `prometheus::alerts` defined type: - -* [`alerts`](#alerts) -* [`location`](#location) -* [`version`](#version) -* [`user`](#user) -* [`group`](#group) -* [`bin_dir`](#bin_dir) +The following parameters are available in the `prometheus::alerts` defined type. -##### `alerts` +##### `alerts` Data type: `Variant[Array,Hash]` Array (< prometheus 2.0.0) or Hash (>= prometheus 2.0.0) of alerts (see README). -##### `location` +##### `location` Data type: `String[1]` @@ -12225,7 +10835,7 @@ Where to create the alert file for prometheus Default value: `"${prometheus::config_dir}/rules"` -##### `version` +##### `version` Data type: `String[1]` @@ -12233,7 +10843,7 @@ Data type: `String[1]` Default value: `$prometheus::version` -##### `user` +##### `user` Data type: `String[1]` @@ -12241,7 +10851,7 @@ Data type: `String[1]` Default value: `$prometheus::user` -##### `group` +##### `group` Data type: `String[1]` @@ -12249,7 +10859,7 @@ Data type: `String[1]` Default value: `$prometheus::group` -##### `bin_dir` +##### `bin_dir` Data type: `String[1]` @@ -12257,73 +10867,39 @@ Data type: `String[1]` Default value: `$prometheus::bin_dir` -### `prometheus::daemon` +### `prometheus::daemon` This define managed prometheus daemons that don't have their own class #### Parameters -The following parameters are available in the `prometheus::daemon` defined type: - -* [`version`](#version) -* [`real_download_url`](#real_download_url) -* [`notify_service`](#notify_service) -* [`user`](#user) -* [`install_method`](#install_method) -* [`download_extension`](#download_extension) -* [`os`](#os) -* [`arch`](#arch) -* [`bin_dir`](#bin_dir) -* [`bin_name`](#bin_name) -* [`package_name`](#package_name) -* [`package_ensure`](#package_ensure) -* [`manage_user`](#manage_user) -* [`extra_groups`](#extra_groups) -* [`manage_group`](#manage_group) -* [`service_ensure`](#service_ensure) -* [`service_enable`](#service_enable) -* [`manage_service`](#manage_service) -* [`extract_command`](#extract_command) -* [`extract_path`](#extract_path) -* [`archive_bin_path`](#archive_bin_path) -* [`init_style`](#init_style) -* [`group`](#group) -* [`purge`](#purge) -* [`options`](#options) -* [`env_vars`](#env_vars) -* [`env_file_path`](#env_file_path) -* [`export_scrape_job`](#export_scrape_job) -* [`scrape_host`](#scrape_host) -* [`scrape_port`](#scrape_port) -* [`scrape_job_name`](#scrape_job_name) -* [`scrape_job_labels`](#scrape_job_labels) -* [`usershell`](#usershell) - -##### `version` +The following parameters are available in the `prometheus::daemon` defined type. + +##### `version` Data type: `String[1]` The binary release version -##### `real_download_url` +##### `real_download_url` Data type: `Prometheus::Uri` Complete URL corresponding to the where the release binary archive can be downloaded -##### `notify_service` +##### `notify_service` Data type: `Any` The service to notify when something changes in this define -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -12331,7 +10907,7 @@ Installation method: url or package Default value: `$prometheus::install_method` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -12339,7 +10915,7 @@ Extension for the release binary archive Default value: `$prometheus::download_extension` -##### `os` +##### `os` Data type: `String[1]` @@ -12347,7 +10923,7 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `arch` +##### `arch` Data type: `String[1]` @@ -12355,7 +10931,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -12363,7 +10939,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `bin_name` +##### `bin_name` Data type: `String[1]` @@ -12371,7 +10947,7 @@ The name of the binary to execute Default value: `$name` -##### `package_name` +##### `package_name` Data type: `Optional[String]` @@ -12379,7 +10955,7 @@ The binary package name Default value: ``undef`` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -12387,7 +10963,7 @@ If package, then use this for package ensure default 'installed' Default value: `'installed'` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -12395,7 +10971,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `extra_groups` +##### `extra_groups` Data type: `Array` @@ -12403,7 +10979,7 @@ Extra groups of which the user should be a part Default value: `[]` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -12411,7 +10987,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -12419,7 +10995,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -12427,7 +11003,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -12435,7 +11011,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `extract_command` +##### `extract_command` Data type: `Optional[String[1]]` @@ -12443,7 +11019,7 @@ Custom command passed to the archive resource to extract the downloaded archive. Default value: `$prometheus::extract_command` -##### `extract_path` +##### `extract_path` Data type: `Stdlib::Absolutepath` @@ -12451,7 +11027,7 @@ Path where to find extracted binary Default value: `'/opt'` -##### `archive_bin_path` +##### `archive_bin_path` Data type: `Stdlib::Absolutepath` @@ -12459,7 +11035,7 @@ Path to the binary in the downloaded archive. Default value: `"/opt/${name}-${version}.${os}-${arch}/${name}"` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -12469,13 +11045,13 @@ Typically this can be used when a package is already providing the file. Default value: `$facts['service_provider']` -##### `group` +##### `group` Data type: `String[1]` -##### `purge` +##### `purge` Data type: `Boolean` @@ -12483,7 +11059,7 @@ Data type: `Boolean` Default value: ``true`` -##### `options` +##### `options` Data type: `String` @@ -12491,7 +11067,7 @@ Data type: `String` Default value: `''` -##### `env_vars` +##### `env_vars` Data type: `Hash[String[1], Scalar]` @@ -12499,7 +11075,7 @@ Data type: `Hash[String[1], Scalar]` Default value: `{}` -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` @@ -12507,7 +11083,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::env_file_path` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -12515,7 +11091,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Stdlib::Host` @@ -12523,7 +11099,7 @@ Data type: `Stdlib::Host` Default value: `$facts['networking']['fqdn']` -##### `scrape_port` +##### `scrape_port` Data type: `Optional[Stdlib::Port]` @@ -12531,7 +11107,7 @@ Data type: `Optional[Stdlib::Port]` Default value: ``undef`` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -12539,7 +11115,7 @@ Data type: `String[1]` Default value: `$name` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Hash` @@ -12547,7 +11123,7 @@ Data type: `Hash` Default value: `{ 'alias' => $scrape_host }` -##### `usershell` +##### `usershell` Data type: `Stdlib::Absolutepath` @@ -12555,7 +11131,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::usershell` -### `prometheus::scrape_job` +### `prometheus::scrape_job` This define is used to export prometheus scrape settings from nodes to be scraped to the node running prometheus itself. @@ -12563,27 +11139,22 @@ This can be used to make prometheus find instances of your running service or ap #### Parameters -The following parameters are available in the `prometheus::scrape_job` defined type: - -* [`job_name`](#job_name) -* [`targets`](#targets) -* [`labels`](#labels) -* [`collect_dir`](#collect_dir) +The following parameters are available in the `prometheus::scrape_job` defined type. -##### `job_name` +##### `job_name` Data type: `String[1]` The name of the scrape job. This will be used when collecting resources on the prometheus node. Corresponds to the prometheus::collect_scrape_jobs parameter. -##### `targets` +##### `targets` Data type: `Array[String[1]]` Array of hosts and ports in the form "host:port" -##### `labels` +##### `labels` Data type: `Hash[String[1], String[1]]` @@ -12591,7 +11162,7 @@ Labels added to the scraped metrics on the prometheus side, as label:values pair Default value: `{}` -##### `collect_dir` +##### `collect_dir` Data type: `Stdlib::Absolutepath` @@ -12602,53 +11173,33 @@ Default value: ``undef`` ## Data types -### `Prometheus::GsUri` +### `Prometheus::GsUri` The Prometheus::GsUri data type. -Alias of +Alias of `Pattern[/^gs:\/\//]` -```puppet -Pattern[/^gs:\/\//] -``` - -### `Prometheus::Initstyle` +### `Prometheus::Initstyle` The Prometheus::Initstyle data type. -Alias of - -```puppet -Enum['sysv', 'systemd', 'sles', 'launchd', 'upstart', 'none'] -``` +Alias of `Enum['sysv', 'systemd', 'sles', 'launchd', 'upstart', 'none']` -### `Prometheus::Install` +### `Prometheus::Install` type to enforce the different installation methods for our exporters. -Alias of +Alias of `Enum['url', 'package', 'none']` -```puppet -Enum['url', 'package', 'none'] -``` - -### `Prometheus::S3Uri` +### `Prometheus::S3Uri` The Prometheus::S3Uri data type. -Alias of - -```puppet -Pattern[/^s3:\/\//] -``` +Alias of `Pattern[/^s3:\/\//]` -### `Prometheus::Uri` +### `Prometheus::Uri` The Prometheus::Uri data type. -Alias of - -```puppet -Variant[Stdlib::Filesource, Stdlib::HTTPUrl, Stdlib::HTTPSUrl, Prometheus::S3Uri, Prometheus::GsUri] -``` +Alias of `Variant[Stdlib::Filesource, Stdlib::HTTPUrl, Stdlib::HTTPSUrl, Prometheus::S3Uri, Prometheus::GsUri]` diff --git a/manifests/server.pp b/manifests/server.pp index 65a5a67b..ac2bd7a2 100644 --- a/manifests/server.pp +++ b/manifests/server.pp @@ -13,7 +13,7 @@ String $package_name = $prometheus::package_name, String $package_ensure = $prometheus::package_ensure, String $config_dir = $prometheus::config_dir, - Stdlib::Absolutepath $localstorage = $prometheus::localstorage, + Variant[Stdlib::Absolutepath, Boolean[false]] $localstorage = $prometheus::localstorage, String $config_template = $prometheus::config_template, String $config_mode = $prometheus::config_mode, Hash $global_config = $prometheus::global_config, @@ -25,7 +25,7 @@ Variant[Array,Hash] $alerts = $prometheus::alerts, Array $alert_relabel_config = $prometheus::alert_relabel_config, Array $alertmanagers_config = $prometheus::alertmanagers_config, - String $storage_retention = $prometheus::storage_retention, + Variant[String, Boolean[false]] $storage_retention = $prometheus::storage_retention, Stdlib::Absolutepath $env_file_path = $prometheus::env_file_path, Hash $extra_alerts = $prometheus::extra_alerts, Boolean $service_enable = $prometheus::service_enable, diff --git a/spec/classes/server_spec.rb b/spec/classes/server_spec.rb index 0f37602b..3b599511 100644 --- a/spec/classes/server_spec.rb +++ b/spec/classes/server_spec.rb @@ -61,6 +61,38 @@ } end end + + describe 'tsdb-disabled' do + context 'by default' do + it { + content = catalogue.resource('systemd::unit_file', 'prometheus.service').send(:parameters)[:content] + expect(content).to include('storage.tsdb.path') + expect(content).to include('storage.tsdb.retention') + } + end + + context 'when retention set to false' do + let(:params) do + super().merge('storage_retention' => false) + end + + it { + content = catalogue.resource('systemd::unit_file', 'prometheus.service').send(:parameters)[:content] + expect(content).not_to include('storage.tsdb.retention') + } + end + + context 'when storage path set to false' do + let(:params) do + super().merge('localstorage' => false) + end + + it { + content = catalogue.resource('systemd::unit_file', 'prometheus.service').send(:parameters)[:content] + expect(content).not_to include('storage.tsdb.path') + } + end + end end end end