diff --git a/CHANGELOG.md b/CHANGELOG.md index 5dbef2f..5f959cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,507 +1,530 @@ # Changelog All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module. +## [v9.0.0](https://github.com/voxpupuli/puppet-grafana/tree/v9.0.0) (2021-08-17) + +[Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v8.0.0...v9.0.0) + +**Breaking changes:** + +- Support only 6.x/7.x/8.x versions [\#246](https://github.com/voxpupuli/puppet-grafana/pull/246) ([root-expert](https://github.com/root-expert)) +- bump default grafana version for FreeBSD [\#240](https://github.com/voxpupuli/puppet-grafana/pull/240) ([olevole](https://github.com/olevole)) + +**Implemented enhancements:** + +- puppetlabs/stdlib: Allow 7.x [\#244](https://github.com/voxpupuli/puppet-grafana/pull/244) ([bastelfreak](https://github.com/bastelfreak)) +- puppet/archive: allow 5.x [\#243](https://github.com/voxpupuli/puppet-grafana/pull/243) ([bastelfreak](https://github.com/bastelfreak)) +- Allow grafana\_team home dashboard to be scoped to a folder [\#241](https://github.com/voxpupuli/puppet-grafana/pull/241) ([treydock](https://github.com/treydock)) + +**Closed issues:** + +- config class does not restart service [\#239](https://github.com/voxpupuli/puppet-grafana/issues/239) +- grafana\_team resource gives Could not evaluate: Invalid parameter [\#237](https://github.com/voxpupuli/puppet-grafana/issues/237) + +**Merged pull requests:** + +- Update README.md about tested OSes [\#250](https://github.com/voxpupuli/puppet-grafana/pull/250) ([bastelfreak](https://github.com/bastelfreak)) +- Use Iterable.find to find a folder [\#249](https://github.com/voxpupuli/puppet-grafana/pull/249) ([ekohl](https://github.com/ekohl)) +- Add Ubuntu 20.04 support [\#248](https://github.com/voxpupuli/puppet-grafana/pull/248) ([root-expert](https://github.com/root-expert)) +- Update badges in README.md [\#245](https://github.com/voxpupuli/puppet-grafana/pull/245) ([bastelfreak](https://github.com/bastelfreak)) + ## [v8.0.0](https://github.com/voxpupuli/puppet-grafana/tree/v8.0.0) (2021-02-20) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v7.0.0...v8.0.0) **Breaking changes:** - Drop EoL Debian 8 support [\#233](https://github.com/voxpupuli/puppet-grafana/pull/233) ([bastelfreak](https://github.com/bastelfreak)) - Drop Eol CentOS 6 support [\#232](https://github.com/voxpupuli/puppet-grafana/pull/232) ([bastelfreak](https://github.com/bastelfreak)) - Mask/redact password and secure\_json\_data in grafana\_datasource; require at least puppet 6.1.0 [\#221](https://github.com/voxpupuli/puppet-grafana/pull/221) ([nmaludy](https://github.com/nmaludy)) **Implemented enhancements:** - Enable Puppet 7 support [\#234](https://github.com/voxpupuli/puppet-grafana/pull/234) ([bastelfreak](https://github.com/bastelfreak)) - Allow multiple puppetsource [\#224](https://github.com/voxpupuli/puppet-grafana/pull/224) ([jsfrerot](https://github.com/jsfrerot)) **Fixed bugs:** - Fix `puppet generate types` [\#227](https://github.com/voxpupuli/puppet-grafana/pull/227) ([smortex](https://github.com/smortex)) - Ensure all API types have grafana\_conn\_validator autorequires [\#226](https://github.com/voxpupuli/puppet-grafana/pull/226) ([treydock](https://github.com/treydock)) - Don't manage dashboard path when puppetsource is not set [\#225](https://github.com/voxpupuli/puppet-grafana/pull/225) ([treydock](https://github.com/treydock)) **Closed issues:** - Feature Request: Support for Grafana Plugin install by URL [\#173](https://github.com/voxpupuli/puppet-grafana/issues/173) - add/change sourceselect option for provisioning\_dashboards [\#130](https://github.com/voxpupuli/puppet-grafana/issues/130) **Merged pull requests:** - Fix types to work with 'puppet generate types' [\#236](https://github.com/voxpupuli/puppet-grafana/pull/236) ([treydock](https://github.com/treydock)) - Rebase plugin from zip patch [\#235](https://github.com/voxpupuli/puppet-grafana/pull/235) ([XMol](https://github.com/XMol)) - Bugfix for teams, update README and acceptance testing [\#215](https://github.com/voxpupuli/puppet-grafana/pull/215) ([DavidReubenWhite](https://github.com/DavidReubenWhite)) ## [v7.0.0](https://github.com/voxpupuli/puppet-grafana/tree/v7.0.0) (2020-08-24) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v6.2.0...v7.0.0) ## [v6.2.0](https://github.com/voxpupuli/puppet-grafana/tree/v6.2.0) (2020-08-23) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v6.1.0...v6.2.0) **Breaking changes:** - drop Ubuntu 14.04 support [\#192](https://github.com/voxpupuli/puppet-grafana/pull/192) ([bastelfreak](https://github.com/bastelfreak)) **Implemented enhancements:** - add SLES support [\#220](https://github.com/voxpupuli/puppet-grafana/pull/220) ([tuxmea](https://github.com/tuxmea)) - Support for teams, dashboard permissions and memberships [\#210](https://github.com/voxpupuli/puppet-grafana/pull/210) ([DavidReubenWhite](https://github.com/DavidReubenWhite)) - Add mechanism to make API changes once API is available [\#208](https://github.com/voxpupuli/puppet-grafana/pull/208) ([treydock](https://github.com/treydock)) - Update list of supported operating systems [\#204](https://github.com/voxpupuli/puppet-grafana/pull/204) ([dhoppe](https://github.com/dhoppe)) - allow connecting to multiple LDAP services [\#199](https://github.com/voxpupuli/puppet-grafana/pull/199) ([unki](https://github.com/unki)) **Fixed bugs:** - Code in maifests/service.pp refers to code from manifests/params.pp [\#206](https://github.com/voxpupuli/puppet-grafana/issues/206) - Grafana 5.0.3 Users passwords being set and datasources created on every puppet run [\#104](https://github.com/voxpupuli/puppet-grafana/issues/104) - Clean up code, because params.pp has been removed [\#214](https://github.com/voxpupuli/puppet-grafana/pull/214) ([dhoppe](https://github.com/dhoppe)) **Closed issues:** - Grafana folder example doc update [\#197](https://github.com/voxpupuli/puppet-grafana/issues/197) **Merged pull requests:** - Fix `grafana_user` `password` idempotency [\#211](https://github.com/voxpupuli/puppet-grafana/pull/211) ([alexjfisher](https://github.com/alexjfisher)) - Support managing folder permissions [\#207](https://github.com/voxpupuli/puppet-grafana/pull/207) ([treydock](https://github.com/treydock)) - \#197 Minor Doc correction - grafana\_folder [\#198](https://github.com/voxpupuli/puppet-grafana/pull/198) ([RandellP](https://github.com/RandellP)) - Do not restart grafana on provisioned dashboard updates [\#196](https://github.com/voxpupuli/puppet-grafana/pull/196) ([treydock](https://github.com/treydock)) - Remove duplicate CONTRIBUTING.md file [\#193](https://github.com/voxpupuli/puppet-grafana/pull/193) ([dhoppe](https://github.com/dhoppe)) ## [v6.1.0](https://github.com/voxpupuli/puppet-grafana/tree/v6.1.0) (2019-10-30) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v6.0.0...v6.1.0) **Implemented enhancements:** - Feature request: add basicAuth for grafana\_datasource [\#43](https://github.com/voxpupuli/puppet-grafana/issues/43) - Add FreeBSD 12 support [\#179](https://github.com/voxpupuli/puppet-grafana/pull/179) ([olevole](https://github.com/olevole)) - Update grafana\_dashboard resource for folders [\#172](https://github.com/voxpupuli/puppet-grafana/pull/172) ([alexconrey](https://github.com/alexconrey)) - Implement grafana\_folder resource type [\#170](https://github.com/voxpupuli/puppet-grafana/pull/170) ([alexconrey](https://github.com/alexconrey)) - Mark passwords as sensitive [\#165](https://github.com/voxpupuli/puppet-grafana/pull/165) ([alexjfisher](https://github.com/alexjfisher)) **Fixed bugs:** - Fix version, because 6.0.0-beta1 does not exist anymore [\#163](https://github.com/voxpupuli/puppet-grafana/pull/163) ([dhoppe](https://github.com/dhoppe)) - Fix value of variables base\_url and real\_archive\_source [\#161](https://github.com/voxpupuli/puppet-grafana/pull/161) ([dhoppe](https://github.com/dhoppe)) - Fix value of variable real\_package\_source [\#160](https://github.com/voxpupuli/puppet-grafana/pull/160) ([dhoppe](https://github.com/dhoppe)) **Closed issues:** - How to create Notification channels [\#188](https://github.com/voxpupuli/puppet-grafana/issues/188) - Cannot install puppet/grafana, most recent puppet/archive version is v4.2 [\#184](https://github.com/voxpupuli/puppet-grafana/issues/184) - \[UBUNTU 14.04\] Package not found [\#85](https://github.com/voxpupuli/puppet-grafana/issues/85) - Puppet module exposes passwords - current and previous in plane text during puppet runs [\#82](https://github.com/voxpupuli/puppet-grafana/issues/82) - using docker install with container\_cfg attempts to use incorrect permissions [\#52](https://github.com/voxpupuli/puppet-grafana/issues/52) - Hide sensitive data values [\#45](https://github.com/voxpupuli/puppet-grafana/issues/45) - Feature request: support auth.proxy config option [\#40](https://github.com/voxpupuli/puppet-grafana/issues/40) **Merged pull requests:** - Clean up acceptance spec helper [\#189](https://github.com/voxpupuli/puppet-grafana/pull/189) ([ekohl](https://github.com/ekohl)) - DOC Add Provisioning with dashboards from grafana.com [\#185](https://github.com/voxpupuli/puppet-grafana/pull/185) ([mfaure](https://github.com/mfaure)) - Allow puppet/archive 4.x and puppetlabs/stdlib 6.x [\#176](https://github.com/voxpupuli/puppet-grafana/pull/176) ([alexjfisher](https://github.com/alexjfisher)) - Corrected invalid database config example [\#169](https://github.com/voxpupuli/puppet-grafana/pull/169) ([Rovanion](https://github.com/Rovanion)) - Use data in modules instead of params.pp [\#167](https://github.com/voxpupuli/puppet-grafana/pull/167) ([dhoppe](https://github.com/dhoppe)) - Remove Puppet 3 specific syntax [\#166](https://github.com/voxpupuli/puppet-grafana/pull/166) ([dhoppe](https://github.com/dhoppe)) ## [v6.0.0](https://github.com/voxpupuli/puppet-grafana/tree/v6.0.0) (2019-02-14) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v5.0.0...v6.0.0) **Breaking changes:** - modulesync 2.5.1 and drop Puppet 4 [\#154](https://github.com/voxpupuli/puppet-grafana/pull/154) ([bastelfreak](https://github.com/bastelfreak)) **Implemented enhancements:** - Add a task for setting the admin user's password [\#148](https://github.com/voxpupuli/puppet-grafana/pull/148) ([genebean](https://github.com/genebean)) - Integration notification channels [\#144](https://github.com/voxpupuli/puppet-grafana/pull/144) ([jnguiot](https://github.com/jnguiot)) **Fixed bugs:** - Update repo\_name Enum for new 'beta' repo [\#155](https://github.com/voxpupuli/puppet-grafana/pull/155) ([JayH5](https://github.com/JayH5)) - Fix \#152 : multi arch send out a notice [\#153](https://github.com/voxpupuli/puppet-grafana/pull/153) ([elfranne](https://github.com/elfranne)) - fixes repo url and key [\#150](https://github.com/voxpupuli/puppet-grafana/pull/150) ([crazymind1337](https://github.com/crazymind1337)) **Closed issues:** - multi arch send out a notice [\#152](https://github.com/voxpupuli/puppet-grafana/issues/152) - Package Repo moved to packages.grafana.com [\#149](https://github.com/voxpupuli/puppet-grafana/issues/149) - install\_mode archive fails if $data\_dir is not manually created [\#142](https://github.com/voxpupuli/puppet-grafana/issues/142) **Merged pull requests:** - include classes without leading :: [\#157](https://github.com/voxpupuli/puppet-grafana/pull/157) ([bastelfreak](https://github.com/bastelfreak)) - replace deprecated has\_key\(\) with `in` [\#147](https://github.com/voxpupuli/puppet-grafana/pull/147) ([bastelfreak](https://github.com/bastelfreak)) - archive install\_method creates data\_dir [\#143](https://github.com/voxpupuli/puppet-grafana/pull/143) ([othalla](https://github.com/othalla)) - Fix folder typos [\#140](https://github.com/voxpupuli/puppet-grafana/pull/140) ([pfree](https://github.com/pfree)) ## [v5.0.0](https://github.com/voxpupuli/puppet-grafana/tree/v5.0.0) (2018-10-06) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.5.0...v5.0.0) **Breaking changes:** - Change default of version parameter to 'installed' [\#126](https://github.com/voxpupuli/puppet-grafana/pull/126) ([baurmatt](https://github.com/baurmatt)) **Implemented enhancements:** - removing value restriction on grafana\_datasource so any custom plugin can be used [\#136](https://github.com/voxpupuli/puppet-grafana/pull/136) ([lukebigum](https://github.com/lukebigum)) - add --repo option to grafana\_cli plugin install [\#132](https://github.com/voxpupuli/puppet-grafana/pull/132) ([rwuest](https://github.com/rwuest)) - Parametrize provisioning file names [\#128](https://github.com/voxpupuli/puppet-grafana/pull/128) ([kazeborja](https://github.com/kazeborja)) **Closed issues:** - Version parameter should default to 'installed' [\#125](https://github.com/voxpupuli/puppet-grafana/issues/125) **Merged pull requests:** - modulesync 2.1.0 and allow puppet 6.x [\#137](https://github.com/voxpupuli/puppet-grafana/pull/137) ([bastelfreak](https://github.com/bastelfreak)) - allow puppetlabs/stdlib 5.x and puppetlabs/apt 6.x [\#134](https://github.com/voxpupuli/puppet-grafana/pull/134) ([bastelfreak](https://github.com/bastelfreak)) ## [v4.5.0](https://github.com/voxpupuli/puppet-grafana/tree/v4.5.0) (2018-07-16) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.4.1...v4.5.0) **Implemented enhancements:** - Use provisioning backend for dashboards, providers [\#103](https://github.com/voxpupuli/puppet-grafana/issues/103) - Feature: Add grafana provisioning to this module. [\#120](https://github.com/voxpupuli/puppet-grafana/pull/120) ([drshawnkwang](https://github.com/drshawnkwang)) **Closed issues:** - Any plan to update module to use the grafana provisioning by yaml files ? [\#122](https://github.com/voxpupuli/puppet-grafana/issues/122) ## [v4.4.1](https://github.com/voxpupuli/puppet-grafana/tree/v4.4.1) (2018-07-04) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.4.0...v4.4.1) **Fixed bugs:** - Fix dependency in provisioning plugins [\#118](https://github.com/voxpupuli/puppet-grafana/pull/118) ([drshawnkwang](https://github.com/drshawnkwang)) **Closed issues:** - grafana plugin install/check breaks catalog run when grafana-server service is not running [\#79](https://github.com/voxpupuli/puppet-grafana/issues/79) ## [v4.4.0](https://github.com/voxpupuli/puppet-grafana/tree/v4.4.0) (2018-06-21) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.3.0...v4.4.0) **Implemented enhancements:** - Manage sysconfig files [\#115](https://github.com/voxpupuli/puppet-grafana/pull/115) ([ZeroPointEnergy](https://github.com/ZeroPointEnergy)) **Merged pull requests:** - bump archive upper version boundary to \<4.0.0 [\#116](https://github.com/voxpupuli/puppet-grafana/pull/116) ([bastelfreak](https://github.com/bastelfreak)) ## [v4.3.0](https://github.com/voxpupuli/puppet-grafana/tree/v4.3.0) (2018-06-18) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.2.0...v4.3.0) **Implemented enhancements:** - Add postgres support and secure\_json\_data support [\#105](https://github.com/voxpupuli/puppet-grafana/pull/105) ([Faffnir](https://github.com/Faffnir)) **Fixed bugs:** - Update release codename from jessie to stretch. [\#113](https://github.com/voxpupuli/puppet-grafana/pull/113) ([drshawnkwang](https://github.com/drshawnkwang)) **Closed issues:** - puppet-grafana Debian repository should use codename stretch [\#112](https://github.com/voxpupuli/puppet-grafana/issues/112) **Merged pull requests:** - drop EOL OSs; fix puppet version range [\#109](https://github.com/voxpupuli/puppet-grafana/pull/109) ([bastelfreak](https://github.com/bastelfreak)) - Rely on beaker-hostgenerator for docker nodesets [\#108](https://github.com/voxpupuli/puppet-grafana/pull/108) ([ekohl](https://github.com/ekohl)) - switch from topscope facts to $facts hash [\#102](https://github.com/voxpupuli/puppet-grafana/pull/102) ([bastelfreak](https://github.com/bastelfreak)) - Update README.md [\#99](https://github.com/voxpupuli/puppet-grafana/pull/99) ([cclloyd](https://github.com/cclloyd)) ## [v4.2.0](https://github.com/voxpupuli/puppet-grafana/tree/v4.2.0) (2018-03-06) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.1.1...v4.2.0) **Implemented enhancements:** - Create organization [\#71](https://github.com/voxpupuli/puppet-grafana/issues/71) - Expand organization property for dashboards [\#94](https://github.com/voxpupuli/puppet-grafana/pull/94) ([brandonrdn](https://github.com/brandonrdn)) - Add grafana\_api\_path to allow for API sub-paths [\#93](https://github.com/voxpupuli/puppet-grafana/pull/93) ([brandonrdn](https://github.com/brandonrdn)) ## [v4.1.1](https://github.com/voxpupuli/puppet-grafana/tree/v4.1.1) (2018-02-21) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.1.0...v4.1.1) **Fixed bugs:** - grafana\_datasource provider with\_credentials\(\) returns is\_default value [\#89](https://github.com/voxpupuli/puppet-grafana/issues/89) - fix datasource provider error [\#90](https://github.com/voxpupuli/puppet-grafana/pull/90) ([brandonrdn](https://github.com/brandonrdn)) ## [v4.1.0](https://github.com/voxpupuli/puppet-grafana/tree/v4.1.0) (2018-02-03) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.0.3...v4.1.0) **Implemented enhancements:** - \(SIMP-4206\) Added organization provider and updated datasource provider [\#86](https://github.com/voxpupuli/puppet-grafana/pull/86) ([heliocentric](https://github.com/heliocentric)) **Closed issues:** - "Could not autoload" error in grafana\_dashboard with ruby 2.4 on Centos 6 [\#83](https://github.com/voxpupuli/puppet-grafana/issues/83) ## [v4.0.3](https://github.com/voxpupuli/puppet-grafana/tree/v4.0.3) (2017-12-09) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.0.2...v4.0.3) **Closed issues:** - Apt key add gets called every run [\#77](https://github.com/voxpupuli/puppet-grafana/issues/77) - Getting rid or changing the url check for grafana datasource url's [\#75](https://github.com/voxpupuli/puppet-grafana/issues/75) **Merged pull requests:** - Update readme with examples of using datasource and dashboard [\#80](https://github.com/voxpupuli/puppet-grafana/pull/80) ([devcfgc](https://github.com/devcfgc)) - Removing the datasource url check as it leads to errors with postgres… [\#76](https://github.com/voxpupuli/puppet-grafana/pull/76) ([Faffnir](https://github.com/Faffnir)) ## [v4.0.2](https://github.com/voxpupuli/puppet-grafana/tree/v4.0.2) (2017-10-12) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.0.1...v4.0.2) **Implemented enhancements:** - bump archive upper boundary to work with latest versions [\#73](https://github.com/voxpupuli/puppet-grafana/pull/73) ([bastelfreak](https://github.com/bastelfreak)) - add debian 8 and 9 support [\#72](https://github.com/voxpupuli/puppet-grafana/pull/72) ([bastelfreak](https://github.com/bastelfreak)) **Merged pull requests:** - fix typo in metadata \(redhat 6 twice vs 6/7\) [\#69](https://github.com/voxpupuli/puppet-grafana/pull/69) ([wyardley](https://github.com/wyardley)) ## [v4.0.1](https://github.com/voxpupuli/puppet-grafana/tree/v4.0.1) (2017-09-22) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v4.0.0...v4.0.1) **Fixed bugs:** - Module doesn't work on Ubuntu Xenial [\#56](https://github.com/voxpupuli/puppet-grafana/issues/56) ## [v4.0.0](https://github.com/voxpupuli/puppet-grafana/tree/v4.0.0) (2017-09-20) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v3.0.0...v4.0.0) **Breaking changes:** - BREAKING: Switch to Puppet Data Types \(ldap\_cfg is now undef when disabled\) [\#66](https://github.com/voxpupuli/puppet-grafana/pull/66) ([wyardley](https://github.com/wyardley)) - BREAKING: Create grafana\_plugin resource type and change grafana::plugins [\#63](https://github.com/voxpupuli/puppet-grafana/pull/63) ([wyardley](https://github.com/wyardley)) - BREAKING: Update default Grafana version to 4.5.1 and improve acceptance tests [\#61](https://github.com/voxpupuli/puppet-grafana/pull/61) ([wyardley](https://github.com/wyardley)) **Implemented enhancements:** - grafana\_user custom resource [\#60](https://github.com/voxpupuli/puppet-grafana/pull/60) ([atward](https://github.com/atward)) - Support newer versions of puppetlabs/apt module [\#53](https://github.com/voxpupuli/puppet-grafana/pull/53) ([ghoneycutt](https://github.com/ghoneycutt)) - Support custom plugins [\#44](https://github.com/voxpupuli/puppet-grafana/pull/44) ([bastelfreak](https://github.com/bastelfreak)) **Fixed bugs:** - gpg key error on CentOS 7 with default params [\#59](https://github.com/voxpupuli/puppet-grafana/issues/59) - wget called even if not necessary [\#54](https://github.com/voxpupuli/puppet-grafana/issues/54) - Fix typo in provider [\#58](https://github.com/voxpupuli/puppet-grafana/pull/58) ([atward](https://github.com/atward)) **Closed issues:** - install\_method 'docker" ignores all other configurations [\#51](https://github.com/voxpupuli/puppet-grafana/issues/51) - Usable for Grafana 4.x? [\#37](https://github.com/voxpupuli/puppet-grafana/issues/37) - Remove docker dependency [\#22](https://github.com/voxpupuli/puppet-grafana/issues/22) **Merged pull requests:** - Update README.md [\#67](https://github.com/voxpupuli/puppet-grafana/pull/67) ([wyardley](https://github.com/wyardley)) - Get rid of the dependency on 'wget' module in favor of puppet-archive [\#65](https://github.com/voxpupuli/puppet-grafana/pull/65) ([wyardley](https://github.com/wyardley)) - Remove licenses from the top of files [\#64](https://github.com/voxpupuli/puppet-grafana/pull/64) ([wyardley](https://github.com/wyardley)) - Release 4.0.0 [\#62](https://github.com/voxpupuli/puppet-grafana/pull/62) ([bastelfreak](https://github.com/bastelfreak)) - Always use jessie apt repo when osfamily is Debian. [\#41](https://github.com/voxpupuli/puppet-grafana/pull/41) ([furhouse](https://github.com/furhouse)) ## [v3.0.0](https://github.com/voxpupuli/puppet-grafana/tree/v3.0.0) (2017-03-29) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v2.6.3...v3.0.0) **Implemented enhancements:** - implement package\_ensure param for archlinux [\#34](https://github.com/voxpupuli/puppet-grafana/pull/34) ([bastelfreak](https://github.com/bastelfreak)) **Fixed bugs:** - FIX configuration file ownership [\#30](https://github.com/voxpupuli/puppet-grafana/pull/30) ([c10l](https://github.com/c10l)) **Closed issues:** - Configured grafana debian repo should contain current distribution [\#27](https://github.com/voxpupuli/puppet-grafana/issues/27) - Error while creating dashboard [\#25](https://github.com/voxpupuli/puppet-grafana/issues/25) **Merged pull requests:** - Bump version, Update changelog [\#38](https://github.com/voxpupuli/puppet-grafana/pull/38) ([dhoppe](https://github.com/dhoppe)) - Debian and RedHat based operating systems should use the repository by default [\#36](https://github.com/voxpupuli/puppet-grafana/pull/36) ([dhoppe](https://github.com/dhoppe)) - Add support for archlinux [\#32](https://github.com/voxpupuli/puppet-grafana/pull/32) ([bastelfreak](https://github.com/bastelfreak)) - Fix grafana\_dashboards [\#31](https://github.com/voxpupuli/puppet-grafana/pull/31) ([c10l](https://github.com/c10l)) - supoort jessie for install method repo [\#28](https://github.com/voxpupuli/puppet-grafana/pull/28) ([roock](https://github.com/roock)) - Use operatinsystemmajrelease fact in repo url [\#24](https://github.com/voxpupuli/puppet-grafana/pull/24) ([mirekys](https://github.com/mirekys)) - The puppet 4-only release will start at 3.0.0 [\#21](https://github.com/voxpupuli/puppet-grafana/pull/21) ([rnelson0](https://github.com/rnelson0)) ## [v2.6.3](https://github.com/voxpupuli/puppet-grafana/tree/v2.6.3) (2017-01-18) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v2.6.2...v2.6.3) ## [v2.6.2](https://github.com/voxpupuli/puppet-grafana/tree/v2.6.2) (2017-01-18) [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v2.6.1...v2.6.2) -**Merged pull requests:** - -- release 2.6.2 \(optimistic, i know ;\) [\#20](https://github.com/voxpupuli/puppet-grafana/pull/20) ([igalic](https://github.com/igalic)) - ## v2.6.1 (2017-01-18) Just a notice: The next release will be a major one without Puppet 3 support! This is the last Release that supports it! ## Releasing v2.6.0 (2017-01-18) **Enhancements** * add two types & provider: `grafana_datasource` & `grafana_dashboard` these type allow configuration of the datasource and the dashboard against the API * allow configuration of `repo_name` for all installation methods * be more conservative when installing from docker, while also allowing users to override our `stable` choice **Fixes** * ensure correct ownership of downloaded artefact * fix use-before definition of `$version`: https://github.com/bfraser/puppet-grafana/issues/87 **Behind The Scenes** * switch to voxpupuli/archive from camptocamp **Changes since forking from bfraser/puppet-grafana** * Add CONTRIBUTING.MD as well as our issues, spec etc… templates * update README and other files to point to forked repository * Rubocop and ruby-lint style-fixes! * test with puppet > 4.x ## 2.5.0 (2015-10-31) **Enhancements** - Support for [Grafana 2.5](http://grafana.org/blog/2015/10/28/Grafana-2-5-Released.html). This is just a version bump to reflect that Grafana 2.5 is now installed by default - [PR #58](https://github.com/bfraser/puppet-grafana/pull/58) Sort ```cfg``` keys so ```config.ini``` content is not updated every Puppet run **Fixes** - [Issue #52](https://github.com/bfraser/puppet-grafana/issues/52) Version logic moved to ```init.pp``` so overriding the version of Grafana to install works as intended **Behind The Scenes** - [PR #59](https://github.com/bfraser/puppet-grafana/pull/59) More specific version requirements in ```metadata.json``` due to use of ```contain``` function - [PR #61](https://github.com/bfraser/puppet-grafana/pull/61) Fixed typos in ```metadata.json``` ## 2.1.0 (2015-08-07) **Enhancements** - Support for [Grafana 2.1](http://grafana.org/blog/2015/08/04/Grafana-2-1-Released.html) - [Issue #40](https://github.com/bfraser/puppet-grafana/issues/40) Support for [LDAP integration](http://docs.grafana.org/v2.1/installation/ldap/) - [PR #34](https://github.com/bfraser/puppet-grafana/pull/34) Support for 'repo' install method to install packages from [packagecloud](https://packagecloud.io/grafana) repositories - Addition of boolean parameter ```manage_package_repo``` to control whether the module will manage the package repository when using the 'repo' install method. See README.md for details - [PR #39](https://github.com/bfraser/puppet-grafana/pull/39) Ability to ensure a specific package version is installed when using the 'repo' install method **Fixes** - [Issue #37](https://github.com/bfraser/puppet-grafana/issues/37) Archive install method: check if user and service are already defined before attempting to define them - [Issue #42](https://github.com/bfraser/puppet-grafana/issues/42) Package versioning for RPM / yum systems - [Issue #45](https://github.com/bfraser/puppet-grafana/issues/45) Fix resource dependency issues when ```manage_package_repo``` is false **Behind The Scenes** - Use 40 character GPG key ID for packagecloud apt repository ## 2.0.2 (2015-04-30) **Enhancements** - Support for Grafana 2.0. Users of Grafana 1.x should stick to version 1.x of the Puppet module - Support 'archive', 'docker' and 'package' install methods - Ability to supply a hash of parameters to the Docker container when using 'docker' install method - [PR #24](https://github.com/bfraser/puppet-grafana/pull/24) Ability to configure Grafana using configuration hash parameter ```cfg``` **Behind The Scenes** - Update module operatingsystem support, tags, Puppet requirements - Tests for 'archive' and 'package' install methods ## 1.0.1 (2015-02-27) **Enhancements** - New parameter for Grafana admin password **Fixes** - Package install method now makes use of install_dir for config.js path **Behind The Scenes** - Add archive module to .fixtures.yml - Unquote booleans to make lint happy - Fix license identifier and unbounded dependencies in module metadata - Allow Travis to fail on Ruby 1.8.7 - More Puppet versions are tested by Travis ## 1.0.0 (2014-12-16) **Enhancements** - Add max_search_results parameter - Install Grafana 1.9.0 by default **Documentation** - Add download_url and install_method parameters to README **Behind The Scenes** - [Issue #6](https://github.com/bfraser/puppet-grafana/issues/6) Replace gini/archive dependency with camptocamp/archive - Addition of CHANGELOG - Style fixes - Removal of vagrant-wrapper gem - Fancy badges for build status ## 0.2.2 (2014-10-27) **Enhancements** - Add default_route parameter to manage start dashboard **Fixes** - Symlink behavior **Behind The Scenes** - [Issue #9](https://github.com/bfraser/puppet-grafana/issues/9) Remove stdlib inclusion from manifest ## 0.2.1 (2014-10-14) **Enhancements** - Support for multiple datasources - Install Grafana 1.8.1 by default **Behind The Scenes** - Added RSpec tests - Add stdlib as a module dependency - Add operating system compatibility ## 0.1.3 (2014-07-03) **Enhancements** - Added support for InfluxDB ## 0.1.2 (2014-06-30) First release on the Puppet Forge \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* diff --git a/README.md b/README.md index 3ca8203..0676914 100644 --- a/README.md +++ b/README.md @@ -1,1209 +1,1208 @@ # grafana [![Build Status](https://github.com/voxpupuli/puppet-grafana/workflows/CI/badge.svg)](https://github.com/voxpupuli/puppet-grafana/actions?query=workflow%3ACI) [![Release](https://github.com/voxpupuli/puppet-grafana/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-grafana/actions/workflows/release.yml) [![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/grafana.svg)](https://forge.puppetlabs.com/puppet/grafana) [![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/grafana.svg)](https://forge.puppetlabs.com/puppet/grafana) [![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/grafana.svg)](https://forge.puppetlabs.com/puppet/grafana) [![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/grafana.svg)](https://forge.puppetlabs.com/puppet/grafana) [![puppetmodule.info docs](http://www.puppetmodule.info/images/badge.png)](http://www.puppetmodule.info/m/puppet-grafana) [![Apache-2 License](https://img.shields.io/github/license/voxpupuli/puppet-grafana.svg)](LICENSE) #### Table of Contents 1. [Overview](#overview) 1. [Module Description](#module-description) 1. [Setup](#setup) * [Requirements](#requirements) * [Beginning with Grafana](#beginning-with-grafana) 1. [Usage](#usage) * [Classes and Defined Types](#classes-and-defined-types) * [Advanced usage](#advanced-usage) 1. [Tasks](#tasks) 1. [Limitations](#limitations) 1. [Copyright and License](#copyright-and-license) ## Overview This module installs Grafana, a dashboard and graph editor for Graphite, InfluxDB and OpenTSDB. ## Module Description -Version 2.x of this module is designed to work with version 2.x of Grafana. -If you would like to continue to use Grafana 1.x, please use version 1.x of -this module. +With the 9.0.0 release of this module we only support Grafana 6.x/7.x/8.x. +Version 8 of the module was tested successfully on Grafana 6 and 7. ## Setup This module will: * Install Grafana using your preferred method: package (default), Docker container, or tar archive * Allow you to override the version of Grafana to be installed, and / or the package source * Perform basic configuration of Grafana ### Requirements * If using an operating system of the Debian-based family, and the "repo" `install_method`, you will need to ensure that [puppetlabs-apt](https://forge.puppet.com/puppetlabs/apt) version 4.x is installed. * If using Docker, you will need the [garethr/docker](https://forge.puppet.com/garethr/docker) module version 5.x ### Beginning with Grafana To install Grafana with the default parameters: ```puppet class { 'grafana': } ``` This assumes that you want to install Grafana using the 'package' method. To establish customized parameters: ```puppet class { 'grafana': install_method => 'docker', } ``` ## Usage ### Classes and Defined Types #### Class: `grafana` The Grafana module's primary class, `grafana`, guides the basic setup of Grafana on your system. ```puppet class { 'grafana': } ``` **Parameters within `grafana`:** ##### `archive_source` The download location of a tarball to use with the 'archive' install method. Defaults to the URL of the latest version of Grafana available at the time of module release. ##### `cfg_location` Configures the location to which the Grafana configuration is written. The default location is '/etc/grafana/grafana.ini'. ##### `cfg` Manages the Grafana configuration file. Grafana comes with its own default settings in a different configuration file (/opt/grafana/current/conf/defaults.ini), therefore this module does not supply any defaults. This parameter only accepts a hash as its value. Keys with hashes as values will generate sections, any other values are just plain values. The example below will result in... ```puppet class { 'grafana': cfg => { app_mode => 'production', server => { http_port => 8080, }, database => { type => 'mysql', host => '127.0.0.1:3306', name => 'grafana', user => 'root', password => '', }, users => { allow_sign_up => false, }, }, } ``` ...the following Grafana configuration: ```ini # This file is managed by Puppet, any changes will be overwritten app_mode = production [server] http_port = 8080 [database] type = sqlite3 host = 127.0.0.1:3306 name = grafana user = root password = [users] allow_sign_up = false ``` Some minor notes: * If you want empty values, just use an empty string. * Keys that contains dots (like auth.google) need to be quoted. * The order of the keys in this hash is the same as they will be written to the configuration file. So settings that do not fall under a section will have to come before any sections in the hash. #### `ldap_cfg` ##### TOML note This option **requires** the [toml](https://github.com/toml-lang/toml) gem. Either install the gem using puppet's native gem provider, [puppetserver_gem](https://forge.puppetlabs.com/puppetlabs/puppetserver_gem), [pe_gem](https://forge.puppetlabs.com/puppetlabs/pe_gem), [pe_puppetserver_gem](https://forge.puppetlabs.com/puppetlabs/pe_puppetserver_gem), or manually using one of the following: ``` # apply or puppet-master gem install toml # PE apply /opt/puppet/bin/gem install toml # AIO or PE puppetserver /opt/puppet/bin/puppetserver gem install toml ``` ##### cfg note This option by itself is not sufficient to enable LDAP configuration as it must be enabled in the main configuration file. Enable it in cfg with: ``` 'auth.ldap' => { enabled => 'true', config_file => '/etc/grafana/ldap.toml', }, ``` #### Integer note Puppet may convert integers into strings while parsing the hash and converting into toml. This can be worked around by appending 0 to an integer. Example: ``` port => 636+0, ``` Manages the Grafana LDAP configuration file. This hash is directly translated into the corresponding TOML file, allowing for full flexibility in generating the configuration. See the [LDAP documentation](http://docs.grafana.org/v2.1/installation/ldap/) for more information. #### Example LDAP config ``` ldap_cfg => { servers => [ { host => 'ldapserver1.domain1.com', port => 636+0, use_ssl => true, search_filter => '(sAMAccountName=%s)', search_base_dns => [ 'dc=domain1,dc=com' ], bind_dn => 'user@domain1.com', bind_password => 'passwordhere', }, ], 'servers.attributes' => { name => 'givenName', surname => 'sn', username => 'sAMAccountName', member_of => 'memberOf', email => 'email', } }, ``` If you want to connect to multiple LDAP servers using different configurations, use an array to enwrap the configurations as shown below. ``` ldap_cfg => [ { servers => [ { host => 'ldapserver1.domain1.com', port => 636+0, use_ssl => true, search_filter => '(sAMAccountName=%s)', search_base_dns => [ 'dc=domain1,dc=com' ], bind_dn => 'user@domain1.com', bind_password => 'passwordhere', }, ], 'servers.attributes' => { name => 'givenName', surname => 'sn', username => 'sAMAccountName', member_of => 'memberOf', email => 'email', }, 'servers.group_mappings' => [ { group_dn => cn=grafana_viewers,ou=groups,dc=domain1,dc=com org_role: Viewer } ], }, { servers => [ { host => 'ldapserver2.domain2.com', port => 389+0, use_ssl => false, start_tls => true, search_filter => '(uid=%s)', search_base_dns => [ 'dc=domain2,dc=com' ], bind_dn => 'user@domain2.com', bind_password => 'passwordhere', }, ], 'servers.attributes' => { name => 'givenName', surname => 'sn', username => 'uid', member_of => 'memberOf', email => 'mail', } 'servers.group_mappings' => [ { 'group_dn' => 'cn=grafana_admins,ou=groups,dc=domain2,dc=com', 'org_role' => 'Admin', 'grafana_admin' => true, } ], }, ] ##### # or in hiera-yaml style grafana::ldap_cfg: - servers: - host: ldapserver1.domain1.com port: 636 use_ssl: true search_filter: '(sAMAccountName=%s)' search_base_dns: ['dc=domain1,dc=com'] bind_dn: 'user@domain1.com' bind_password: 'passwordhere' servers.attributes: name: givenName surname: sn username: sAMAccountName member_of: memberOf email: email servers.group_mappings: - group_dn: cn=grafana_viewers,ou=groups,dc=domain1,dc=com org_role: Viewer - servers: - host: ldapserver2.domain2.com port: 389 use_ssl: false start_tls: true search_filter: '(uid=%s)', search_base_dns: ['dc=domain2,dc=com'] bind_dn: 'user@domain2.com' bind_password: 'passwordhere' servers.attributes: name: givenName surname: sn username: uid member_of: memberOf email: mail servers.group_mappings: - group_dn: cn=grafana_admins,ou=groups,dc=domain2,dc=com org_role: Admin grafana_admin: true ##### ``` ##### `container_cfg` Boolean to control whether a configuration file should be generated when using the 'docker' install method. If 'true', use the 'cfg' and 'cfg_location' parameters to control creation of the file. Defaults to false. ##### `container_params` A hash of parameters to use when creating the Docker container. For use with the 'docker' install method. Refer to documentation of the 'docker::run' resource in the [garethr-docker](https://github.com/garethr/garethr-docker) module for details of available parameters. Defaults to: ```puppet container_params => { 'image' => 'grafana/grafana:latest', 'ports' => '3000:3000' } ``` ##### `data_dir` The directory Grafana will use for storing its data. Defaults to '/var/lib/grafana'. ##### `install_dir` The installation directory to be used with the 'archive' install method. Defaults to '/usr/share/grafana'. ##### `install_method` Controls which method to use for installing Grafana. Valid options are: 'archive', 'docker', 'repo' and 'package'. The default is 'package'. If you wish to use the 'docker' installation method, you will need to include the 'docker' class in your node's manifest / profile. If you wish to use the 'repo' installation method, you can control whether the official Grafana repositories will be used. See `manage_package_repo` below for details. ##### `manage_package_repo` Boolean. When using the 'repo' installation method, controls whether the official Grafana repositories are enabled on your host. If true, the official Grafana repositories will be enabled. If false, the module assumes you are managing your own package repository and will not set one up for you. Defaults to true. ##### `plugins` Hash. This is a passthrough to call `create_resources()` on the `grafana_plugin` resource type. ##### `package_name` The name of the package managed with the 'package' install method. Defaults to 'grafana'. ##### `package_source` The download location of a package to be used with the 'package' install method. Defaults to the URL of the latest version of Grafana available at the time of module release. ##### `provisioning_datasources` A Hash which is converted to YAML for grafana to provision data sources. See [provisioning grafana](http://docs.grafana.org/administration/provisioning/) for details and example config file. Requires grafana > v5.0.0. This is very useful with Hiera as you can provide a yaml hash/dictionary which will effectively 'passthrough' to grafana. See **Advanced Usage** for examples. ##### `provisioning_dashboards` A Hash which is converted to YAML for grafana to provision dashboards. See [provisioning grafana](http://docs.grafana.org/administration/provisioning/) for details and example config file. Requires grafana > v5.0.0. This is very useful with Hiera as you can provide a yaml hash/dictionary which will effectively 'passthrough' to grafana. See **Advanced Usage** for examples. N.B. A option named `puppetsource` may be given in the `options` hash which is not part of grafana's syntax. This option will be extracted from the hash, and used to "source" a directory of dashboards. See **Advanced Usage** for details. #### `provisioning_dashboards_file` A String that is used as the target file name for the dashabords provisioning file. This way the module can be used to generate placeholder files so password can be sepecified in a different iteration, avoiding them to be put in the module code. #### `provisioning_datasources_file` A String that is used as the target file name for the datasources provisioning file. This way the module can be used to generate placeholder files so password can be sepecified in a different iteration, avoiding them to be put in the module code. ##### `rpm_iteration` Used when installing Grafana from package ('package' or 'repo' install methods) on Red Hat based systems. Defaults to '1'. It should not be necessary to change this in most cases. ##### `service_name` The name of the service managed with the 'archive' and 'package' install methods. Defaults to 'grafana-server'. ##### `version` The version of Grafana to install and manage. Defaults to 'installed' ##### `sysconfig_location` The RPM and DEB packages bring with them the default environment files for the services. The default location of this file for Debian is /etc/default/grafana-server and for RedHat /etc/sysconfig/grafana-server. ##### `sysconfig` A hash of environment variables for the service. This only has an effect for installations with RPM and DEB packages (if install_method is set to 'package' or 'repo'). Example: ```puppet sysconfig => { 'http_proxy' => 'http://proxy.example.com', } ``` ### Advanced usage The archive install method will create the user and a "command line" service by default. There are no extra parameters to manage user/service for archive. However, both check to see if they are defined before defining. This way you can create your own user and service with your own specifications. (sort of overriding) The service can be a bit tricky, in this example below, the class sensu_install::grafana::service creates a startup script and a service{'grafana-server':} Example: ```puppet user { 'grafana': ensure => present, uid => '1234', } -> class { 'grafana': install_method => 'archive', } include sensu_install::grafana::service # run your service after install/config but before grafana::service Class[::grafana::install] -> Class[sensu_install::grafana::service] -> Class[::grafana::service] ``` #### Using a sub-path for Grafana API If you are using a sub-path for the Grafana API, you will need to set the `grafana_api_path` parameter for the following custom types: - `grafana_dashboard` - `grafana_datasource` - `grafana_organization` - `grafana_user` - `grafana_folder` - `grafana_team` - `grafana_membership` - `grafana_dashboard_permission` For instance, if your sub-path is `/grafana`, the `grafana_api_path` must be set to `/grafana/api`. Do not add a trailing `/` (slash) at the end of the value. If you are not using sub-paths, you do not need to set this parameter. #### Custom Types and Providers The module includes several custom types: #### `grafana_organization` In order to use the organization resource, add the following to your manifest: ```puppet grafana_organization { 'example_org': grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', } ``` `grafana_url`, `grafana_user`, and `grafana_password` are required to create organizations via the API. `name` is optional if the name will differ from example_org above. `address` is an optional parameter that requires a hash. Address settings are `{"address1":"","address2":"","city":"","zipCode":"","state":"","country":""}` #### `grafana_team` In order to use the team resource, add the following to your manifest: ```puppet grafana_team { 'example_team': ensure => 'present', grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', home_dashboard => 'example_dashboard', organization => 'example_org', } ``` Organziation must exist if specified. `grafana_url`, `grafana_user`, and `grafana_password` are required to create teams via the API. `ensure` is required. If the resource should be `present` or `absent` `name` is optional if the name will differ from example_team above. `home_dashboard_folder` is optional. Sets the folder where home dashboard resides. Dashboard folder must exist. `home_dashboard` is optional. Sets the home dashboard for team. Dashboard must exist. `organization` is optional. Defaults to `Main org.` #### `grafana_dashboard_permission` In order to use the dashboard permission resource, add one the following to your manifest: add permissions for user: ```puppet grafana_dashboard_permission { 'example_user_permission': ensure => 'present', grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', dashboard => 'example_dashboard', user => 'example_user', organization => 'example_org', } ``` add permissions for team: ```puppet grafana_dashboard_permission { 'example_team_permission': ensure => 'present', grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', dashboard => 'example_dashboard', team => 'example_team', organization => 'example_org', } ``` Organziation, team, user and dashboard must exist if specified. `grafana_url`, `grafana_user`, and `grafana_password` are required to create teams via the API. `ensure` is required. If the resource should be `present` or `absent` `dashboard` is required. The dashboard to set permissions for. `user` is required if `team` not set. The user to add permissions for. `team` is required if `user` not set. the team to add permissions for. `name` is optional if the name will differ from example_team above. `organization` is optional. Defaults to `Main org.` #### `grafana_membership` In order to use the membership resource, add the following to your manifest: ```puppet grafana_membership { 'example_membership': ensure => 'present', grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', membership_type => 'team', organization => 'example_org', target_name => 'example_team', user_name => 'example_user', role => 'Viewer' } } ``` A membership is the concept of a user belonging to a target - either a `team` or an `organization` The user and target must both exist for a membership to be created `grafana_url`, `grafana_user`, and `grafana_password` are required to create memberships via the API. `ensure` is required. If the resource should be `present` or `absent` `membership_type` is required. Either `team` or `organization` `target_name` is required. Specifies the target of the membership. `user_name` is required. Specifies the user that is the focus of the membership. `role` is required. Specifies what rights to grant the user. Either `Viewer`, `Editor` or `Admin` `organization` is optional when using the `membership_type` of `team`. Defaults to `Main org.` #### `grafana_dashboard` In order to use the dashboard resource, add the following to your manifest: ```puppet grafana_dashboard { 'example_dashboard': grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', grafana_api_path => '/grafana/api', folder => 'folder-name', organization => 'NewOrg', content => template('path/to/exported/file.json'), } ``` `content` must be valid JSON, and is parsed before imported. `grafana_user` and `grafana_password` are optional, and required when authentication is enabled in Grafana. `grafana_api_path` is optional, and only used when using sub-paths for the API. `organization` is optional, and used when creating a dashboard for a specific organization. `folder` is an optional parameter, but the folder resource must exist. Example: Make sure the `grafana-server` service is up and running before creating the `grafana_dashboard` definition. One option is to use the `http_conn_validator` from the [healthcheck](https://forge.puppet.com/puppet/healthcheck) module ```puppet http_conn_validator { 'grafana-conn-validator' : host => 'localhost', port => '3000', use_ssl => false, test_url => '/public/img/grafana_icon.svg', require => Class['grafana'], } -> grafana_dashboard { 'example_dashboard': grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', content => template('path/to/exported/file.json'), } ``` ##### `grafana_datasource` In order to use the datasource resource, add the following to your manifest: ```puppet grafana_datasource { 'influxdb': grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', grafana_api_path => '/grafana/api', type => 'influxdb', organization => 'NewOrg', url => 'http://localhost:8086', user => 'admin', password => '1nFlux5ecret', database => 'graphite', access_mode => 'proxy', is_default => true, json_data => template('path/to/additional/config.json'), secure_json_data => template('path/to/additional/secure/config.json') } ``` Available types are: influxdb, elasticsearch, graphite, cloudwatch, mysql, opentsdb, postgres and prometheus `organization` is used to set which organization a datasource will be created on. If this parameter is not set, it will default to organization ID 1 (Main Org. by default). If the default org is deleted, organizations will need to be specified. Access mode determines how Grafana connects to the datasource, either `direct` from the browser, or `proxy` to send requests via grafana. Setting `basic_auth` to `true` will allow use of the `basic_auth_user` and `basic_auth_password` params. Authentication is optional, as are `database` and `grafana_api_path`; additional `json_data` and `secure_json_data` can be provided to allow custom configuration options. Example: Make sure the `grafana-server` service is up and running before creating the `grafana_datasource` definition. One option is to use the `http_conn_validator` from the [healthcheck](https://forge.puppet.com/puppet/healthcheck) module ```puppet http_conn_validator { 'grafana-conn-validator' : host => 'localhost', port => '3000', use_ssl => false, test_url => '/public/img/grafana_icon.svg', require => Class['grafana'], } -> grafana_datasource { 'influxdb': grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', type => 'influxdb', url => 'http://localhost:8086', user => 'admin', password => '1nFlux5ecret', database => 'graphite', access_mode => 'proxy', is_default => true, json_data => template('path/to/additional/config.json'), } ``` Note that the `database` is dynamic, setting things other than "database" for separate types. Ex: for Elasticsearch it will set the Index Name. **`jsonData` Settings** Note that there are separate options for json_data / secure_json_data based on the type of datasource you create. ##### **Elasticsearch** `esVersion` - Required, either 2 or 5, set as a bare number. `timeField` - Required. By default this is @timestamp, but without setting it in jsonData, the datasource won't work without refreshing it in the GUI. `timeInterval` - Optional. A lower limit for the auto group by time interval. Recommended to be set to write frequency, for example "1m" if your data is written every minute. Example: ```puppet json_data => {"esVersion":5,"timeField":"@timestamp","timeInterval":"1m"} ``` ##### **CloudWatch** `authType` - Required. Options are `Access & Secret Key`, `Credentials File`, or `ARN`. -"keys" = Access & Secret Key -"credentials" = Credentials File -"arn" = ARN *When setting authType to `credentials`, the `database` param will set the Credentials Profile Name.* *When setting authType to `arn`, another jsonData value of `assumeRoleARN` is available, which is not required for other authType settings* `customMetricsNamespaces` - Optional. Namespaces of Custom Metrics, separated by commas within double quotes. `defaultRegion` - Required. Options are "ap-northeast-(1 or 2)", "ap-southeast-(1 or 2)", "ap-south-1", "ca-central-1", "cn-north-1", "eu-central-1", "eu-west-(1 or 2)", "sa-east-(1 or 2)", "us-east-(1 or 2)", "us-gov-west-1", "us-west-(1 or 2)". `timeField` Example: ```puppet {"authType":"arn","assumeRoleARN":"arn:aws:iam:*","customMetricsNamespaces":"Namespace1,Namespace2","defaultRegion":"us-east-1","timeField":"@timestamp"} ``` ##### **Graphite** `graphiteVersion` - Required. Available versions are `0.9` or `1.0`. `tlsAuth` - Set to `true` or `false` `tlsAuthWithCACert` - Set to `true` or `false` Example: ```puppet {"graphiteVersion":"0.9","tlsAuth":true,"tlsAuthWithCACert":false} ``` ##### **OpenTSDB** `tsdbResolution` - Required. Options are `1` or `2`. `1` = second `2` = millisecond `tsdbVersion` - Required. Options are `1`, `2`, or `3`. `1`    =    <=2.1 `2`    =    ==2.2 `3`    =    ==2.3 Example: ```puppet {"tsdbResolution:1,"tsdbVersion":3} ``` ##### **InfluxDB** N/A ##### **MySQL** N/A ##### **Prometheus** N/A ##### `grafana_plugin` An example is provided for convenience; for more details, please view the puppet strings docs. ```puppet grafana_plugin { 'grafana-simple-json-datasource': ensure => present, } ``` It is possible to specify a custom plugin repository to install a plugin. This will use the --repo option for plugin installation with grafana_cli. ```puppet grafana_plugin { 'grafana-simple-json-datasource': ensure => present, repo => 'https://nexus.company.com/grafana/plugins', } ``` It is also possible to specify a custom plugin url to install a plugin. This will use the --pluginUrl option for plugin installation with grafana_cli. ```puppet grafana_plugin { 'grafana-example-custom-plugin': ensure => present, plugin_url => 'https://github.com/example/example-custom-plugin/zipball/v1.0.0' } ``` ##### `grafana_folder` Creates and manages Grafana folders via the API. The following example creates a folder named 'folder1': ```puppet grafana_folder { 'folder1': ensure => present, grafana_url => 'http://localhost:3000', grafana_api_path => '/grafana/api', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', } ``` `grafana_api_path` is only required if using sub-paths for the API ##### `grafana::user` Creates and manages a global grafana user via the API. ```puppet grafana_user { 'username': grafana_url => 'http://localhost:3000', grafana_api_path => '/grafana/api', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', full_name => 'John Doe', password => 'Us3r5ecret', email => 'john@example.com', } ``` `grafana_api_path` is only required if using sub-paths for the API ##### `grafana::notification` Creates and manages a global alert notification channel via the API. ```puppet grafana_notification { 'channelname': grafana_url => 'http://localhost:3000', grafana_api_path => '/grafana/api', grafana_user => 'admin', grafana_password => '5ecretPassw0rd', name => 'channelname', type => 'email', is_default => false, send_reminder => false, frequency => '20m', settings => { addresses => "alerts@example.com; it@example.com" } } ``` `grafana_api_path` is only required if using sub-paths for the API Notification types and related settingsi (cf doc Grafana : https://github.com/grafana/grafana/blob/master/docs/sources/alerting/notifications.md ) : - email: - addresses: "example.com" - hipchat: - apikey : "0a0a0a0a0a0a0a0a0a0a0a" - autoResolve : true - httpMethod : "POST" - uploadImage : true - url : "https://grafana.hipchat.com" - kafka: - autoResolve : true - httpMethod : "POST" - kafkaRestProxy: "http://localhost:8082" - kafkaTopic : "topic1" - uploadImage : true - LINE: - autoResolve: true - httpMethod : "POST" - token : "token" - uploadImage: true - teams (Microsoft Teams): - autoResolve : true - httpMethod : "POST" - uploadImage :true - url : "http://example.com" - pagerduty: - autoResolve : true - httpMethod : POST - integrationKey :"0a0a0a0a0a" - uploadImage : true - prometheus-alertmanager: - autoResolve : true - httpMethod : "POST" - uploadImage : true - url : "http://localhost:9093" - sensu: - autoResolve : true - handler : "default", - httpMethod : "POST" - uploadImage : true - url : "http://sensu-api.local:4567/results" - slack: - autoResolve : true - httpMethod : "POST" - uploadImage : true - url : "http://slack.com/" - token : "0a0a0a0a0a0a0a0a0a0a0a" - threema: - api_secret : "0a0a0a0a0a0a0a0a0a0a0a" - autoResolve : true - gateway_id : "*3MAGWID" - httpMethod : "POST" - recipient_id: "YOUR3MID" - uploadImage : true - discord: - autoResolve : true, - httpMethod : "POST" - uploadImage : true - url : "https://example.com" - webhook: - autoResolve : true - httpMethod : "POST" - uploadImage : false - url : "http://localhost:8080" - telegram: - autoResolve : true - bottoken : "0a0a0a0a0a0a" - chatid : "789789789" - httpMethod : "POST" - uploadImage : true #### Provisioning Grafana [Grafana documentation on provisioning](http://docs.grafana.org/administration/provisioning/). This module will provision grafana by placing yaml files into `/etc/grafana/provisioning/datasources` and `/etc/grafana/provisioning/dashboards` by default. ##### Example datasource A puppet hash example for Prometheus. The module will place the hash as a yaml file into `/etc/gafana/provisioning/datasources/puppetprovisioned.yaml`. ```puppet class { 'grafana': provisioning_datasources => { apiVersion => 1, datasources => [ { name => 'Prometheus', type => 'prometheus', access => 'proxy', url => 'http://localhost:9090/prometheus', isDefault => true, }, ], } } ``` Here is the same configuration example as a hiera hash. ```yaml grafana::provisioning_datasources: apiVersion: 1 datasources: - name: 'Prometheus' type: 'prometheus' access: 'proxy' url: 'http://localhost:9090/prometheus' isDefault: true ``` ##### Example dashboard An example puppet hash for provisioning dashboards. The module will place the hash as a yaml file into `/etc/grafana/provisioning/dashboards/puppetprovisioned.yaml` by default. More details follow the examples. ```puppet class { 'grafana': provisioning_dashboards => { apiVersion => 1, providers => [ { name => 'default', orgId => 1, folder => '', type => 'file', disableDeletion => true, options => { path => '/var/lib/grafana/dashboards', puppetsource => 'puppet:///modules/my_custom_module/dashboards', }, }, ], } } ``` Here is the same configuraiton example as a hiera hash. ```yaml grafana::provisioning_dashboards: apiVersion: 1 providers: - name: 'default' orgId: 1 folder: '' type: file disableDeletion: true options: path: '/var/lib/grafana/dashboards' puppetsource: 'puppet:///modules/my_custom_module/dashboards' ``` In both examples above a non-grafana option named `puppetsource` has been used. When this module finds that the provisioning_dashboards hash contains keys `path` and `puppetsource` in the `options` subhash, it will do the following. * It will create the path found in `options['path']`. Note: puppet will only create the final directory of the path unless the parameter `create_subdirs_provisioning` is set to true: this defaults to false. * It will use `puppetsource` as the file resource's 'source' for the directory. * It removes the `puppetsource` key from the `options` subhash, so the subsequent yaml file for gafana does not contain this key. (The `path` key will remain.) This feature allows you to define a custom module, and place any dashboards you want provisioned in the its `files/` directory. In the example above you would put dashboards into `my_custom_module/files/dashboards` and puppet-grafana will create `/var/lib/grafana/dashboards` and provision it with the contents of `my_custom_module/files/dashboards`. Puppet's file resource may also be given a `file://` URI which may point to a locally available directory on the filesystem, typically the filesystem of the puppetserver/master. Thus you may specify a local directory with grafana dashboards you wish to provision into grafana. ##### Provisioning with dashboards from grafana.com GrafanaLabs provides lots of [dashboards that may be reused](https://grafana.com/grafana/dashboards). Those ones are **not directly usable** for provisioning (this is a Grafana issue, not a Puppet one). In order to have a "provisionable" dashboard in JSON format, you have to prepare it before adding it in your Puppet code. Here are the steps to follow: 1. Use a Grafana instance 1. Import the desired dashboard 1. Define its datasource 1. From the dashboard view: * Click the "Share dashboard" icon (top left corner of screen) * Select the "Export" tab, * Activate "Export for sharing externally" * Click "Save to file" 1. In the JSON file: * Remove the keys `__imports` and `__requires` * Replace all `${DS_PROMETHEUS}` by your datasource name 1. Once saved, you may place this JSON file in your `puppet:///modules/my_custom_module/dashboards` directory **Note:** This procedure have been tested with Grafana 6.x. It may not work for any dashboard, depending on how it's been coded. Dashboards known to be "provisionable": * [Node Exporter Server Metric](https://grafana.com/dashboards/405) * [Prometheus Blackbox Exporter](https://grafana.com/dashboards/7587) Dashboards known not to be "provisionable": * [HTTP Services Status](https://grafana.com/dashboards/4859) ## Tasks ### `change_grafana_admin_password` `old_password`: the old admin password `new_password`: the password you want to use for the admin user `uri`: `http` or `https` `port`: the port Grafana runs on locally This task can be used to change the password for the admin user in grafana ## Limitations This module has been tested on every operating system in the metadata.json, using each of the 'archive', 'docker' and 'package' installation methods. Other configurations should work with minimal, if any, additional effort. ## Development This module is a fork of [bfraser/grafana](https://github.com/bfraser/puppet-grafana) maintained by [Vox Pupuli](https://voxpupuli.org/). Vox Pupuli welcomes new contributions to this module, especially those that include documentation and rspec tests. We are happy to provide guidance if necessary. Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for more details. ### Authors * Bill Fraser * Vox Pupuli Team ## Copyright and License Copyright (C) 2015 Bill Fraser Bill can be contacted at: fraser@pythian.com 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 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. diff --git a/REFERENCE.md b/REFERENCE.md index f7eabcb..c4696c8 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,1556 +1,1735 @@ # Reference ## Table of Contents ### Classes * [`grafana`](#grafana): == Class: grafana Installs and configures Grafana. === Parameters [*archive_source*] Download location of tarball to be used with the 'arch * [`grafana::config`](#grafanaconfig): == Class grafana::config This class is called from grafana * [`grafana::install`](#grafanainstall): == Class grafana::install * [`grafana::service`](#grafanaservice): == Class grafana::service This class is meant to be called from grafana It ensure the service is running * [`grafana::validator`](#grafanavalidator): Manage grafana_conn_validator resource ### Resource types * [`grafana_conn_validator`](#grafana_conn_validator): Verify connectivity to the Grafana API * [`grafana_dashboard`](#grafana_dashboard): Manage dashboards in Grafana * [`grafana_dashboard_permission`](#grafana_dashboard_permission): Manage dashboard permissions in Grafana * [`grafana_datasource`](#grafana_datasource): Manage datasources in Grafana * [`grafana_folder`](#grafana_folder): Manage folders in Grafana * [`grafana_ldap_config`](#grafana_ldap_config): Manage Grafana LDAP configuration * [`grafana_ldap_group_mapping`](#grafana_ldap_group_mapping): Map an LDAP group to a Grafana role. * [`grafana_ldap_server`](#grafana_ldap_server): Manage Grafana LDAP servers for LDAP authentication. * [`grafana_membership`](#grafana_membership): Manage resource memberships in Grafana * [`grafana_notification`](#grafana_notification): Manage notification in Grafana * [`grafana_organization`](#grafana_organization): Manage organizations in Grafana * [`grafana_plugin`](#grafana_plugin): manages grafana plugins * [`grafana_team`](#grafana_team): Manage teams in Grafana * [`grafana_user`](#grafana_user): Manage users in Grafana ### Functions * [`grafana::deep_find_and_remove`](#grafanadeep_find_and_remove): == Function: deep_find_and_remove This function takes a hash as input, along with a string (key). Additionally, the optional removekey (defa * [`grafana::get_sub_paths`](#grafanaget_sub_paths): == Function get_sub_paths This function receives an input path as an input parameter, and returns an array of the subpaths in the input, exc ### Tasks * [`change_grafana_admin_password`](#change_grafana_admin_password): Change the Grafana admin user's password ## Classes -### `grafana` +### `grafana` == Class: grafana Installs and configures Grafana. === Parameters [*archive_source*] Download location of tarball to be used with the 'archive' install method. Defaults to the URL of the latest version of Grafana available at the time of module release. [*container_cfg*] Boolean. Determines whether a configuration file should be generated when using the 'docker' install method. If true, use the `cfg` and `cfg_location` parameters to control creation of the file. Defaults to false. [*container_params*] Hash of parameters to use when creating the Docker container. For use with the 'docker' install method. Refer to documentation of the `docker::run` resource in the `garethr-docker` module for details of available parameters. Defaults to: container_params => { 'image' => 'grafana/grafana:latest', 'ports' => '3000' } [*data_dir*] The directory Grafana will use for storing its data. Defaults to '/var/lib/grafana'. [*install_dir*] Installation directory to be used with the 'archive' install method. Defaults to '/usr/share/grafana'. [*install_method*] Set to 'archive' to install Grafana using the tar archive. Set to 'docker' to install Grafana using the official Docker container. Set to 'package' to install Grafana using .deb or .rpm packages. Set to 'repo' to install Grafana using an apt or yum repository. Defaults to 'package'. [*manage_package_repo*] If true this will setup the official grafana repositories on your host. Defaults to true. [*package_name*] The name of the package managed with the 'package' install method. Defaults to 'grafana'. [*package_source*] Download location of package to be used with the 'package' install method. Defaults to the URL of the latest version of Grafana available at the time of module release. [*service_name*] The name of the service managed with the 'archive' and 'package' install methods. Defaults to 'grafana-server'. [*version*] The version of Grafana to install and manage. Defaults to 'installed' [*repo_name*] When using 'repo' install_method, the repo to look for packages in. Set to 'stable' to install only stable versions Set to 'beta' to install beta versions Defaults to stable. [*plugins*] A hash of plugins to be passed to `create_resources`, wraps around the `grafana_plugin` resource. [*provisioning_dashboards*] Hash of dashboards to provision into grafana. grafana > v5.0.0 required. Hash will be converted into YAML and used by grafana to provision dashboards. [*provisioning_datasources*] Hash of datasources to provision into grafana, grafana > v5.0.0 required. Hash will be converted into YAML and used by granfana to configure datasources. [*provisioning_dashboards_file*] String with the fully qualified path to place the provisioning file for dashboards, only used if provisioning_dashboards is specified. Defaults to '/etc/grafana/provisioning/dashboards/puppetprovisioned.yaml' [*provisioning_datasources_file*] String with the fully qualified path to place the provisioning file for datasources, only used if provisioning_datasources is specified. Default to '/etc/grafana/provisioning/datasources/puppetprovisioned.yaml' [*create_subdirs_provisioning*] Boolean, defaults to false. If true puppet will create any subdirectories in the given path when provisioning dashboards. [*sysconfig_location*] Location of the sysconfig file for the environment of the grafana-server service. This is only used when the install_method is 'package' or 'repo'. [*sysconfig*] A hash of environment variables for the grafana-server service Example: sysconfig => { 'http_proxy' => 'http://proxy.example.com/' } [*ldap_servers*] A hash of ldap_servers to be passed to `create_resources`, wraps around the `grafana_ldap_server` resource. [*ldap_group_mappings*] A hash of ldap_servers to be passed to `create_resources`, wraps around the `grafana_ldap_group_mapping` resource. [*toml_manage_package*] ruby-toml is required to generate the TOML-based LDAP config for Grafana. Defaults to true. Set to false if you manage package- or gem-install somewhere else. [*toml_package_name*] Name of the software-package providing the TOML parser library. Defaults to ruby-toml. [*toml_package_ensure*] Ensure the package-resource - e.g. installed, absent, etc. https://puppet.com/docs/puppet/latest/types/package.html#package-attribute-ensure Defaults to present [*toml_package_provider*] The package-provider used to install the TOML parser library. Defaults to undef, to let Puppet decide. See https://puppet.com/docs/puppet/latest/types/package.html#package-attribute-provider === Examples class { '::grafana': install_method => 'docker', } #### Parameters -The following parameters are available in the `grafana` class. - -##### `archive_source` +The following parameters are available in the `grafana` class: + +* [`archive_source`](#archive_source) +* [`cfg_location`](#cfg_location) +* [`cfg`](#cfg) +* [`ldap_cfg`](#ldap_cfg) +* [`container_cfg`](#container_cfg) +* [`container_params`](#container_params) +* [`docker_image`](#docker_image) +* [`docker_ports`](#docker_ports) +* [`data_dir`](#data_dir) +* [`install_dir`](#install_dir) +* [`install_method`](#install_method) +* [`manage_package_repo`](#manage_package_repo) +* [`package_name`](#package_name) +* [`package_source`](#package_source) +* [`repo_name`](#repo_name) +* [`rpm_iteration`](#rpm_iteration) +* [`service_name`](#service_name) +* [`version`](#version) +* [`plugins`](#plugins) +* [`provisioning_dashboards`](#provisioning_dashboards) +* [`provisioning_datasources`](#provisioning_datasources) +* [`provisioning_dashboards_file`](#provisioning_dashboards_file) +* [`provisioning_datasources_file`](#provisioning_datasources_file) +* [`create_subdirs_provisioning`](#create_subdirs_provisioning) +* [`sysconfig_location`](#sysconfig_location) +* [`sysconfig`](#sysconfig) +* [`ldap_servers`](#ldap_servers) +* [`ldap_group_mappings`](#ldap_group_mappings) +* [`toml_manage_package`](#toml_manage_package) +* [`toml_package_name`](#toml_package_name) +* [`toml_package_ensure`](#toml_package_ensure) +* [`toml_package_provider`](#toml_package_provider) + +##### `archive_source` Data type: `Optional[String]` -##### `cfg_location` +##### `cfg_location` Data type: `String` -##### `cfg` +##### `cfg` Data type: `Hash` -##### `ldap_cfg` +##### `ldap_cfg` Data type: `Optional[Variant[Hash,Array]]` -##### `container_cfg` +##### `container_cfg` Data type: `Boolean` -##### `container_params` +##### `container_params` Data type: `Hash` -##### `docker_image` +##### `docker_image` Data type: `String` -##### `docker_ports` +##### `docker_ports` Data type: `String` -##### `data_dir` +##### `data_dir` Data type: `String` -##### `install_dir` +##### `install_dir` Data type: `String` -##### `install_method` +##### `install_method` Data type: `String` -##### `manage_package_repo` +##### `manage_package_repo` Data type: `Boolean` -##### `package_name` +##### `package_name` Data type: `String` -##### `package_source` +##### `package_source` Data type: `Optional[String]` -##### `repo_name` +##### `repo_name` Data type: `Enum['stable', 'beta']` -##### `rpm_iteration` +##### `rpm_iteration` Data type: `String` -##### `service_name` +##### `service_name` Data type: `String` -##### `version` +##### `version` Data type: `String` -##### `plugins` +##### `plugins` Data type: `Hash` -##### `provisioning_dashboards` +##### `provisioning_dashboards` Data type: `Hash` -##### `provisioning_datasources` +##### `provisioning_datasources` Data type: `Hash` -##### `provisioning_dashboards_file` +##### `provisioning_dashboards_file` Data type: `String` -##### `provisioning_datasources_file` +##### `provisioning_datasources_file` Data type: `String` -##### `create_subdirs_provisioning` +##### `create_subdirs_provisioning` Data type: `Boolean` -##### `sysconfig_location` +##### `sysconfig_location` Data type: `Optional[String]` -##### `sysconfig` +##### `sysconfig` Data type: `Optional[Hash]` -##### `ldap_servers` +##### `ldap_servers` Data type: `Hash[String[1], Hash]` -##### `ldap_group_mappings` +##### `ldap_group_mappings` Data type: `Hash[String[1], Hash]` -##### `toml_manage_package` +##### `toml_manage_package` Data type: `Boolean` -##### `toml_package_name` +##### `toml_package_name` Data type: `String[1]` -##### `toml_package_ensure` +##### `toml_package_ensure` Data type: `String[1]` -##### `toml_package_provider` +##### `toml_package_provider` Data type: `Optional[String[1]]` -### `grafana::config` +### `grafana::config` == Class grafana::config This class is called from grafana -### `grafana::install` +### `grafana::install` == Class grafana::install -### `grafana::service` +### `grafana::service` == Class grafana::service This class is meant to be called from grafana It ensure the service is running -### `grafana::validator` +### `grafana::validator` Manage grafana_conn_validator resource #### Parameters -The following parameters are available in the `grafana::validator` class. +The following parameters are available in the `grafana::validator` class: + +* [`grafana_url`](#grafana_url) +* [`grafana_api_path`](#grafana_api_path) -##### `grafana_url` +##### `grafana_url` Data type: `Stdlib::HTTPUrl` Grafana URL. Default value: `'http://localhost:3000'` -##### `grafana_api_path` +##### `grafana_api_path` Data type: `Stdlib::Absolutepath` API path to validate with. Default value: `'/api/health'` ## Resource types -### `grafana_conn_validator` +### `grafana_conn_validator` Verify connectivity to the Grafana API #### Properties The following properties are available in the `grafana_conn_validator` type. ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` #### Parameters The following parameters are available in the `grafana_conn_validator` type. -##### `grafana_api_path` +* [`grafana_api_path`](#grafana_api_path) +* [`grafana_url`](#grafana_url) +* [`name`](#name) +* [`provider`](#provider) +* [`timeout`](#timeout) + +##### `grafana_api_path` The absolute path to the API endpoint Default value: `/api/health` -##### `grafana_url` +##### `grafana_url` The URL of the Grafana server Default value: `http://localhost:3000` -##### `name` +##### `name` namevar Arbitrary name of this resource -##### `provider` +##### `provider` The specific backend to use for this `grafana_conn_validator` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -##### `timeout` +##### `timeout` How long to wait for the API to be available Default value: `20` -### `grafana_dashboard` +### `grafana_dashboard` Manage dashboards in Grafana #### Properties The following properties are available in the `grafana_dashboard` type. ##### `content` The JSON representation of the dashboard. ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` #### Parameters The following parameters are available in the `grafana_dashboard` type. -##### `folder` +* [`folder`](#folder) +* [`grafana_api_path`](#grafana_api_path) +* [`grafana_password`](#grafana_password) +* [`grafana_url`](#grafana_url) +* [`grafana_user`](#grafana_user) +* [`organization`](#organization) +* [`provider`](#provider) +* [`title`](#title) + +##### `folder` The folder to place the dashboard in (optional) -##### `grafana_api_path` +##### `grafana_api_path` The absolute path to the API endpoint Default value: `/api` -##### `grafana_password` +##### `grafana_password` The password for the Grafana server (optional) -##### `grafana_url` +##### `grafana_url` The URL of the Grafana server Default value: `''` -##### `grafana_user` +##### `grafana_user` The username for the Grafana server (optional) -##### `organization` +##### `organization` The organization name to create the datasource on Default value: `1` -##### `provider` +##### `provider` The specific backend to use for this `grafana_dashboard` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -##### `title` +##### `title` The title of the dashboard. -### `grafana_dashboard_permission` +### `grafana_dashboard_permission` Manage dashboard permissions in Grafana #### Properties The following properties are available in the `grafana_dashboard_permission` type. ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` ##### `permission` Valid values: `Admin`, `Edit`, `View` The role to apply #### Parameters The following parameters are available in the `grafana_dashboard_permission` type. -##### `dashboard` +* [`dashboard`](#dashboard) +* [`grafana_api_path`](#grafana_api_path) +* [`grafana_password`](#grafana_password) +* [`grafana_url`](#grafana_url) +* [`grafana_user`](#grafana_user) +* [`name`](#name) +* [`organization`](#organization) +* [`provider`](#provider) +* [`team`](#team) +* [`user`](#user) + +##### `dashboard` Dashboard to modify permissions for -##### `grafana_api_path` +##### `grafana_api_path` The absolute path to the API endpoint Default value: `/api` -##### `grafana_password` +##### `grafana_password` The password for the Grafana server -##### `grafana_url` +##### `grafana_url` The URL of the Grafana server Default value: `''` -##### `grafana_user` +##### `grafana_user` The username for the Grafana server -##### `name` +##### `name` namevar The name of the permission. -##### `organization` +##### `organization` The name of the organization to add permission for Default value: `Main Org.` -##### `provider` +##### `provider` The specific backend to use for this `grafana_dashboard_permission` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -##### `team` +##### `team` Team to add the permission for -##### `user` +##### `user` User to add the permission for -### `grafana_datasource` +### `grafana_datasource` Manage datasources in Grafana #### Properties The following properties are available in the `grafana_datasource` type. ##### `access_mode` Valid values: `direct`, `proxy` Whether the datasource is accessed directly or not by the clients Default value: `direct` ##### `basic_auth` Valid values: ``true``, ``false`` Whether basic auth is enabled or not Default value: `false` ##### `basic_auth_password` The password for basic auth if enabled Default value: `''` ##### `basic_auth_user` The username for basic auth if enabled Default value: `''` ##### `database` The name of the database (optional) ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` ##### `is_default` Valid values: ``true``, ``false`` Whether the datasource is the default one Default value: `false` ##### `json_data` Additional JSON data to configure the datasource (optional) ##### `password` The password for the datasource (optional) ##### `secure_json_data` Additional secure JSON data to configure the datasource (optional) ##### `type` The datasource type ##### `url` The URL/Endpoint of the datasource ##### `user` The username for the datasource (optional) ##### `with_credentials` Valid values: ``true``, ``false`` Whether credentials such as cookies or auth headers should be sent with cross-site requests Default value: `false` #### Parameters The following parameters are available in the `grafana_datasource` type. -##### `grafana_api_path` +* [`grafana_api_path`](#grafana_api_path) +* [`grafana_password`](#grafana_password) +* [`grafana_url`](#grafana_url) +* [`grafana_user`](#grafana_user) +* [`name`](#name) +* [`organization`](#organization) +* [`provider`](#provider) + +##### `grafana_api_path` The absolute path to the API endpoint Default value: `/api` -##### `grafana_password` +##### `grafana_password` The password for the Grafana server -##### `grafana_url` +##### `grafana_url` The URL of the Grafana server Default value: `''` -##### `grafana_user` +##### `grafana_user` The username for the Grafana server -##### `name` +##### `name` namevar The name of the datasource. -##### `organization` +##### `organization` The organization name to create the datasource on Default value: `1` -##### `provider` +##### `provider` The specific backend to use for this `grafana_datasource` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -### `grafana_folder` +### `grafana_folder` Manage folders in Grafana #### Properties The following properties are available in the `grafana_folder` type. ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` ##### `permissions` The permissions of the folder #### Parameters The following parameters are available in the `grafana_folder` type. -##### `grafana_api_path` +* [`grafana_api_path`](#grafana_api_path) +* [`grafana_password`](#grafana_password) +* [`grafana_url`](#grafana_url) +* [`grafana_user`](#grafana_user) +* [`organization`](#organization) +* [`provider`](#provider) +* [`title`](#title) +* [`uid`](#uid) + +##### `grafana_api_path` The absolute path to the API endpoint Default value: `/api` -##### `grafana_password` +##### `grafana_password` The password for the Grafana server (optional) -##### `grafana_url` +##### `grafana_url` The URL of the Grafana server Default value: `''` -##### `grafana_user` +##### `grafana_user` The username for the Grafana server (optional) -##### `organization` +##### `organization` The organization name to create the folder on Default value: `1` -##### `provider` +##### `provider` The specific backend to use for this `grafana_folder` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -##### `title` +##### `title` The title of the folder -##### `uid` +##### `uid` UID of the folder -### `grafana_ldap_config` +### `grafana_ldap_config` Manage Grafana LDAP configuration #### Parameters The following parameters are available in the `grafana_ldap_config` type. -##### `backup` +* [`backup`](#backup) +* [`group`](#group) +* [`mode`](#mode) +* [`owner`](#owner) +* [`replace`](#replace) +* [`title`](#title) +* [`validate_cmd`](#validate_cmd) + +##### `backup` Valid values: ``true``, ``false``, `yes`, `no` Backup existing files before replacing them into the file-bucket Default value: ``false`` -##### `group` +##### `group` Group of the LDAP configuration file either as String or Integer (default: grafana) Default value: `grafana` -##### `mode` +##### `mode` File-permissions mode of the LDAP configuration file as String Default value: `0440` -##### `owner` +##### `owner` Owner of the LDAP configuration-file either as String or Integer (default: root) Default value: `root` -##### `replace` +##### `replace` Valid values: ``true``, ``false``, `yes`, `no` Replace existing files Default value: ``true`` -##### `title` +##### `title` Path to ldap.toml -##### `validate_cmd` +##### `validate_cmd` A command to validate the new Grafana LDAP configuration before actually replacing it -### `grafana_ldap_group_mapping` +### `grafana_ldap_group_mapping` Map an LDAP group to a Grafana role. #### Parameters The following parameters are available in the `grafana_ldap_group_mapping` type. -##### `grafana_admin` +* [`grafana_admin`](#grafana_admin) +* [`group_dn`](#group_dn) +* [`ldap_server_name`](#ldap_server_name) +* [`org_role`](#org_role) +* [`title`](#title) + +##### `grafana_admin` Valid values: ``true``, ``false``, `yes`, `no` Additonal flag for Grafana > v5.3 to signal admin-role to Grafana Default value: ``false`` -##### `group_dn` +##### `group_dn` The LDAP distinguished-name of the group -##### `ldap_server_name` +##### `ldap_server_name` The LDAP server config to apply the group-mappings on -##### `org_role` +##### `org_role` Valid values: `Admin`, `Editor`, `Viewer` The Grafana role the shall be assigned to this group -##### `title` +##### `title` A unique identifier of the resource -### `grafana_ldap_server` +### `grafana_ldap_server` Manage Grafana LDAP servers for LDAP authentication. #### Parameters The following parameters are available in the `grafana_ldap_server` type. -##### `attributes` +* [`attributes`](#attributes) +* [`bind_dn`](#bind_dn) +* [`bind_password`](#bind_password) +* [`client_cert`](#client_cert) +* [`client_key`](#client_key) +* [`group_search_base_dns`](#group_search_base_dns) +* [`group_search_filter`](#group_search_filter) +* [`group_search_filter_user_attribute`](#group_search_filter_user_attribute) +* [`hosts`](#hosts) +* [`port`](#port) +* [`root_ca_cert`](#root_ca_cert) +* [`search_base_dns`](#search_base_dns) +* [`search_filter`](#search_filter) +* [`ssl_skip_verify`](#ssl_skip_verify) +* [`start_tls`](#start_tls) +* [`title`](#title) +* [`use_ssl`](#use_ssl) + +##### `attributes` Mapping LDAP attributes to their Grafana user-account-properties (optional) -##### `bind_dn` +##### `bind_dn` If the LDAP server requires authentication (i.e. non-anonymous), provide the distinguished-name (dn) here (optional) -##### `bind_password` +##### `bind_password` If the LDAP server requires authentication (i.e. non-anonymous), provide the password (optional) -##### `client_cert` +##### `client_cert` If the LDAP server requires certificate-based authentication, specify the client's certificate (for TLS and SSL, optional) -##### `client_key` +##### `client_key` If the LDAP server requires certificate-based authentication, specify the client's certificate (for TLS and SSL, optional) -##### `group_search_base_dns` +##### `group_search_base_dns` The base-dn to be used when querying LDAP for group-accounts (optional) -##### `group_search_filter` +##### `group_search_filter` A search-filter to be used when querying LDAP for group-accounts (optional) -##### `group_search_filter_user_attribute` +##### `group_search_filter_user_attribute` The attribute to be used to locate matching user-accounts in the group (optional) -##### `hosts` +##### `hosts` The servers to perform LDAP authentication at -##### `port` +##### `port` The port to connect at the LDAP servers (389 for TLS/plaintext, 636 for SSL [ldaps], optional) Default value: `389` -##### `root_ca_cert` +##### `root_ca_cert` The root ca-certificate to verify the LDAP server's SSL certificate against (for TLS and SSL, optional) Default value: `/etc/ssl/certs/ca-certificates.crt` -##### `search_base_dns` +##### `search_base_dns` The one or more base-dn to be used when querying LDAP for user-accounts (optional) Default value: `[]` -##### `search_filter` +##### `search_filter` A search-filter to be used when querying LDAP for user-accounts (optional) -##### `ssl_skip_verify` +##### `ssl_skip_verify` Valid values: ``true``, ``false``, `yes`, `no` Set to true to disable verification of the LDAP server's SSL certificate (for TLS and SSL, optional) Default value: ``false`` -##### `start_tls` +##### `start_tls` Valid values: ``true``, ``false``, `yes`, `no` Set to true if you want to perform LDAP via a TLS-connection (not meant to be for SSL, optional) Default value: ``true`` -##### `title` +##### `title` A unique identified for this LDAP server. -##### `use_ssl` +##### `use_ssl` Valid values: ``true``, ``false``, `yes`, `no` Set to true if you want to perform LDAP via a SSL-connection (not meant to be for TLS, optional) Default value: ``false`` -### `grafana_membership` +### `grafana_membership` Manage resource memberships in Grafana #### Properties The following properties are available in the `grafana_membership` type. ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` ##### `role` Valid values: `Admin`, `Editor`, `Viewer` The role to apply to the membership (Admin, Editor, Viewer) #### Parameters The following parameters are available in the `grafana_membership` type. -##### `grafana_api_path` +* [`grafana_api_path`](#grafana_api_path) +* [`grafana_password`](#grafana_password) +* [`grafana_url`](#grafana_url) +* [`grafana_user`](#grafana_user) +* [`membership_type`](#membership_type) +* [`name`](#name) +* [`organization`](#organization) +* [`provider`](#provider) +* [`target_name`](#target_name) +* [`user_name`](#user_name) + +##### `grafana_api_path` The absolute path to the API endpoint Default value: `/api` -##### `grafana_password` +##### `grafana_password` The password for the Grafana server -##### `grafana_url` +##### `grafana_url` The URL of the Grafana server Default value: `''` -##### `grafana_user` +##### `grafana_user` The username for the Grafana server -##### `membership_type` +##### `membership_type` Valid values: `organization`, `team` The underlying type of the membership (organization, team) -##### `name` +##### `name` namevar The name of the membership. -##### `organization` +##### `organization` The name of the organization to add membership for (team only) Default value: `Main Org.` -##### `provider` +##### `provider` The specific backend to use for this `grafana_membership` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -##### `target_name` +##### `target_name` The name of the target to add membership for -##### `user_name` +##### `user_name` The name of the user to add membership for -### `grafana_notification` +### `grafana_notification` Manage notification in Grafana #### Properties The following properties are available in the `grafana_notification` type. ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` ##### `frequency` The notification reminder frequency ##### `is_default` Valid values: ``true``, ``false`` Whether the notification is the default one Default value: `false` ##### `send_reminder` Valid values: ``true``, ``false`` Whether automatic message resending is enabled or not Default value: `false` ##### `settings` Additional JSON data to configure the notification ##### `type` The notification type #### Parameters The following parameters are available in the `grafana_notification` type. -##### `grafana_api_path` +* [`grafana_api_path`](#grafana_api_path) +* [`grafana_password`](#grafana_password) +* [`grafana_url`](#grafana_url) +* [`grafana_user`](#grafana_user) +* [`name`](#name) +* [`provider`](#provider) + +##### `grafana_api_path` The absolute path to the API endpoint Default value: `/api` -##### `grafana_password` +##### `grafana_password` The password for the Grafana server -##### `grafana_url` +##### `grafana_url` The URL of the Grafana server Default value: `''` -##### `grafana_user` +##### `grafana_user` The username for the Grafana server -##### `name` +##### `name` namevar The name of the notification. -##### `provider` +##### `provider` The specific backend to use for this `grafana_notification` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -### `grafana_organization` +### `grafana_organization` Manage organizations in Grafana #### Properties The following properties are available in the `grafana_organization` type. ##### `address` Additional JSON data to configure the organization address (optional) ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` ##### `id` The ID of the organization #### Parameters The following parameters are available in the `grafana_organization` type. -##### `grafana_api_path` +* [`grafana_api_path`](#grafana_api_path) +* [`grafana_password`](#grafana_password) +* [`grafana_url`](#grafana_url) +* [`grafana_user`](#grafana_user) +* [`name`](#name) +* [`provider`](#provider) + +##### `grafana_api_path` The absolute path to the API endpoint Default value: `/api` -##### `grafana_password` +##### `grafana_password` The password for the Grafana server -##### `grafana_url` +##### `grafana_url` The URL of the Grafana server Default value: `''` -##### `grafana_user` +##### `grafana_user` The username for the Grafana server -##### `name` +##### `name` namevar The name of the organization. -##### `provider` +##### `provider` The specific backend to use for this `grafana_organization` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -### `grafana_plugin` +### `grafana_plugin` manages grafana plugins #### Examples ##### Install a grafana plugin ```puppet grafana_plugin { 'grafana-simple-json-datasource': } ``` ##### Install a grafana plugin from different repo ```puppet grafana_plugin { 'grafana-simple-json-datasource': - ensure => present, + ensure => 'present', repo => 'https://nexus.company.com/grafana/plugins', } ``` +##### Install a grafana plugin from a plugin url + +```puppet +grafana_plugin { 'grafana-example-custom-plugin': + ensure => 'present', + plugin_url => 'https://github.com/example/example-custom-plugin/zipball/v1.0.0' +} +``` + ##### Uninstall a grafana plugin ```puppet grafana_plugin { 'grafana-simple-json-datasource': - ensure => absent, + ensure => 'absent', } ``` ##### Show resources ```puppet $ puppet resource grafana_plugin ``` #### Properties The following properties are available in the `grafana_plugin` type. ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` #### Parameters The following parameters are available in the `grafana_plugin` type. -##### `name` +* [`name`](#name) +* [`plugin_url`](#plugin_url) +* [`provider`](#provider) +* [`repo`](#repo) + +##### `name` Valid values: `%r{^\S+$}` namevar The name of the plugin to enable -##### `provider` +##### `plugin_url` + +Full url to the plugin zip file + +##### `provider` The specific backend to use for this `grafana_plugin` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -##### `repo` +##### `repo` The URL of an internal plugin server -### `grafana_team` +### `grafana_team` Manage teams in Grafana #### Properties The following properties are available in the `grafana_team` type. ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` ##### `home_dashboard` The id or name of the home dashboard +Default value: `Default` + +##### `home_dashboard_folder` + +The UID or name of the home dashboard folder + ##### `theme` The theme to use for the team ##### `timezone` The timezone to use for the team #### Parameters The following parameters are available in the `grafana_team` type. -##### `email` +* [`email`](#email) +* [`grafana_api_path`](#grafana_api_path) +* [`grafana_password`](#grafana_password) +* [`grafana_url`](#grafana_url) +* [`grafana_user`](#grafana_user) +* [`name`](#name) +* [`organization`](#organization) +* [`provider`](#provider) + +##### `email` The email for the team Default value: `''` -##### `grafana_api_path` +##### `grafana_api_path` The absolute path to the API endpoint Default value: `/api` -##### `grafana_password` +##### `grafana_password` The password for the Grafana server -##### `grafana_url` +##### `grafana_url` The URL of the Grafana server Default value: `''` -##### `grafana_user` +##### `grafana_user` The username for the Grafana server -##### `name` +##### `name` namevar The name of the team -##### `organization` +##### `organization` The organization the team belongs to -##### `provider` +Default value: `Main Org.` + +##### `provider` The specific backend to use for this `grafana_team` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -### `grafana_user` +### `grafana_user` Manage users in Grafana #### Properties The following properties are available in the `grafana_user` type. ##### `email` The email for the user ##### `ensure` Valid values: `present`, `absent` The basic property that the resource should be in. Default value: `present` ##### `is_admin` Valid values: ``true``, ``false`` Whether the user is a grafana admin Default value: `false` ##### `password` The password for the user ##### `theme` The theme for the user #### Parameters The following parameters are available in the `grafana_user` type. -##### `full_name` +* [`full_name`](#full_name) +* [`grafana_api_path`](#grafana_api_path) +* [`grafana_password`](#grafana_password) +* [`grafana_url`](#grafana_url) +* [`grafana_user`](#grafana_user) +* [`name`](#name) +* [`provider`](#provider) + +##### `full_name` The full name of the user. -##### `grafana_api_path` +##### `grafana_api_path` The absolute path to the API endpoint Default value: `/api` -##### `grafana_password` +##### `grafana_password` The password for the Grafana server -##### `grafana_url` +##### `grafana_url` The URL of the Grafana server Default value: `''` -##### `grafana_user` +##### `grafana_user` The username for the Grafana server -##### `name` +##### `name` namevar The username of the user. -##### `provider` +##### `provider` The specific backend to use for this `grafana_user` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. ## Functions -### `grafana::deep_find_and_remove` +### `grafana::deep_find_and_remove` Type: Ruby 4.x API == Function: deep_find_and_remove This function takes a hash as input, along with a string (key). Additionally, the optional removekey (defaults to 'puppetsource') is a parameter. The purpose of this function is to extract the 'options' subhash from the array of hashes given to provision dashboards. This options subhash may contain a path and source which puppet will use for provisioning: creating the path and applying the files from the source. Additionally, if the key 'puppetsource' exists in the sub-hash, it will be deleted from the structure. Thus the output of this function may be used in yaml format for grafana's provisioning configuration file for dashboards. #### `grafana::deep_find_and_remove(String $key, Hash $object, Optional[String] $removekey)` == Function: deep_find_and_remove This function takes a hash as input, along with a string (key). Additionally, the optional removekey (defaults to 'puppetsource') is a parameter. The purpose of this function is to extract the 'options' subhash from the array of hashes given to provision dashboards. This options subhash may contain a path and source which puppet will use for provisioning: creating the path and applying the files from the source. Additionally, if the key 'puppetsource' exists in the sub-hash, it will be deleted from the structure. Thus the output of this function may be used in yaml format for grafana's provisioning configuration file for dashboards. Returns: `Array` ##### `key` Data type: `String` ##### `object` Data type: `Hash` ##### `removekey` Data type: `Optional[String]` -### `grafana::get_sub_paths` +### `grafana::get_sub_paths` Type: Ruby 4.x API == Function get_sub_paths This function receives an input path as an input parameter, and returns an array of the subpaths in the input, excluding the input path itself. The function will attempt to ignore any extra slashes in the path given. This function will only work on UNIX paths with forward slashes (/). Examples: input = '/var/lib/grafana/dashboards' output = [ '/var', '/var/lib', '/var/lib/grafana'/ ] input = '/opt' output = [] input = '/first/second/' output = [ '/first' ] #### `grafana::get_sub_paths(String $inputpath)` == Function get_sub_paths This function receives an input path as an input parameter, and returns an array of the subpaths in the input, excluding the input path itself. The function will attempt to ignore any extra slashes in the path given. This function will only work on UNIX paths with forward slashes (/). Examples: input = '/var/lib/grafana/dashboards' output = [ '/var', '/var/lib', '/var/lib/grafana'/ ] input = '/opt' output = [] input = '/first/second/' output = [ '/first' ] Returns: `Array` ##### `inputpath` Data type: `String` ## Tasks -### `change_grafana_admin_password` +### `change_grafana_admin_password` Change the Grafana admin user's password **Supports noop?** false #### Parameters ##### `old_password` Data type: `Optional[String[1]]` The old admin password ##### `new_password` Data type: `Optional[String[1]]` The new admin password ##### `uri` Data type: `Enum['http','https']` http or https ##### `port` Data type: `Integer` The port Grafana is running on diff --git a/metadata.json b/metadata.json index 1cdd330..2ef470a 100644 --- a/metadata.json +++ b/metadata.json @@ -1,76 +1,76 @@ { "name": "puppet-grafana", - "version": "8.0.1-rc0", + "version": "9.0.0", "author": "Vox Pupuli", "summary": "This module provides Grafana, a dashboard and graph editor for Graphite and InfluxDB.", "license": "Apache-2.0", "source": "https://github.com/voxpupuli/puppet-grafana.git", "project_page": "https://github.com/voxpupuli/puppet-grafana", "issue_url": "https://github.com/voxpupuli/puppet-grafana/issues", "dependencies": [ { "name": "puppetlabs/stdlib", "version_requirement": ">= 4.20.0 < 8.0.0" }, { "name": "puppet/archive", "version_requirement": ">= 1.0.1 < 6.0.0" } ], "operatingsystem_support": [ { "operatingsystem": "Debian", "operatingsystemrelease": [ "9", "10" ] }, { "operatingsystem": "Ubuntu", "operatingsystemrelease": [ "16.04", "18.04", "20.04" ] }, { "operatingsystem": "RedHat", "operatingsystemrelease": [ "7" ] }, { "operatingsystem": "CentOS", "operatingsystemrelease": [ "7" ] }, { "operatingsystem": "Archlinux" }, { "operatingsystem": "FreeBSD", "operatingsystemrelease": [ "12" ] }, { "operatingsystem": "SLES", "operatingsystemrelease": [ "12" ] } ], "requirements": [ { "name": "puppet", "version_requirement": ">= 6.1.0 < 8.0.0" } ], "tags": [ "grafana", "graphite", "influxdb", "monitoring" ] }