Version information
released May 21st 2020
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >=3.0.0 <5.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'bodgit-grafana', '1.0.2'Learn more about managing modules with a PuppetfileDocumentation
bodgit/grafana — version 1.0.2 May 21st 2020
grafana
Tested with Travis CI
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with grafana
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
This module manages the Grafana UI for Graphite.
Module Description
This module installs the Grafana package, managing the package repository if required, configures it and optionally enables and configures LDAP authentication. It can also install publicly available plugins.
Setup
If running on Puppet 3.x you will need to have the future parser enabled.
What graphite affects
- The package providing the Grafana software.
- The
/etc/grafana/grafana.iniconfiguration file. - The
/etc/grafana/ldap.tomlLDAP configuration file. - Plugins installed under
/var/lib/grafana. - The service controlling Grafana.
Beginning with grafana
class { '::grafana':
admin_password => 'admin',
secret_key => 'abc123',
}
Usage
Classes and Defined Types
Class: grafana
Parameters within grafana:
admin_password
Maps to the security/admin_password setting.
secret_key
Maps to the security/secret_key setting.
admin_user
Maps to the security/admin_user setting.
allow_sign_up
Maps to the users/allow_sign_up setting.
allow_org_create
Maps to the users/allow_org_create setting.
check_for_updates
Maps to the analytics/check_for_updates setting.
conf_dir
The root configuration directory, defaults to /etc/grafana.
conf_file
The main configuration file, defaults to ${conf_dir}/grafana.ini.
data_dir
The root data directory, defaults to /var/lib/grafana.
grafana_home
The root directory of the web application, defaults to /usr/share/grafana.
group
The group to run as, defaults to grafana.
log_dir
The log directory, defaults to /var/log/grafana.
manage_repo
Whether to manage the external repository for package installation.
max_open_files
Maximum number of open files, defaults to 10,000.
package_name
The name of the package to install, defaults to grafana.
plugins_dir
The plugins directory, defaults to ${data_dir}/plugins.
restart_on_upgrade
Controls whether package upgrades trigger an automatic restart.
service_name
The name of the service, defaults to grafana-server.
url
Maps to the grafana_net/url setting.
user
The user to run as, defaults to grafana.
Class: grafana::ldap
Parameters within grafana::ldap:
bind_dn
The distinguished name used to bind to LDAP with.
hosts
An array of hostnames or IP addresses of LDAP servers to use.
search_base_dns
An array of LDAP search bases to try for locating the user.
search_filter
An LDAP search filter to apply to user searches.
attributes
A hash of LDAP attribute mappings. Required keys are name, surname,
username, member_of, and email. Values for each are the appropriate
LDAP attribute name.
bind_password
The password to use when binding to LDAP.
conf_file
The LDAP configuration file, defaults to ${::grafana::conf_dir}/ldap.toml.
group_mappings
An array of mappings, each mapping being a hash containing the required keys
group_dn and org_role which contain the plain or distinguished name of
the group, (or * as a catch-all), and one of Admin, Editor or Viewer
respectively. An optional org_id key can be passed to map to the desired
Grafana organisation ID.
group_search_base_dns
An array of LDAP search bases to try for group lookups.
group_search_filter
An LDAP search filter to apply to group searches.
group_search_filter_user_attribute
Used with recursive group membership lookups.
port
Port to use for LDAP connections, defaults to 389.
root_ca_cert
Path to root CA certificate for verifying SSL/TLS LDAP connections.
ssl_skip_verify
Boolean for SSL/TLS verification.
start_tls
Whether to use STARTTLS.
use_ssl
Whether to use SSL/TLS, usually with port 636.
verbose_logging
Enable verbose LDAP logging.
Defined Type: grafana::plugin
Parameters within grafana::plugin:
name
The name of the plugin to install.
ensure
One of present, absent or latest.
Native Types
Native Type: grafana_ini_setting
grafana_ini_setting { 'auth.ldap/config_file':
ensure => present,
value => '/etc/grafana/ldap.toml',
}
grafana_ini_setting { 'auth.ldap/enabled':
ensure => absent,
}
Parameters within grafana_ini_setting:
name
The name of the setting, of the form <section>/<setting>.
ensure
One of present or absent.
value
The value of the setting.
Native Type: package
package { 'grafana-piechart-panel':
ensure => present,
provider => grafana,
}
Parameters within package:
See the standard Puppet package type.
Examples
Install Grafana:
class { '::grafana':
admin_password => 'admin',
secret_key => 'abc123',
}
Extend the above to also install a piechart plugin:
class { '::grafana':
admin_password => 'admin',
secret_key => 'abc123',
}
::grafana::plugin { 'grafana-piechart-panel':
ensure => present,
}
Extend the above to also configure LDAP authentication:
include ::openldap
include ::openldap::client
class { '::openldap::server':
root_dn => 'cn=Manager,dc=example,dc=com',
root_password => 'secret',
suffix => 'dc=example,dc=com',
access => [
'to attrs=userPassword by self =xw by anonymous auth',
'to * by dn.base="gidNumber=0+uidNumber=0,cn=peercred,cn=external,cn=auth" manage by users read',
],
ldap_interfaces => ['127.0.0.1'],
local_ssf => 256,
}
::openldap::server::schema { 'cosine':
position => 1,
}
::openldap::server::schema { 'inetorgperson':
position => 2,
}
::openldap::server::schema { 'nis':
position => 3,
}
class { '::grafana':
admin_password => 'admin',
secret_key => 'abc123',
}
::grafana::plugin { 'grafana-piechart-panel':
ensure => present,
}
class { '::grafana::ldap':
bind_dn => 'cn=Manager,dc=example,dc=com',
bind_password => 'secret',
group_search_base_dns => ['ou=groups,dc=example,dc=com'],
group_search_filter => '(&(objectClass=posixGroup)(memberUid=%s))',
hosts => ['127.0.0.1'],
search_base_dns => ['ou=people,dc=example,dc=com'],
search_filter => '(uid=%s)',
attributes => {
'name' => 'givenName',
'surname' => 'sn',
'username' => 'uid',
'member_of' => 'cn',
'email' => 'mail',
},
group_mappings => [
{
'group_dn' => 'alice',
'org_role' => 'Admin',
},
],
require => Class['::openldap::server'],
}
Reference
Classes
Public Classes
grafana: Main class for managing Grafana.grafana::ldap: Main class for managing LDAP support in Grafana.
Private Classes
grafana::install: Handles Grafana installation.grafana::config: Handles Grafana configuration.grafana::params: Different configuration data for different systems.grafana::service: Handles running the Grafana service.grafana::ldap::config: Handles Grafana LDAP configuration.
Defined Types
Public Defined Types
grafana::plugin: Handles plugin installation.
Native Types
grafana_ini_setting: Manages configuration settings in/etc/grafana/grafana.ini.package: Package provider for managing Grafana plugins.
Limitations
This module has been built on and tested against Puppet 3.0 and higher.
The module has been tested on:
- RedHat/CentOS Enterprise Linux 6/7
Testing on other platforms has been light and cannot be guaranteed.
Development
Please log issues or pull requests at github.
Dependencies
- puppetlabs/stdlib (>=4.6.0 <5.0.0)
- puppetlabs/inifile (>=1.6.0 <3.0.0)
- bodgit/bodgitlib (>=1.0.0 <3.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2013 Puppet Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.