diff --git a/README.md b/README.md index 1f038bc..e12af66 100644 --- a/README.md +++ b/README.md @@ -1,934 +1,936 @@ # grafana [![Build Status](https://travis-ci.org/voxpupuli/puppet-grafana.png?branch=master)](https://travis-ci.org/voxpupuli/puppet-grafana) [![Code Coverage](https://coveralls.io/repos/github/voxpupuli/puppet-grafana/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppet-grafana) [![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) #### 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. ## 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', } }, ``` ##### `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` 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_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', } ``` ##### `grafana_folder` Creates and manages Grafana folders via the API. The following example creates a folder named 'folder1': ```puppet grafana_folder { 'folder1': 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. ## 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 Ubuntu 14.04, 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/lib/puppet/provider/grafana_dashboard/grafana.rb b/lib/puppet/provider/grafana_dashboard/grafana.rb index e5b879b..0add4c2 100644 --- a/lib/puppet/provider/grafana_dashboard/grafana.rb +++ b/lib/puppet/provider/grafana_dashboard/grafana.rb @@ -1,138 +1,167 @@ # Copyright 2015 Mirantis, Inc. # require 'json' require File.expand_path(File.join(File.dirname(__FILE__), '..', 'grafana')) # Note: this class doesn't implement the self.instances and self.prefetch # methods because the Grafana API doesn't allow to retrieve the dashboards and # all their properties in a single call. Puppet::Type.type(:grafana_dashboard).provide(:grafana, parent: Puppet::Provider::Grafana) do desc 'Support for Grafana dashboards stored into Grafana' defaultfor kernel: 'Linux' def organization resource[:organization] end def grafana_api_path resource[:grafana_api_path] end def fetch_organizations response = send_request('GET', format('%s/orgs', resource[:grafana_api_path])) if response.code != '200' raise format('Fail to retrieve organizations (HTTP response: %s/%s)', response.code, response.body) end begin fetch_organizations = JSON.parse(response.body) fetch_organizations.map { |x| x['id'] }.map do |id| response = send_request 'GET', format('%s/orgs/%s', resource[:grafana_api_path], id) if response.code != '200' raise format('Failed to retrieve organization %d (HTTP response: %s/%s)', id, response.code, response.body) end fetch_organization = JSON.parse(response.body) { id: fetch_organization['id'], name: fetch_organization['name'] } end rescue JSON::ParserError raise format('Failed to parse response: %s', response.body) end end def fetch_organization unless @fetch_organization @fetch_organization = if resource[:organization].is_a?(Numeric) || resource[:organization].match(%r{^[0-9]*$}) fetch_organizations.find { |x| x[:id] == resource[:organization] } else fetch_organizations.find { |x| x[:name] == resource[:organization] } end end @fetch_organization end + def folders + response = send_request('GET', format('%s/folders', resource[:grafana_api_path])) + if response.code != '200' + raise format('Fail to retrieve the folders (HTTP response: %s/%s)', response.code, response.body) + end + + begin + @folders = JSON.parse(response.body) + rescue JSON::ParserError + raise format('Fail to parse folders (HTTP response: %s/%s)', response.code, response.body) + end + end + + def find_folder + folders unless @folders + + begin + @folders.each do |folder| + @folder = folder if folder['title'] == resource[:folder] + end + raise format('Folder not found: %s', resource[:folder]) unless @folder['title'] == resource[:folder] + rescue JSON::ParserError + raise format('Fail to parse folder %s: %s', resource[:folder], response.body) + end + end + # Return the list of dashboards def dashboards response = send_request('GET', format('%s/search', resource[:grafana_api_path]), nil, q: '', starred: false) if response.code != '200' raise format('Fail to retrieve the dashboards (HTTP response: %s/%s)', response.code, response.body) end begin JSON.parse(response.body) rescue JSON::ParserError raise format('Fail to parse dashboards (HTTP response: %s/%s)', response.code, response.body) end end # Return the dashboard matching with the resource's title def find_dashboard return unless dashboards.find { |x| x['title'] == resource[:title] } response = send_request('GET', format('%s/dashboards/db/%s', resource[:grafana_api_path], slug)) if response.code != '200' raise format('Fail to retrieve dashboard %s (HTTP response: %s/%s)', resource[:title], response.code, response.body) end begin # Cache the dashboard's content @dashboard = JSON.parse(response.body)['dashboard'] rescue JSON::ParserError raise format('Fail to parse dashboard %s: %s', resource[:title], response.body) end end def save_dashboard(dashboard) + find_folder if resource[:folder] + # change organizations response = send_request 'POST', format('%s/user/using/%s', resource[:grafana_api_path], fetch_organization[:id]) unless response.code == '200' raise format('Failed to switch to org %s (HTTP response: %s/%s)', fetch_organization[:id], response.code, response.body) end data = { dashboard: dashboard.merge('title' => resource[:title], 'id' => @dashboard ? @dashboard['id'] : nil, 'version' => @dashboard ? @dashboard['version'] + 1 : 0), + folderId: @folder ? @folder['id'] : nil, overwrite: !@dashboard.nil? } response = send_request('POST', format('%s/dashboards/db', resource[:grafana_api_path]), data) return unless (response.code != '200') && (response.code != '412') raise format('Fail to save dashboard %s (HTTP response: %s/%s', resource[:name], response.code, response.body) end def slug resource[:title].downcase.gsub(%r{[ \+]+}, '-').gsub(%r{[^\w\- ]}, '') end def content @dashboard.reject { |k, _| k =~ %r{^id|version|title$} } end def content=(value) save_dashboard(value) end def create save_dashboard(resource[:content]) end def destroy response = send_request('DELETE', format('%s/dashboards/db/%s', resource[:grafana_api_path], slug)) return unless response.code != '200' raise Puppet::Error, format('Failed to delete dashboard %s (HTTP response: %s/%s', resource[:title], response.code, response.body) end def exists? find_dashboard end end diff --git a/lib/puppet/provider/grafana_folder/grafana.rb b/lib/puppet/provider/grafana_folder/grafana.rb index 97baa13..ac9621b 100644 --- a/lib/puppet/provider/grafana_folder/grafana.rb +++ b/lib/puppet/provider/grafana_folder/grafana.rb @@ -1,137 +1,132 @@ require 'json' require File.expand_path(File.join(File.dirname(__FILE__), '..', 'grafana')) Puppet::Type.type(:grafana_folder).provide(:grafana, parent: Puppet::Provider::Grafana) do desc 'Support for Grafana folders stored into Grafana' defaultfor kernel: 'Linux' def organization resource[:organization] end def grafana_api_path resource[:grafana_api_path] end def fetch_organizations response = send_request('GET', format('%s/orgs', resource[:grafana_api_path])) if response.code != '200' raise format('Fail to retrieve organizations (HTTP response: %s/%s)', response.code, response.body) end begin fetch_organizations = JSON.parse(response.body) fetch_organizations.map { |x| x['id'] }.map do |id| response = send_request 'GET', format('%s/orgs/%s', resource[:grafana_api_path], id) if response.code != '200' raise format('Failed to retrieve organization %d (HTTP response: %s/%s)', id, response.code, response.body) end fetch_organization = JSON.parse(response.body) { id: fetch_organization['id'], name: fetch_organization['name'] } end rescue JSON::ParserError raise format('Failed to parse response: %s', response.body) end end def fetch_organization unless @fetch_organization @fetch_organization = if resource[:organization].is_a?(Numeric) || resource[:organization].match(%r{^[0-9]*$}) fetch_organizations.find { |x| x[:id] == resource[:organization] } else fetch_organizations.find { |x| x[:name] == resource[:organization] } end end @fetch_organization end def folders response = send_request('GET', format('%s/folders', resource[:grafana_api_path])) if response.code != '200' raise format('Fail to retrieve the folders (HTTP response: %s/%s)', response.code, response.body) end begin - JSON.parse(response.body) + @folders = JSON.parse(response.body) rescue JSON::ParserError raise format('Fail to parse folders (HTTP response: %s/%s)', response.code, response.body) end end def find_folder - return unless folders.find { |x| x['title'] == resource[:title] } + folders unless @folders - response = send_request('GET', format('%s/folders', resource[:grafana_api_path])) - if response.code != '200' - raise format('Fail to retrieve folders (HTTP response: %s/%s)', response.code, response.body) - end - - begin - folders = JSON.parse(response.body) - folders.each do |folder| - @folder = folder if folder['title'] == resource[:title] - end - rescue JSON::ParserError - raise format('Fail to parse folder %s: %s', resource[:title], response.body) + @folders.each do |folder| + @folder = folder if folder['title'] == resource[:title] end end def save_folder(folder) response = send_request 'POST', format('%s/user/using/%s', resource[:grafana_api_path], fetch_organization[:id]) unless response.code == '200' raise format('Failed to switch to org %s (HTTP response: %s/%s)', fetch_organization[:id], response.code, response.body) end # if folder exists, update object based on uid # else, create object if @folder.nil? data = { title: resource[:title] } response = send_request('POST', format('%s/folders', resource[:grafana_api_path]), data) return unless (response.code != '200') && (response.code != '412') raise format('Failed to create folder %s (HTTP response: %s/%s)', resource[:title], response.code, response.body) else data = { folder: folder.merge('title' => resource[:title], 'uid' => @folder['uid']), overwrite: !@folder.nil? } response = send_request('POST', format('%s/folders/%s', resource[:grafana_api_path], @folder['uid']), data) return unless (response.code != '200') && (response.code != '412') raise format('Failed to update folder %s (HTTP response: %s/%s)', resource[:title], response.code, response.body) end end def slug resource[:title].downcase.gsub(%r{[ \+]+}, '-').gsub(%r{[^\w\- ]}, '') end def create save_folder(resource) end def destroy find_folder unless @folder response = send_request('DELETE', format('%s/folders/%s', resource[:grafana_api_path], @folder['uid'])) return unless response.code != '200' raise Puppet::Error, format('Failed to delete folder %s (HTTP response: %s/%s)', resource[:title], response.code, response.body) end def exists? - find_folder + folders unless @folders + + @folders.each do |folder| + return true if folder['title'] == resource[:title] + end + false end end diff --git a/lib/puppet/type/grafana_dashboard.rb b/lib/puppet/type/grafana_dashboard.rb index a0a6cb3..967669e 100644 --- a/lib/puppet/type/grafana_dashboard.rb +++ b/lib/puppet/type/grafana_dashboard.rb @@ -1,81 +1,85 @@ # Copyright 2015 Mirantis, Inc. # require 'json' Puppet::Type.newtype(:grafana_dashboard) do @doc = 'Manage dashboards in Grafana' ensurable newparam(:title, namevar: true) do desc 'The title of the dashboard.' end + newparam(:folder) do + desc 'The folder to place the dashboard in (optional)' + end + newproperty(:content) do desc 'The JSON representation of the dashboard.' validate do |value| begin JSON.parse(value) rescue JSON::ParserError raise ArgumentError, 'Invalid JSON string for content' end end munge do |value| new_value = JSON.parse(value).reject { |k, _| k =~ %r{^id|version|title$} } new_value.sort.to_h end def should_to_s(value) if value.length > 12 "#{value.to_s.slice(0, 12)}..." else value end end end newparam(:grafana_url) do desc 'The URL of the Grafana server' defaultto '' validate do |value| unless value =~ %r{^https?://} raise ArgumentError, format('%s is not a valid URL', value) end end end newparam(:grafana_user) do desc 'The username for the Grafana server (optional)' end newparam(:grafana_password) do desc 'The password for the Grafana server (optional)' end newparam(:grafana_api_path) do desc 'The absolute path to the API endpoint' defaultto '/api' validate do |value| unless value =~ %r{^/.*/?api$} raise ArgumentError, format('%s is not a valid API path', value) end end end newparam(:organization) do desc 'The organization name to create the datasource on' defaultto 1 end # rubocop:disable Style/SignalException validate do fail('content is required when ensure is present') if self[:ensure] == :present && self[:content].nil? end autorequire(:service) do 'grafana-server' end end diff --git a/spec/acceptance/grafana_folder_spec.rb b/spec/acceptance/grafana_folder_spec.rb index 5373887..2ef3ee7 100644 --- a/spec/acceptance/grafana_folder_spec.rb +++ b/spec/acceptance/grafana_folder_spec.rb @@ -1,63 +1,104 @@ require 'spec_helper_acceptance' describe 'grafana_folder' do context 'setup grafana server' do it 'runs successfully' do pp = <<-EOS class { 'grafana': cfg => { security => { admin_user => 'admin', admin_password => 'admin' } } } EOS apply_manifest(pp, catch_failures: true) apply_manifest(pp, catch_changes: true) end end context 'create folder resource' do it 'creates the folder' do pp = <<-EOS grafana_folder { 'example-folder': ensure => present, grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => 'admin' } EOS apply_manifest(pp, catch_failures: true) apply_manifest(pp, catch_changes: true) end it 'has the folder' do shell('curl --user admin:admin http://localhost:3000/api/folders') do |f| expect(f.stdout).to match(%r{example-folder}) end end end - context 'destroy folder resource' do - it 'destroys the folder' do + context 'create folder containing dashboard' do + it 'creates an example dashboard in the example folder' do + pp = <<-EOS + grafana_dashboard { 'example-dashboard': + ensure => present, + grafana_url => 'http://localhost:3000', + grafana_user => 'admin', + grafana_password => 'admin', + content => '{"uid": "abc123xy"}', + folder => 'example-folder' + } + EOS + apply_manifest(pp, catch_failures: true) + apply_manifest(pp, catch_changes: true) + end + + it 'folder contains dashboard' do + shell('curl --user admin:admin http://localhost:3000/api/dashboards/db/example-dashboard') do |f| + expect(f.stdout).to match(%r{"folderId":1}) + end + end + end + + context 'destroy resources' do + it 'destroys the folders and dashboard' do pp = <<-EOS grafana_folder { 'example-folder': ensure => absent, grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => 'admin', } + grafana_folder { 'nomatch-folder': + ensure => absent, + grafana_url => 'http://localhost:3000', + grafana_user => 'admin', + grafana_password => 'admin', + } + grafana_dashboard { 'example-dashboard': + ensure => absent, + grafana_url => 'http://localhost:3000', + grafana_user => 'admin', + grafana_password => 'admin', + } EOS apply_manifest(pp, catch_failures: true) apply_manifest(pp, catch_changes: true) end - it 'does not have the folder' do + it 'has no example-folder' do shell('curl --user admin:admin http://localhost:3000/api/folders') do |f| expect(f.stdout).not_to match(%r{example-folder}) end end + + it 'has no nomatch-folder' do + shell('curl --user admin:admin http://localhost:3000/api/folders') do |f| + expect(f.stdout).not_to match(%r{nomatch-folder}) + end + end end end