REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• tempo: Class to install and configure tempo. Use this module to install and configure tempo.

Private Classes

• tempo::config: A short summary of the purpose of this class
• tempo::install: A short summary of the purpose of this class
• tempo::service: A short summary of the purpose of this class

Classes

tempo

Class to install and configure tempo.

Use this module to install and configure tempo.

Examples

Declaring the class

include ::tempo

Parameters

The following parameters are available in the tempo class:

• bin_dir
• config_dir
• data_dir
• group
• install_method
• manage_service
• manage_user
• package_name
• package_version
• service_name
• service_provider
• service_ensure
• user
• version
• compactor_config_hash
• distributor_config_hash
• ingester_config_hash
• memberlist_config_hash
• multitenancy_enabled
• multitenancy_key
• server_config_hash
• storage_config_hash
• query_frontend_config_hash
• querier_config_hash
• manage_unit_file

bin_dir

Data type: Stdlib::Absolutepath

Location of tempo binary release.

config_dir

Data type: Stdlib::Absolutepath

Location of tempo config files.

data_dir

Data type: Stdlib::Absolutepath

Location of tempo data directories.

group

Data type: String[1]

Group that owns tempo files.

install_method

Data type: Enum['archive','package']

How to install tempo.

manage_service

Data type: Boolean

Manage the tempo service.

manage_user

Data type: Boolean

Manage tempo user and group.

Default value: $install_method

package_name

Data type: String[1]

Name of package to install.

package_version

Data type: String[1]

Version of tempo to install.

service_name

Data type: String[1]

Name of service to manage.

service_provider

Data type: String[1]

Init system that is used.

service_ensure

Data type: Enum['running','stopped']

The state of the service.

user

Data type: String[1]

User that owns tempo files.

version

Data type: String[1]

Version of tempo to install.

compactor_config_hash

Data type: Optional[Hash]

Compactor config hash.

Default value: undef

distributor_config_hash

Data type: Optional[Hash]

Distributor config hash.

Default value: undef

ingester_config_hash

Data type: Optional[Hash]

Ingestor config hash.

Default value: undef

memberlist_config_hash

Data type: Optional[Hash]

Memberlist config hash.

Default value: undef

multitenancy_enabled

Data type: Boolean

Enable multi tenancy

multitenancy_key

Data type: String[1]

Key name

server_config_hash

Data type: Optional[Hash]

Server config hash.

Default value: undef

storage_config_hash

Data type: Optional[Hash]

Storage config hash.

Default value: undef

query_frontend_config_hash

Data type: Optional[Hash]

Query Frontend config hash.

Default value: undef

querier_config_hash

Data type: Optional[Hash]

Querier config hash.

Default value: undef

manage_unit_file

Data type: Boolean

Default value: $install_method