fuel-plugin-lma-collector/contrib/elasticsearch
Simon Pasquier d7c011d613 Fix ShellCheck warnings
This change fixes all problems reported by ShellCheck [1] which is a
nice linting tool for sh/bash scripts.

[1] http://www.shellcheck.net/about.html

Change-Id: I7104597e309fed5a4d52f5fc39ab0f4350fb3217
2015-05-07 10:11:02 +02:00
..
README.md s/ElasticSearch/Elasticsearch/ where appropriate 2015-04-23 15:50:06 +02:00
log_index_template.json Add contrib/ directory 2015-02-26 15:53:21 +01:00
notification_index_template.json Add contrib/ directory 2015-02-26 15:53:21 +01:00
run_container.sh Fix ShellCheck warnings 2015-05-07 10:11:02 +02:00

README.md

Description

Scripts and tools for running an Elasticsearch server to be used with the LMA collector.

Requirements

To run Elasticsearch, the host should have at least 1GB of free RAM. You also need sufficient free disk space for storing the data. The exact amount of disk depends highly on your environment and retention policy but 20GB is probably a sane minimum.

To store and query the data, clients need to be able to connect to the IP address of the container's host on the TCP port 9200.

Running

Simply:

$ ./run_container.sh

Use environment variables to override the default configuration:

$ ES_MEMORY=2 ./run_container.sh

Supported environment variables for configuration:

  • ES_LISTEN_ADDRESS: listen address on the container host (default=127.0.0.1)

  • ES_DATA: directory where to store the ES data and logs (default=~/es_volume)

  • ES_MEMORY: amount of memory (in GB) allocated to the JVM (default=16)

Testing

You can check that Elasticsearch is working using curl:

curl http://$HOST:9200/

Where HOST is the IP address or the name of the container's host.

The expected output is something like this:

{
  "status" : 200,
  "name" : "fuel.domain.tld",
  "cluster_name" : "elasticsearch",
  "version" : {
    "number" : "1.4.2",
    "build_hash" : "927caff6f05403e936c20bf4529f144f0c89fd8c",
    "build_timestamp" : "2014-12-16T14:11:12Z",
    "build_snapshot" : false,
    "lucene_version" : "4.10.2"
  },
  "tagline" : "You Know, for Search"
}