elasticsearch

Overview Versions Insights

williamyeh.elasticsearch for Ansible Galaxy

Summary

Role name in Ansible Galaxy: williamyeh.elasticsearch

This Ansible role has the following features for Elasticsearch:

Install Elasticsearch.
Specify heap size and G1GC for JVM, if requested.
Install plugins (standard and 3rd party).
Bare bone configuration (real configuration should be left to user's template files; see Usage section below).

Role Variables

Mandatory variables

Variables needed to be defined in user's playbook:

elasticsearch_version

Optional variables

User-installable configuration files (by Ansible's template system):

# conf file (usually elasticsearch.yml) to be installed,
# relative to `playbook_dir`;
# the file will be copied verbatim
elasticsearch_conf_copy

# conf file (usually elasticsearch.yml.j2) to be installed,
# relative to `playbook_dir`;
# the file will be copied through Ansible's template system
elasticsearch_conf_template

User-installable plugins:

# an array of plugins (registered in elasticsearch.org) to be installed.
# @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-plugins.html
elasticsearch_plugins

# an array of other plugins to be installed.
# each item in the array should have at least the following keys:
#  - "name", the plugin name excluding the ".jar" substring.
#  - "url", pointing to the url of the jar file.
elasticsearch_other_plugins

User-configurable defaults:

# use G1GC for JVM?
elasticsearch_use_g1gc: false


# JVM heap size for Elasticsearch
elasticsearch_heap_size

Handlers

restart elasticsearch
stop elasticsearch

Usage

Step 1: add role

Add role name williamyeh.elasticsearch to your playbook file.

Step 2: add variables

Set vars in your playbook file.

Simple example:

---
# file: simple-playbook.yml

- hosts: all

  roles:
    - williamyeh.oracle-java
    - williamyeh.elasticsearch

  vars:
    elasticsearch_version: 1.6.0

Step 3: tune JVM memory, if necessary

---
- hosts: all

  roles:
    - williamyeh.oracle-java
    - williamyeh.elasticsearch

  vars:
    elasticsearch_version: 1.4.2

    elasticsearch_use_g1gc: true
    elasticsearch_heap_size: 6g

Step 4: copy user's config file, install plugins, etc., if necessary

More practical example:

---
# file: complex-playbook.yml

- hosts: all

  roles:
    - williamyeh.oracle-java
    - williamyeh.elasticsearch

  vars:
    elasticsearch_version: 1.4.2

    elasticsearch_plugins:
      - elasticsearch/marvel/latest
      - lmenezes/elasticsearch-kopf

    elasticsearch_other_plugins:
      - name: analysis-ik
        url:  https://github.com/medcl/elasticsearch-rtf/raw/master/plugins/analysis-ik/elasticsearch-analysis-ik-1.2.6.jar
        memo: https://github.com/medcl/elasticsearch-analysis-ik

    #-- copy verbatim
    elasticsearch_conf_copy: "files/elasticsearch.yml"

    #-- copy through Ansible's template system
    #elasticsearch_conf_template: "templates/elasticsearch.yml.j2"