Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

kibana

Manages kibana
Project URLRSS FeedReport issues

29,562 downloads

27,541 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 2.5.0 (latest)
  • 2.4.0
released Mar 3rd 2016
This version is compatible with:
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'jlambert121-kibana', '2.5.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jlambert121-kibana
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jlambert121-kibana --version 2.5.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: kibana, elk

Documentation

jlambert121/kibana — version 2.5.0 Mar 3rd 2016

Puppet Forge Build Status

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with kibana
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module
  8. 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 jlambert121-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 parameters
  • kibana::install: Installs kibana package
  • kibana::config: Configures Kibana
  • kibana::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.

Changelog / Contributors

Changelog

Contributors