bareos exporter

This will install the Bareos Prometheus Exporter.

Inspired by Puppet Postgresql Exporter

Table of Contents

• bareos exporter
  • Table of Contents
  • Description
  • Setup
    • Setup Requirements
    • Beginning with exporter
  • Usage
  • Reference
  • Limitations

Description

Briefly tell users why they might want to use your module. Explain what your module does and what kind of problems users can solve with it.

This should be a fairly short description helps the user decide if your module is what they want.

Setup

Setup Requirements

The module depends on the following puppet modules:

• Puppetlabs/stdlib
• Puppet/archive - For downloading and extracting the bareos exporter release tarball
• Puppet/systemd - For creating the systemd config

Beginning with exporter

The most basic example is:

include bareos_exporter

The module will assume that it will run as user postgres (which needs to already exist) and will connect to the database bareos on local host. You can tweak the database connection settings with the dsn and dbtype param as well as you can specify the user the daemon shoould run and if the user/group should get create.

Usage

A more complete example:

class { '::bareos_exporter':
  manage_user           => true,
  manage_group          => true,
  bareos_exporter_user  => 'bareos',
  bareos_exporter_group => 'bareos',
  datasource            => 'user=bareos host=/var/run/postgresql/ sslmode=disable',
  dbtype                => 'pgx',
}

Reference

see REFERENCE.md

Limitations

Tested with Debian 10 and 11, but should be fine on any Linux that uses Systemd.

Reference

Table of Contents

Classes

Public Classes

• bareos_exporter: Main class, includes all other classes

Private Classes

• bareos_exporter::install: This class handles the download and installation of bareos exporter. Avoid modifying private classes.
• bareos_exporter::params: Parameter Class from bareos exporter
• bareos_exporter::service: This class handles the creation of systemd service and its autostart Avoid modifying private classes.

Classes

bareos_exporter

bareos_exporter

Examples

include bareos_exporter

Parameters

The following parameters are available in the bareos_exporter class:

• version
• manage_user
• manage_group
• bareos_exporter_user
• bareos_exporter_group
• datasource
• dbtype
• port
• archive_url

version

Data type: Optional[String]

Which version to install

Default value: $bareos_exporter::params::version

manage_user

Data type: Optional[Boolean]

Whether to create the bareos_exporter user. Must be created by other means if set to false

Default value: $bareos_exporter::params::manage_user

manage_group

Data type: Optional[Boolean]

Whether to create the bareos_exporter group. Must be created by other means if set to false

Default value: $bareos_exporter::params::manage_group

bareos_exporter_user

Data type: Optional[String]

whether to create the user. Default is postgres

Default value: $bareos_exporter::params::bareos_exporter_user

bareos_exporter_group

Data type: Optional[String]

whether to create the group. Default is postgres

Default value: $bareos_exporter::params::bareos_exporter_group

datasource

Data type: Optional[String]

the url connection to postgres. Default is local "user=postgres host=/var/run/postgresql/ sslmode=disable"

Default value: $bareos_exporter::params::bareos_exporter_datasource

dbtype

Data type: Optional[String]

the type of database connection to use # FIXME provide example

Default value: $bareos_exporter::params::bareos_exporter_dbtype

port

Data type: Optional[String]

the port on which the service is expose

Default value: $bareos_exporter::params::bareos_exporter_port

archive_url

Data type: Optional[String]

Default value: $bareos_exporter::params::archive_url

1.1.1 (2023-05-04)

Bug Fixes

• ci: use Github PAT instead of GITHUB_TOKEN (91626aa)

1.1.0 (2023-05-04)

Features

• ci: automatically bump version in metadata.json (a6d0df0)
• ci: run publish puppet module on release creation (36a21fb)

Bug Fixes

• ci: debug bump-metadata-version.sh (d237078)
• ci: fix usage between GNU sed and BSD sed (1abab02)

1.0.0 (2023-05-04)

Features

• adding semantic release (4b9eaab)
• automatically publish module on puppet forge (fda44bf)
• expose archive url variable in public class (3ae8891)

Bug Fixes

• ci: fix installation of conventional-changelog-conventionalcommits (db55608)
• ci: missing conventional-changelog-conventionalcommits plugin (3d036c1)
• type: fix typo (319afdc)
• wrong usage of variables in systemd template (5a0c93a)

Changelog

All notable changes to this project will be documented in this file.

Release 0.1.0

Features

• Initial Release

Bugfixes

Known Issues

• Bareos Exporter is not able to use environment variables so you need to have dsn params in a world readable file for systemd for now
• Probably some :)