Forge Home

kibana4

Kibana 4 installation

151,443 downloads

82,948 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.

Version information

  • 1.0.17 (latest)
  • 1.0.16
  • 1.0.15
  • 1.0.14
  • 1.0.13
  • 1.0.12
  • 1.0.11
  • 1.0.10
  • 1.0.9
  • 1.0.8
  • 1.0.7 (deleted)
  • 1.0.6
  • 1.0.5
  • 1.0.4
  • 1.0.3
  • 1.0.2
  • 1.0.1
  • 1.0.0 (deleted)
  • 0.0.9
  • 0.0.8 (deleted)
  • 0.0.7
  • 0.0.6
  • 0.0.5
  • 0.0.4
  • 0.0.3
  • 0.0.2
  • 0.0.1
released Feb 25th 2015
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 'lesaux-kibana4', '0.0.4'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add lesaux-kibana4
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install lesaux-kibana4 --version 0.0.4

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

Documentation

lesaux/kibana4 — version 0.0.4 Feb 25th 2015

kibana4

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 kibana4
  4. Usage - Configuration options and additional functionality
  5. Parameters
  6. Reference - An under-the-hood peek at what the module is doing and how
  7. Limitations - OS compatibility, etc.

Overview

Install and configure Kibana4. Should work on any linux OS.

Module Description

This module assumes you have a working Elasticsearch installation and indices (usually an "ELK" stack) Kibana4 only works with recent versions of Elasticsearch ( 1.4 an up? ). I recommend using the "elasticsearch_http" output in logstash as the "elasticsearch" output uses ES version 1.1.1 and will prevent Kibana4 from connecting.

Setup

What kibana4 affects

  • Downloads and extracts the kibana4 archive
  • Optionally create a user to use for the service
  • Creates an initrd file as one is not yet provided by the archive
  • Modifies configuration file if needed.
  • Java installation is not managed by this module.

Beginning with kibana4

include kibana4

Usage

If you decided to have the module create a user, you will need to specify user name, group name, uid and gid.

  class { '::kibana4':
    version           => '4.0.0-linux-x64',
    install_method    => 'archive',
    symlink           => false,
    create_user       => true,
    kibana4_user      => kibana4,
    kibana4_group     => kibana4,
    kibana4_gid       => 200,
    kibana4_uid       => 200,
    elasticsearch_url => 'http://localhost:9200',
  }

Parameters

Check all parameters in init.pp file

Installation Parameters

[ensure]

Should the service be started. Valid values are stopped (false) and running (true)

[enable]

Should the service be enabled on boot. Valid values are true, false, and manual.

[create_user]

Should the module a create a user to run Kibana4. Default is false, in which case Kibana will run as root. If set to true, you will need to specify values for kibana4_group, kibana4_user, kibana4_uid and kibana4_gid.

[kibana4_user]

The user that will run the service. For now installation directory is still owned by root. This will be a "system" account.

[kibana4_group]

The primary group of the kibana user

[kibana4_uid]

Choose the kibana4_user uid

[kibana4_gid]

Choose the kibana4_group gid

[install_dir]

Installation directory used iff install_method is 'archive' Defaults to '/opt'.

[install_method]

Only the "archive" method is supported at the moment

[symlink]

Determines if a symlink should be created in the installation directory for the extracted archive. Only used if install_method is 'archive'. Defaults to 'true'.

[symlink_name]

Sets the name to be used for the symlink. The default is '${install_dir}/kibana4'. Only used if install_method is 'archive'.

[version]

Version of Kibana4 that gets installed. Defaults to the latest 4.0.0-linux-x64 version available at the time of module release.

[download_url]

URL to download kibana from if install_method is 'archive' Defaults to "https://download.elasticsearch.org/kibana/kibana/kibana-${version}.tar.gz"

Configuration Parameters

See Kibana4 documentation for more details. Defaults values are the same as defaults from kibana.yml provided in the archive version 4.0.0-linux-x64.

[port]

[host]

[elasticsearch_url]

[elasticsearch_preserve_host]

[kibana_index]

[default_app_id]

[request_timeout]

[shard_timeout]

[verify_ssl]

Default has been changed to false. Providing better SSL support is my todo list.

[ca]

[ssl_key_file]

[ssl_cert_file]

[pid_file]

[bundled_plugin_ids]

Reference

This module uses camptocamp/archives to download and extract the Kibana4 archive.

Limitations

Basic spec testing is done, but no tests on the generated config file are done at the moment.