REFERENCE.md

Reference

Table of Contents

Classes

• mimir: == Class: mimir Install, configure, manage Mimir metrics platform. For a deep dive in mimir configuration see https://grafana.com/docs/mimir
• mimir::config: == Class: mimir::config Configure Mimir metrics platform. For a deep dive in mimir configuration see https://grafana.com/docs/mimir/latest/
• mimir::install: == Class: mimir::install Install Mimir metrics platform.
• mimir::service: == Class: mimir::service Manage service associated to Mimir metrics platform.

Classes

mimir

== Class: mimir

Install, configure, manage Mimir metrics platform. For a deep dive in mimir configuration see https://grafana.com/docs/mimir/latest/

Parameters

The following parameters are available in the mimir class:

• package_ensure
• manage_user
• user_home
• user_shell
• user_extra_groups
• config_dir
• config_group
• config_hash
• config_owner
• custom_args
• log_dir_path
• log_dir_mode
• log_file_path
• log_file_mode
• log_group
• log_level
• log_owner
• log_to_file
• validate_cmd
• restart_cmd
• restart_on_change
• restart_on_upgrade
• systemd_overrides

package_ensure

Data type: String

Mimir version under the form X.X.X

Default value: 'present'

manage_user

Data type: Boolean

Boolean to specify if module should manage mimir user

Default value: false

user_home

Data type: String

Home directory for the managed user

Default value: '/var/lib/mimir'

user_shell

Data type: String

Binary to use as shell for managed user

Default value: '/sbin/nologin'

user_extra_groups

Data type: Array

Additionnal groups the managed user should be connected to

Default value: []

config_dir

Data type: String

Directory to store the mimir configuration

Default value: '/etc/mimir'

config_group

Data type: String

Group to use for configuration resources

Default value: 'mimir'

config_hash

Data type: Hash

Hash containing the configuration keys to override

Default value: {}

config_owner

Data type: String

Owner to use for configuration resources

Default value: 'mimir'

custom_args

Data type: Array

Additional arguments to set to the mimir process

Default value: []

log_dir_path

Data type: String

Directory to store mimir logs if log to file is enabled

Default value: '/var/log/mimir'

log_dir_mode

Data type: String

Mode of the directory used to store logs

Default value: '0700'

log_file_path

Data type: String

Filename to store mimir logs if log to file is enabled

Default value: 'mimir.log'

log_file_mode

Data type: String

Mode of the file used to store logs

Default value: '0600'

log_group

Data type: String

Group to use for log resources

Default value: 'root'

log_level

Data type: String

Log level to use for process mimir

Default value: 'info'

log_owner

Data type: String

Owner to use for log resources

Default value: 'root'

log_to_file

Data type: Boolean

Should log be kept in journald or sent to a dedicated file

Default value: false

validate_cmd

Data type: String

Command use to validate configuration

Default value: '/usr/local/bin/mimir --modules=true -config.file %'

restart_cmd

Data type: String

Command use to restart process

Default value: '/bin/systemctl restart mimir'

restart_on_change

Data type: Boolean

Should the process be restarted on configuration changes

Default value: true

restart_on_upgrade

Data type: Boolean

Should the process be restarted on package upgrade

Default value: true

systemd_overrides

Data type: Hash

List of systemd parameters to override

Default value:

{
        'Service' => {
            # Mimir needs to open quite a lot of socket, this value seems widely used for high traffic softwares.
            'LimitNOFILE' => '1048576',
        },
    }

mimir::config

== Class: mimir::config

Configure Mimir metrics platform. For a deep dive in mimir configuration see https://grafana.com/docs/mimir/latest/

mimir::install

== Class: mimir::install

Install Mimir metrics platform.

mimir::service

== Class: mimir::service

Manage service associated to Mimir metrics platform.