Puppet Class: prometheus::openldap_exporter

Inherits:
prometheus
Defined in:
manifests/openldap_exporter.pp

Summary

This module manages prometheus openldap_exporter

Overview

Parameters:

  • bin_dir (Stdlib::Absolutepath) (defaults to: $prometheus::bin_dir)

    Directory where binaries are located

  • download_extension (String) (defaults to: '')

    Extension for the release binary archive

  • download_url (Optional[Prometheus::Uri]) (defaults to: undef)

    Complete URL corresponding to the where the release binary archive can be downloaded

  • download_url_base (Prometheus::Uri) (defaults to: 'https://github.com/tomcz/openldap_exporter/releases')

    Base URL for the binary archive

  • extra_groups (Array[String]) (defaults to: [])

    Extra groups to add the binary user to

  • options (String) (defaults to: '')

    Additionnal arguments to command line of openldap_exporter, use to specify the URL of the LDAP to scrap if not ldap://localhost:389 Do not use for user/password authentication

  • group (String[1]) (defaults to: 'openldap-exporter')

    Group under which the binary is running

  • init_style (Prometheus::Initstyle) (defaults to: $prometheus::init_style)

    Service startup scripts style (e.g. rc, upstart or systemd)

  • install_method (Prometheus::Install) (defaults to: $prometheus::install_method)

    Installation method: url or package (only url is supported currently)

  • manage_group (Boolean) (defaults to: true)

    Whether to create a group for or rely on external code for that

  • manage_service (Boolean) (defaults to: true)

    Should puppet manage the service? (default true)

  • manage_user (Boolean) (defaults to: true)

    Whether to create user or rely on external code for that

  • os (String[1]) (defaults to: downcase($facts['kernel']))

    Operating system (linux is the only one supported)

  • package_ensure (String[1]) (defaults to: 'latest')

    If package, then use this for package ensure default ‘latest’

  • package_name (String[1]) (defaults to: 'openldap_exporter')

    The binary package name - not available yet

  • restart_on_change (Boolean) (defaults to: true)

    Should puppet restart the service on configuration change? (default true)

  • service_enable (Boolean) (defaults to: true)

    Whether to enable the service from puppet (default true)

  • service_ensure (Stdlib::Ensure::Service) (defaults to: 'running')

    State ensured for the service (default ‘running’)

  • service_name (String[1]) (defaults to: 'openldap_exporter')

    Name of the node exporter service (default ‘openldap_exporter’)

  • user (String[1]) (defaults to: 'openldap-exporter')

    User which runs the service

  • version (String[1]) (defaults to: '2.1')

    The binary release version

  • ldap_binddn (Optional[String[1]]) (defaults to: undef)

    DN (LDAP User) used to authenticate to openldap cn=monitor tree

  • ldap_password (Optional[String[1]]) (defaults to: undef)

    Password used to authenticate to openldap cn=monitor tree

  • proxy_server (Optional[String[1]]) (defaults to: undef)

    Optional proxy server, with port number if needed. ie: example.com:8080

  • proxy_type (Optional[Enum['none', 'http', 'https', 'ftp']]) (defaults to: undef)

    Optional proxy server type (none|http|https|ftp)

  • export_scrape_job (Boolean) (defaults to: false)
  • scrape_host (Optional[Stdlib::Host]) (defaults to: undef)
  • scrape_port (Stdlib::Port) (defaults to: 9330)
  • scrape_job_name (String[1]) (defaults to: 'openldap')
  • scrape_job_labels (Optional[Hash]) (defaults to: undef)


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'manifests/openldap_exporter.pp', line 53

class prometheus::openldap_exporter (
  String $download_extension                                 = '', # lint:ignore:params_empty_string_assignment
  Array[String] $extra_groups                                = [],
  String[1] $group                                           = 'openldap-exporter',
  String[1] $package_ensure                                  = 'latest',
  String[1] $user                                            = 'openldap-exporter',
  String[1] $version                                         = '2.1',
  Prometheus::Uri $download_url_base                         = 'https://github.com/tomcz/openldap_exporter/releases',
  String[1] $package_name                                    = 'openldap_exporter',
  String[1] $service_name                                    = 'openldap_exporter',
  Boolean $restart_on_change                                 = true,
  Boolean $service_enable                                    = true,
  Stdlib::Ensure::Service $service_ensure                    = 'running',
  Prometheus::Initstyle $init_style                          = $prometheus::init_style,
  Prometheus::Install $install_method                        = $prometheus::install_method,
  Boolean $manage_group                                      = true,
  Boolean $manage_service                                    = true,
  Boolean $manage_user                                       = true,
  String[1] $os                                              = downcase($facts['kernel']),
  String $options                                            = '', # lint:ignore:params_empty_string_assignment
  Optional[Prometheus::Uri] $download_url                    = undef,
  Stdlib::Absolutepath $bin_dir                              = $prometheus::bin_dir,
  Boolean $export_scrape_job                                 = false,
  Optional[Stdlib::Host] $scrape_host                        = undef,
  Stdlib::Port $scrape_port                                  = 9330,
  String[1] $scrape_job_name                                 = 'openldap',
  Optional[Hash] $scrape_job_labels                          = undef,
  Optional[String[1]] $ldap_binddn                           = undef,
  Optional[String[1]] $ldap_password                         = undef,
  Optional[String[1]] $proxy_server                          = undef,
  Optional[Enum['none', 'http', 'https', 'ftp']] $proxy_type = undef,
) inherits prometheus {
  $release = "v${version}"
  if versioncmp($version, '2.2.1') >= 0 {
    $real_download_extension = 'gz'
    $real_download_url = pick($download_url,"${download_url_base}/download/${release}/${package_name}-${os}-${prometheus::real_arch}.gz")
    $extract_path = "/opt/openldap_exporter-${version}.${os}-${prometheus::real_arch}"
    $archive_bin_path = "${extract_path}/openldap_exporter-${os}-${prometheus::real_arch}"
    $extract_command = "gzip -cd %s > ${archive_bin_path}"
    file { $extract_path:
      ensure => 'directory',
      owner  => 'root',
      group  => 0, # 0 instead of root because OS X uses "wheel".
      mode   => '0755',
      before => Prometheus::Daemon[$service_name],
    }
  } else {
    $real_download_extension = $download_extension
    $real_download_url = pick($download_url,"${download_url_base}/download/${release}/${package_name}-${os}")
    $extract_path = undef
    $extract_command = undef
    $archive_bin_path = undef
  }
  $notify_service = $restart_on_change ? {
    true    => Service[$service_name],
    default => undef,
  }
  if $ldap_binddn != undef and $ldap_password != undef {
    $env_vars = {
      'LDAP_USER' => $ldap_binddn,
      'LDAP_PASS' => $ldap_password,
    }
  } else {
    $env_vars = {}
  }

  prometheus::daemon { $service_name:
    install_method     => $install_method,
    version            => $version,
    download_extension => $real_download_extension,
    os                 => $os,
    real_download_url  => $real_download_url,
    extract_path       => $extract_path,
    extract_command    => $extract_command,
    archive_bin_path   => $archive_bin_path,
    bin_dir            => $bin_dir,
    notify_service     => $notify_service,
    package_name       => $package_name,
    package_ensure     => $package_ensure,
    manage_user        => $manage_user,
    user               => $user,
    extra_groups       => $extra_groups,
    group              => $group,
    manage_group       => $manage_group,
    options            => $options,
    init_style         => $init_style,
    service_ensure     => $service_ensure,
    service_enable     => $service_enable,
    manage_service     => $manage_service,
    env_vars           => $env_vars,
    export_scrape_job  => $export_scrape_job,
    scrape_host        => $scrape_host,
    scrape_port        => $scrape_port,
    scrape_job_name    => $scrape_job_name,
    scrape_job_labels  => $scrape_job_labels,
    proxy_server       => $proxy_server,
    proxy_type         => $proxy_type,
  }
}