RETIRED, Integrate Elasticsearch and Kibana with Fuel
Go to file
Simon Pasquier 3f50514248 Fix Settings tab becoming unresponsive
The 'condition' property in the 'restrictions' object needs to be
coerced into a string value otherwise the Settings tab in the Fuel UI
will stop working once the plugin is enabled.

Change-Id: Icee882cc466c0573c43410247c15ec761eb485d8
2015-04-24 15:12:33 +02:00
deployment_scripts/puppet Add Apache license headers to Puppet manifests 2015-04-21 15:06:13 +02:00
repositories Initial import 2015-03-03 17:01:36 +01:00
specs s/ElasticSearch/Elasticsearch/ where appropriate 2015-04-23 15:54:26 +02:00
.gitreview Added .gitreview 2015-02-13 08:49:06 +00:00
LICENSE Add Apache license headers to Puppet manifests 2015-04-21 15:06:13 +02:00
README.md s/ElasticSearch/Elasticsearch/ where appropriate 2015-04-23 15:54:26 +02:00
environment_config.yaml Fix Settings tab becoming unresponsive 2015-04-24 15:12:33 +02:00
metadata.yaml Modify the plugin's version to 0.7.0 2015-04-07 11:37:52 +02:00
pre_build_hook Update the URL of the JRE package for Ubuntu 2015-04-22 17:51:31 +02:00
tasks.yaml Create disk partitions on Ubuntu. 2015-03-12 15:52:25 +01:00

README.md

Elasticsearch-Kibana Plugin for Fuel

Elasticsearch-Kibana plugin

Overview

Elasticsearch and Kibana provide a full-text search engine with a flexible web interface for exploring and visualizing data.

Requirements

Requirement Version/Comment
Mirantis OpenStack compatility 6.1 or higher

Recommendations

It is highly recommended to use dedicated disk(s) for data storage. Otherwise Elasticsearch will store its data on the root filesystem.

Limitations

None so far.

Installation Guide

Elasticsearch-Kibana plugin installation

To install the Elasticsearch-Kibana plugin, follow these steps:

  1. Download the plugin from the Fuel Plugins Catalog.

  2. Copy the plugin file to the Fuel Master node. Follow the Quick start guide if you don't have a running Fuel Master node yet.

    scp elasticsearch_kibana-0.7-0.7.0-0.noarch.rpm root@<Fuel Master node IP address>:
    
  3. Install the plugin using the fuel command line:

    fuel plugins --install elasticsearch_kibana-0.7-0.7.0-0.noarch.rpm
    
  4. Verify that the plugin is installed correctly:

    fuel plugins --list
    

Please refer to the Fuel Plugins wiki if you want to build the plugin by yourself. Version 2.0.0 (or higher) of the Fuel Plugin Builder is required.

User Guide

Elasticsearch-Kibana plugin configuration

  1. Create a new environment with the Fuel UI wizard.
  2. Add a node with the "Operating System" role.
  3. Before applying changes or once changes applied, edit the name of the node by clicking on "Untitled (xx:yy)" and modify it for "elasticsearch".
  4. Click on the Settings tab of the Fuel web UI.
  5. Scroll down the page, select the "Elasticsearch-Kibana Server plugin" checkbox and fill-in the required fields.

You can select up to 3 physical disks that will be mounted as a single logical volume to store the Elasticsearch data. If you specify no disk, the data will be stored on the root filesystem. In all cases, Elasticsearch data will be located in the /opt/es-data directory.

For each disk, you can also specify the allocated size (in GB). If you don't specify a value, the plugin will use all the free space of the disk.

Testing

Elasticsearch

Once installed, you can check that Elasticsearch is working using curl:

curl http://$HOST:9200/

Where HOST is the IP address or the name of the node that runs the server.

The expected output is something like this:

{
  "status" : 200,
  "name" : "node-23-es-01",
  "cluster_name" : "elasticsearch",
  "version" : {
    "number" : "1.4.4",
    "build_hash" : "c88f77ffc81301dfa9dfd81ca2232f09588bd512",
    "build_timestamp" : "2015-02-19T13:05:36Z",
    "build_snapshot" : false,
    "lucene_version" : "4.10.3"
  },
  "tagline" : "You Know, for Search"
}

Kibana

The Kibana user interface is available at the following URL:

http://$HOST/

Where HOST is the IP address or the name of the node. By default, you will be redirected to the logs dashboard.

Known issues

None.

Release Notes

0.7.0

  • Initial release of the plugin. This is a beta version.

Contributors