Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with kibana
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Changelog/Contributors
Overview
Puppet module to install and configure Kibana 4.
Module Description
This module installs kibana 4 (https://www.elastic.co/products/kibana), commonly used as part of the ELK stack (Elasticsearch, Logstash, Kibana).
Setup
What kibana affects
- Kibana package
- Kibana service
Beginning with kibana
Installation of the kibana module:
puppet module install evenup-kibana
Usage
Installation:
class { 'kibana': }
Reference
Public methods
Class: kibana
Main class for managing kibana.
#####version
String. Version of kibana to install
Default: '4.0.1'
#####base_url
String. HTTP path to fetch kibana package from
Default: https://download.elasticsearch.org/kibana/kibana
#####tmp_dir
String. Working dir for caching package
Default: /tmp
#####install_path
String. Location to install kibana
Default: /opt
#####port
Integer. Port for kibana to listen on
Default: 5601
#####es_url
String. ElasticSearch path to connect to
Default: http://localhost:9200
#####es_preserve_host
Boolean.
Default: true
#####kibana_index
String. Index to save searches, visualizations, and dashboards
Default: .kibana
#####default_app_id
String. The default application to load.
Default: discover
#####request_timeout
Integer. Time in milliseconds to wait for responses from the back end or elasticsearch.
Default: 300000
#####shard_timeout
String. Time in milliseconds for Elasticsearch to wait for responses from shards.
Default: 0
Private classes
kibana::params
: Default parameterskibana::install
: Installs kibana packagekibana::config
: Configures Kibanakibana::service
: Manages the kibana service
Limitations
- Only tested on Centos 6
Development
Improvements and bug fixes are greatly appreciated. See the contributing guide for information on adding and validating tests for PRs.