Puppet Class: grafana

Inherits:
::grafana::params
Defined in:
manifests/init.pp

Overview

Installs and manages Grafana.

Examples:

Declaring the class

class { '::grafana':
  admin_password => 'password',
  secret_key     => 'abc123',
}

Parameters:

  • admin_password (String[1])

    The password for the default admin account.

  • secret_key (String[1])

    The key used for hashing sensitive information.

  • admin_user (String) (defaults to: $::grafana::params::admin_user)

    The name of the admin user, usually admin.

  • allow_sign_up (Optional[Boolean]) (defaults to: undef)

    Control if new users are allowed to sign up.

  • allow_org_create (Optional[Boolean]) (defaults to: undef)

    Control if new organisations can be created.

  • check_for_updates (Optional[Boolean]) (defaults to: $::grafana::params::check_for_updates)

    Whether to check for updates.

  • conf_dir (Stdlib::Absolutepath) (defaults to: $::grafana::params::conf_dir)

    The configuration directory, usually /etc/grafana.

  • conf_file (Stdlib::Absolutepath) (defaults to: $::grafana::params::conf_file)

    The main configuration file, usually ${conf_dir}/grafana.ini.

  • data_dir (Stdlib::Absolutepath) (defaults to: $::grafana::params::data_dir)

    Directory used for dashboards, session storage, plugins, etc.

  • database (Optional[Grafana::Database]) (defaults to: undef)
  • grafana_home (Stdlib::Absolutepath) (defaults to: $::grafana::params::grafana_home)

    Path to the top level of the web application.

  • group (String) (defaults to: $::grafana::params::group)

    Unprivileged group.

  • log_dir (Stdlib::Absolutepath) (defaults to: $::grafana::params::log_dir)

    Directory used for logging.

  • manage_repo (Boolean) (defaults to: $::grafana::params::manage_repo)

    Whether to manage the default package repository.

  • max_idle_conn (Optional[Integer[0]]) (defaults to: undef)
  • max_open_conn (Optional[Integer[0]]) (defaults to: undef)
  • max_open_files (Integer[0]) (defaults to: $::grafana::params::max_open_files)

    Maximum number of open files allowed.

  • package_name (String) (defaults to: $::grafana::params::package_name)

    The name of the package.

  • plugins_dir (Stdlib::Absolutepath) (defaults to: $::grafana::params::plugins_dir)

    Directory where plugins are installed to.

  • restart_on_upgrade (Boolean) (defaults to: $::grafana::params::restart_on_upgrade)

    Whether to restart on package upgrade.

  • service_name (String) (defaults to: $::grafana::params::service_name)

    The service name.

  • url (Optional[String]) (defaults to: $::grafana::params::url)
  • user (String) (defaults to: $::grafana::params::user)

    Unprivileged user.

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'manifests/init.pp', line 36

class grafana (
  String[1]                   $admin_password,
  String[1]                   $secret_key,
  String                      $admin_user         = $::grafana::params::admin_user,
  Optional[Boolean]           $allow_sign_up      = undef,
  Optional[Boolean]           $allow_org_create   = undef,
  Optional[Boolean]           $check_for_updates  = $::grafana::params::check_for_updates,
  Stdlib::Absolutepath        $conf_dir           = $::grafana::params::conf_dir,
  Stdlib::Absolutepath        $conf_file          = $::grafana::params::conf_file,
  Stdlib::Absolutepath        $data_dir           = $::grafana::params::data_dir,
  Optional[Grafana::Database] $database           = undef,
  Stdlib::Absolutepath        $grafana_home       = $::grafana::params::grafana_home,
  String                      $group              = $::grafana::params::group,
  Stdlib::Absolutepath        $log_dir            = $::grafana::params::log_dir,
  Boolean                     $manage_repo        = $::grafana::params::manage_repo,
  Optional[Integer[0]]        $max_idle_conn      = undef,
  Optional[Integer[0]]        $max_open_conn      = undef,
  Integer[0]                  $max_open_files     = $::grafana::params::max_open_files,
  String                      $package_name       = $::grafana::params::package_name,
  Stdlib::Absolutepath        $plugins_dir        = $::grafana::params::plugins_dir,
  Boolean                     $restart_on_upgrade = $::grafana::params::restart_on_upgrade,
  String                      $service_name       = $::grafana::params::service_name,
  Optional[String]            $url                = $::grafana::params::url,
  String                      $user               = $::grafana::params::user,
) inherits ::grafana::params {

  contain ::grafana::install
  contain ::grafana::config
  contain ::grafana::service

  Class['::grafana::install'] ~> Class['::grafana::config']
    ~> Class['::grafana::service']
}