Forge Home

grafana

Configuration and management of Grafana

8,417 downloads

5,553 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 1.0.0 (latest)
  • 0.2.1
  • 0.1.1
  • 0.1.0
released Sep 18th 2018
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2016.4.x
  • Puppet >= 4.10.10 < 6.0.0

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'arcaik-grafana', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add arcaik-grafana
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install arcaik-grafana --version 1.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

arcaik/grafana — version 1.0.0 Sep 18th 2018

Grafana

Build Status

Overview

From the Grafana website: Grafana is the leading tool for querying and visualizing time series and metrics.

Table of Contents

  1. Module description
  2. Usage
  3. Reference
  1. Limitations
  2. Development

Module description

This module installs, configures and manages Grafana.

Warning: since version 1.0.0, this module is only compatible with Hiera 5.

Usage

Beginning with grafana

Reference

Public classes

Class grafana

Parameters
package_name

Optional. String. Sets the name of the grafana package (default: grafana).

package_ensure

Optional. String. Controls the package resource ensure attribute (default: present).

See Resource Type: package for a list of allowed values.

service_name

Optional. String. Sets the name of the Grafana service (default: grafana-server).

service_ensure

Optional. String. Controls the service resource ensure attribute (default: present).

See Resource Type: package for a list of allowed values.

service_enable

Optional. Boolean. Controls the service resource enable attribute (default: true).

config_dir

Optional. Stdlib::Absolutepath. Sets the directory where Grafana's configuration files are located (default: /etc/grafana).

config_file

Deprecated: This setting is deprecated, it will be removed in a future version of this module.

Optional. Stdlib::Absolutepath. Sets the Grafana configuration file location (default: /etc/grafana/grafana.ini).

settings

Optional. Hash.

Private classes

  • grafana::params
  • grafana::install: handles the packages installation.
  • grafana::config: handles the configuration file management.
  • grafana::service: handles the service management.

Limitations

This module only works with systemd. It has only been tested on Debian 8 (Jessie).

Development

Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. Please follow our guidelines when contributing changes.

For more information, see our module contribution guide.