Readme

• Readme
  • Synopsis
  • WARNING
  • Features
  • Puppet Documentation
  • Dependencies
  • Deployment
  • SELINUX
  • Known Problems
  • Support
  • Tests
  • Contact Us
  • Feedback
  • Disclaimer

Synopsis

Prometheus is an open-source monitoring system with a dimensional data model, flexible query language, efficient time series database and modern alerting approach.

confdroid_prometheus is a Puppet module to automate installation and configuration of prometheus, optionally node exporter, tsdb pruning and more. This module supports either managing prometheus or node_exporter or both. You need to set the parameters $manage_prometheusand / or $manage_node_exporterto true ( false by default)

WARNING

Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production

Features

INSTALLATION

• installs prometheus binaries (optional)
• installs node_exporter binaries (optional)

CONFIGURATION

• manage directories
• manage files including templates
• manage service

Configurable options:

• --storage.tsdb.retention.time via $ps_retention_time
• --storage.tsdb.retention.size via $ps_retention_size
• --storage.tsdb.wal-segment-size via ps_wal_seg_size
• --storage.tsdb.min-block-duration via ps_min_block_dur
• --storage.tsdb.max-block-duration via ps_max_block_dur
• authentication user via $ps_auth_user
• authentication password via $ps_auth_pass
• web authentication password via $ps_web_pass ( different format required)
• external remote write ( writing to a remote instance like pg-adapter):
  • ps_write_external true enables it
  • ps_external_url must be a valid full url
  • ps_auth_ext_usermust be a valid user
  • ps_auth_ext_passmust be a valid password
• pruning local blocks
  • ps_enable_pruning true enables it
  • ps_pruning_dir the directory where the pruning script should live

Puppet Documentation

See the full Puppet documentation including parameters in docs/index.html

Dependencies

All dependencies must be included in the catalogue.

Deployment

• native Puppet deployment

via site.pp or nodes.pp

node 'example.example.net' {
  include cd_prometheus
}

• through Foreman:

In order to apply parameters through Foreman, the params.pp must be added to the host or host group in question.

See more details about class deployment on Confdroid.com.

SELINUX

All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.

Known Problems

Support

• OS: Rocky 9
• Puppet 8

Tests

• Puppet Lint
• Puppet Parser
• ERB Template Parser
• Sonar Quality Gate

Contact Us

contact Us

Feedback

Having suggestions or feature requests? head over to our feedback collection and add an item for public votes or discussion.

Disclaimer

ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments. The modules are tested and supported only as documented, and require testing in designated environments (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments. v