diff --git a/CHANGELOG.md b/CHANGELOG.md index 7857984..d498d82 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,440 +1,471 @@ # 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. +## [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.1.0...v7.0.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)) -**Fixed bugs:** - -- fix datasource provider error [\#90](https://github.com/voxpupuli/puppet-grafana/pull/90) ([brandonrdn](https://github.com/brandonrdn)) - **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) ([cassianoleal](https://github.com/cassianoleal)) +- 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) ([cassianoleal](https://github.com/cassianoleal)) +- 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/REFERENCE.md b/REFERENCE.md new file mode 100644 index 0000000..f7eabcb --- /dev/null +++ b/REFERENCE.md @@ -0,0 +1,1556 @@ +# 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` + +== 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` + +Data type: `Optional[String]` + + + +##### `cfg_location` + +Data type: `String` + + + +##### `cfg` + +Data type: `Hash` + + + +##### `ldap_cfg` + +Data type: `Optional[Variant[Hash,Array]]` + + + +##### `container_cfg` + +Data type: `Boolean` + + + +##### `container_params` + +Data type: `Hash` + + + +##### `docker_image` + +Data type: `String` + + + +##### `docker_ports` + +Data type: `String` + + + +##### `data_dir` + +Data type: `String` + + + +##### `install_dir` + +Data type: `String` + + + +##### `install_method` + +Data type: `String` + + + +##### `manage_package_repo` + +Data type: `Boolean` + + + +##### `package_name` + +Data type: `String` + + + +##### `package_source` + +Data type: `Optional[String]` + + + +##### `repo_name` + +Data type: `Enum['stable', 'beta']` + + + +##### `rpm_iteration` + +Data type: `String` + + + +##### `service_name` + +Data type: `String` + + + +##### `version` + +Data type: `String` + + + +##### `plugins` + +Data type: `Hash` + + + +##### `provisioning_dashboards` + +Data type: `Hash` + + + +##### `provisioning_datasources` + +Data type: `Hash` + + + +##### `provisioning_dashboards_file` + +Data type: `String` + + + +##### `provisioning_datasources_file` + +Data type: `String` + + + +##### `create_subdirs_provisioning` + +Data type: `Boolean` + + + +##### `sysconfig_location` + +Data type: `Optional[String]` + + + +##### `sysconfig` + +Data type: `Optional[Hash]` + + + +##### `ldap_servers` + +Data type: `Hash[String[1], Hash]` + + + +##### `ldap_group_mappings` + +Data type: `Hash[String[1], Hash]` + + + +##### `toml_manage_package` + +Data type: `Boolean` + + + +##### `toml_package_name` + +Data type: `String[1]` + + + +##### `toml_package_ensure` + +Data type: `String[1]` + + + +##### `toml_package_provider` + +Data type: `Optional[String[1]]` + + + +### `grafana::config` + +== Class grafana::config + +This class is called from grafana + +### `grafana::install` + +== Class grafana::install + +### `grafana::service` + +== Class grafana::service + +This class is meant to be called from grafana +It ensure the service is running + +### `grafana::validator` + +Manage grafana_conn_validator resource + +#### Parameters + +The following parameters are available in the `grafana::validator` class. + +##### `grafana_url` + +Data type: `Stdlib::HTTPUrl` + +Grafana URL. + +Default value: `'http://localhost:3000'` + +##### `grafana_api_path` + +Data type: `Stdlib::Absolutepath` + +API path to validate with. + +Default value: `'/api/health'` + +## Resource types + +### `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` + +The absolute path to the API endpoint + +Default value: `/api/health` + +##### `grafana_url` + +The URL of the Grafana server + +Default value: `http://localhost:3000` + +##### `name` + +namevar + +Arbitrary name of this resource + +##### `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` + +How long to wait for the API to be available + +Default value: `20` + +### `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` + +The folder to place the dashboard in (optional) + +##### `grafana_api_path` + +The absolute path to the API endpoint + +Default value: `/api` + +##### `grafana_password` + +The password for the Grafana server (optional) + +##### `grafana_url` + +The URL of the Grafana server + +Default value: `''` + +##### `grafana_user` + +The username for the Grafana server (optional) + +##### `organization` + +The organization name to create the datasource on + +Default value: `1` + +##### `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` + +The title of the dashboard. + +### `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 to modify permissions for + +##### `grafana_api_path` + +The absolute path to the API endpoint + +Default value: `/api` + +##### `grafana_password` + +The password for the Grafana server + +##### `grafana_url` + +The URL of the Grafana server + +Default value: `''` + +##### `grafana_user` + +The username for the Grafana server + +##### `name` + +namevar + +The name of the permission. + +##### `organization` + +The name of the organization to add permission for + +Default value: `Main Org.` + +##### `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 to add the permission for + +##### `user` + +User to add the permission for + +### `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` + +The absolute path to the API endpoint + +Default value: `/api` + +##### `grafana_password` + +The password for the Grafana server + +##### `grafana_url` + +The URL of the Grafana server + +Default value: `''` + +##### `grafana_user` + +The username for the Grafana server + +##### `name` + +namevar + +The name of the datasource. + +##### `organization` + +The organization name to create the datasource on + +Default value: `1` + +##### `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` + +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` + +The absolute path to the API endpoint + +Default value: `/api` + +##### `grafana_password` + +The password for the Grafana server (optional) + +##### `grafana_url` + +The URL of the Grafana server + +Default value: `''` + +##### `grafana_user` + +The username for the Grafana server (optional) + +##### `organization` + +The organization name to create the folder on + +Default value: `1` + +##### `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` + +The title of the folder + +##### `uid` + +UID of the folder + +### `grafana_ldap_config` + +Manage Grafana LDAP configuration + +#### Parameters + +The following parameters are available in the `grafana_ldap_config` type. + +##### `backup` + +Valid values: ``true``, ``false``, `yes`, `no` + +Backup existing files before replacing them into the file-bucket + +Default value: ``false`` + +##### `group` + +Group of the LDAP configuration file either as String or Integer (default: grafana) + +Default value: `grafana` + +##### `mode` + +File-permissions mode of the LDAP configuration file as String + +Default value: `0440` + +##### `owner` + +Owner of the LDAP configuration-file either as String or Integer (default: root) + +Default value: `root` + +##### `replace` + +Valid values: ``true``, ``false``, `yes`, `no` + +Replace existing files + +Default value: ``true`` + +##### `title` + +Path to ldap.toml + +##### `validate_cmd` + +A command to validate the new Grafana LDAP configuration before actually replacing it + +### `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` + +Valid values: ``true``, ``false``, `yes`, `no` + +Additonal flag for Grafana > v5.3 to signal admin-role to Grafana + +Default value: ``false`` + +##### `group_dn` + +The LDAP distinguished-name of the group + +##### `ldap_server_name` + +The LDAP server config to apply the group-mappings on + +##### `org_role` + +Valid values: `Admin`, `Editor`, `Viewer` + +The Grafana role the shall be assigned to this group + +##### `title` + +A unique identifier of the resource + +### `grafana_ldap_server` + +Manage Grafana LDAP servers for LDAP authentication. + +#### Parameters + +The following parameters are available in the `grafana_ldap_server` type. + +##### `attributes` + +Mapping LDAP attributes to their Grafana user-account-properties (optional) + +##### `bind_dn` + +If the LDAP server requires authentication (i.e. non-anonymous), provide the distinguished-name (dn) here (optional) + +##### `bind_password` + +If the LDAP server requires authentication (i.e. non-anonymous), provide the password (optional) + +##### `client_cert` + +If the LDAP server requires certificate-based authentication, specify the client's certificate (for TLS and SSL, +optional) + +##### `client_key` + +If the LDAP server requires certificate-based authentication, specify the client's certificate (for TLS and SSL, +optional) + +##### `group_search_base_dns` + +The base-dn to be used when querying LDAP for group-accounts (optional) + +##### `group_search_filter` + +A search-filter to be used when querying LDAP for group-accounts (optional) + +##### `group_search_filter_user_attribute` + +The attribute to be used to locate matching user-accounts in the group (optional) + +##### `hosts` + +The servers to perform LDAP authentication at + +##### `port` + +The port to connect at the LDAP servers (389 for TLS/plaintext, 636 for SSL [ldaps], optional) + +Default value: `389` + +##### `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` + +The one or more base-dn to be used when querying LDAP for user-accounts (optional) + +Default value: `[]` + +##### `search_filter` + +A search-filter to be used when querying LDAP for user-accounts (optional) + +##### `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` + +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` + +A unique identified for this LDAP server. + +##### `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` + +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` + +The absolute path to the API endpoint + +Default value: `/api` + +##### `grafana_password` + +The password for the Grafana server + +##### `grafana_url` + +The URL of the Grafana server + +Default value: `''` + +##### `grafana_user` + +The username for the Grafana server + +##### `membership_type` + +Valid values: `organization`, `team` + +The underlying type of the membership (organization, team) + +##### `name` + +namevar + +The name of the membership. + +##### `organization` + +The name of the organization to add membership for (team only) + +Default value: `Main Org.` + +##### `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` + +The name of the target to add membership for + +##### `user_name` + +The name of the user to add membership for + +### `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` + +The absolute path to the API endpoint + +Default value: `/api` + +##### `grafana_password` + +The password for the Grafana server + +##### `grafana_url` + +The URL of the Grafana server + +Default value: `''` + +##### `grafana_user` + +The username for the Grafana server + +##### `name` + +namevar + +The name of the notification. + +##### `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` + +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` + +The absolute path to the API endpoint + +Default value: `/api` + +##### `grafana_password` + +The password for the Grafana server + +##### `grafana_url` + +The URL of the Grafana server + +Default value: `''` + +##### `grafana_user` + +The username for the Grafana server + +##### `name` + +namevar + +The name of the organization. + +##### `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` + +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, + repo => 'https://nexus.company.com/grafana/plugins', +} +``` + +##### Uninstall a grafana plugin + +```puppet +grafana_plugin { 'grafana-simple-json-datasource': + 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` + +Valid values: `%r{^\S+$}` + +namevar + +The name of the plugin to enable + +##### `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` + +The URL of an internal plugin server + +### `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 + +##### `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` + +The email for the team + +Default value: `''` + +##### `grafana_api_path` + +The absolute path to the API endpoint + +Default value: `/api` + +##### `grafana_password` + +The password for the Grafana server + +##### `grafana_url` + +The URL of the Grafana server + +Default value: `''` + +##### `grafana_user` + +The username for the Grafana server + +##### `name` + +namevar + +The name of the team + +##### `organization` + +The organization the team belongs to + +##### `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` + +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` + +The full name of the user. + +##### `grafana_api_path` + +The absolute path to the API endpoint + +Default value: `/api` + +##### `grafana_password` + +The password for the Grafana server + +##### `grafana_url` + +The URL of the Grafana server + +Default value: `''` + +##### `grafana_user` + +The username for the Grafana server + +##### `name` + +namevar + +The username of the user. + +##### `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` + +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` + +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 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 b691ba5..a43dc70 100644 --- a/metadata.json +++ b/metadata.json @@ -1,78 +1,78 @@ { "name": "puppet-grafana", - "version": "6.1.1-rc0", + "version": "7.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": "puppet/archive", "version_requirement": ">= 1.0.1 < 5.0.0" }, { "name": "puppetlabs/stdlib", "version_requirement": ">= 4.20.0 < 7.0.0" } ], "operatingsystem_support": [ { "operatingsystem": "Debian", "operatingsystemrelease": [ "8", "9", "10" ] }, { "operatingsystem": "Ubuntu", "operatingsystemrelease": [ "16.04", "18.04" ] }, { "operatingsystem": "RedHat", "operatingsystemrelease": [ "6", "7" ] }, { "operatingsystem": "CentOS", "operatingsystemrelease": [ "6", "7" ] }, { "operatingsystem": "Archlinux" }, { "operatingsystem": "FreeBSD", "operatingsystemrelease": [ "12" ] }, { "operatingsystem": "SLES", "operatingsystemrelease": [ "12" ] } ], "requirements": [ { "name": "puppet", "version_requirement": ">= 5.5.8 < 7.0.0" } ], "tags": [ "grafana", "graphite", "influxdb", "monitoring" ] }