Forge Home

kibana

Installs and configures Kibana4 from packages.

14,281 downloads

6,955 latest version

4.3 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

  • 5.1.0 (latest)
  • 5.0.1
  • 5.0.0
  • 4.1.0
  • 4.0.1
  • 4.0.0
  • 3.1.0
  • 3.0.0
  • 2.6.0
  • 2.5.3
  • 2.3.1
  • 2.3.0
  • 2.2.1
  • 2.2.0
released Feb 28th 2017
This version is compatible with:
  • Puppet Enterprise 3.x
  • Puppet >=3.4.0 <5.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'cristifalcas-kibana', '5.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install cristifalcas-kibana --version 5.1.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

Documentation

cristifalcas/kibana — version 5.1.0 Feb 28th 2017

kibana

Build Status

Table of Contents

  1. Overview
  2. Usage - Configuration options and additional functionality
  3. Development - Guide for contributing to the module

Overview

Kibana is an open source analytics and visualization platform designed to work with Elasticsearch. You use Kibana to search, view, and interact with data stored in Elasticsearch indices. You can easily perform advanced data analysis and visualize your data in a variety of charts, tables, and maps.

This module is for kibana 5.x

Usage

  include ::kibana


  # in order for the following configuration to work you will need to allow users kibana
  # and apache acccess to puppet certificates
  class { 'kibana':
    server_ssl_enable => true,
    server_ssl_cert   => "${::settings::ssldir}/certs/${::clientcert}.pem",
    server_ssl_key    => "${::settings::ssldir}/private_keys/${::clientcert}.pem",
  }

  class { 'kibana::proxy::apache':
    ssl_port => 8443,
    ssl_cert => "${::settings::ssldir}/certs/${::clientcert}.pem",
    ssl_key  => "${::settings::ssldir}/private_keys/${::clientcert}.pem",
  }

Connecting to elasticsearch directly:

https://kibana_hostname:8443/_elastic/

Using kopf plugin behind the proxy:

  elasticsearch::plugin { 'lmenezes/elasticsearch-kopf':
    module_dir => 'kopf',
    instances  => $instance_name,
  } ->
  file { '/usr/share/elasticsearch/plugins/kopf/_site/kopf_external_settings.json':
    content => '{
    "elasticsearch_root_path": "/_elastic/",
    "with_credentials": false,
    "theme": "dark",
    "refresh_rate": 5000
    }'
  }

Connecting to plugins:

https://kibana_hostname/_plugin/kopf

Using a plain file to authenticate:

  htpasswd { 'user_name':
    cryptpasswd => ht_sha1('password'),
    target      => "${::apache::conf_dir}/kibana.htpasswd",
  } ->
  file { "${::apache::conf_dir}/kibana.htpasswd":
    owner => 'apache',
  }

  class { 'kibana::proxy::apache':
    ssl_port => 8443,
    ssl_ca   => "${::settings::ssldir}/certs/ca.pem",
    ssl_cert => "${::settings::ssldir}/certs/${::clientcert}.pem",
    ssl_key  => "${::settings::ssldir}/private_keys/${::clientcert}.pem",
    custom_fragment => "
    <Proxy *>
        Order Allow,Deny
        Allow from all
        AuthName 'we need your user and password'
        AuthType basic
        AuthBasicProvider file
        AuthUserFile ${::apache::conf_dir}/kibana.htpasswd
        Require valid-user
    </Proxy>"
  }

Using ldap to authenticate:

  include apache::mod::authnz_ldap
  class { 'kibana::proxy::apache':
    ssl_port => 8443,
    ssl_ca   => "${::settings::ssldir}/certs/ca.pem",
    ssl_cert => "${::settings::ssldir}/certs/${::clientcert}.pem",
    ssl_key  => "${::settings::ssldir}/private_keys/${::clientcert}.pem",
    custom_fragment => "
    <Proxy *>
        Order Allow,Deny
        Allow from all
        AuthName 'we need your user and password'
        AuthType Basic
        AuthBasicProvider ldap
        AuthUserFile /dev/null
        AuthLDAPUrl ldap://${ldap_server}:389/${ldap_search_base}?sAMAccountName
        AuthLDAPBindDN ${ldap_search_name}
        AuthLDAPBindPassword ${ldap_search_pass}
        Require ldap-group CN=GROUP1,OU=Groups,${ldap_search_base}
        Require ldap-group CN=GROUP2,OU=Groups,${ldap_search_base}
    </Proxy>"
  }

Development

  • Fork the project
  • Commit and push until you are happy with your contribution
  • Send a pull request with a description of your changes