Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/goldstrike77/ansible-role-linux-elasticsearch

Ansible role for install and configure Elasticsearch on Linux operating system.
https://github.com/goldstrike77/ansible-role-linux-elasticsearch

ansible ansible-role elasticsearch search-engine

Last synced: about 1 month ago
JSON representation

Ansible role for install and configure Elasticsearch on Linux operating system.

Awesome Lists containing this project

README 

        
![](https://img.shields.io/badge/Ansible-elasticsearch-green.svg?logo=angular&style=for-the-badge)



>__Please note that the original design goal of this role was more concerned with the initial installation and bootstrapping environment, which currently does not involve performing continuous maintenance, and therefore are only suitable for testing and development purposes,  should not be used in production environments. The author does not guarantee the accuracy, completeness, reliability, and availability of the role content. Under no circumstances will the author be held responsible or liable in any way for any claims, damages, losses, expenses, costs or liabilities whatsoever, including, without limitation, any direct or indirect damages for loss of profits, business interruption or loss of information.__



>__请注意，此角色的最初设计目标更关注初始安装和引导环境，目前不涉及执行连续维护，因此仅适用于测试和开发目的，不应在生产环境中使用。作者不对角色内容之准确性、完整性、可靠性、可用性做保证。在任何情况下，作者均不对任何索赔，损害，损失，费用，成本或负债承担任何责任，包括但不限于因利润损失，业务中断或信息丢失而造成的任何直接或间接损害。__

___






__Table of Contents__



- [Overview](#overview)

- [Requirements](#requirements)

  * [Operating systems](#operating-systems)

  * [Elasticsearch Versions](#Elasticsearch-versions)

- [ Role variables](#Role-variables)

  * [Main Configuration](#Main-parameters)

  * [Other Configuration](#Other-parameters)

- [Dependencies](#dependencies)

- [Example Playbook](#example-playbook)

  * [Hosts inventory file](#Hosts-inventory-file)

  * [Vars in role configuration](#vars-in-role-configuration)

  * [Combination of group vars and playbook](#combination-of-group-vars-and-playbook)

- [License](#license)

- [Author Information](#author-information)

- [Donations](#Donations)



## Overview

Elasticsearch is the living heart of what is today’s the most popular log analytics platform — the ELK Stack (Elasticsearch, Logstash and Kibana). Elasticsearch’s role is so central that it has become synonymous with the name of the stack itself. Elasticsearch is a search engine based on the Lucene library. It provides a distributed, multitenant-capable full-text search engine with an HTTP web interface and schema-free JSON documents. Completely open source and built with Java, Elasticsearch is a NoSQL database. That means it stores data in an unstructured way and that you cannot use SQL to query it. In the context of data analysis, Elasticsearch is used together with the other components in the ELK Stack, Logstash and Kibana, and plays the role of data indexing and storage.



## Requirements

### Operating systems

This Ansible role installs Elasticsearch on Linux operating system, including establishing a filesystem structure and server configuration with some common operational features, Will works on the following operating systems:



  * CentOS 7



### Elasticsearch versions



The following list of supported the Elasticsearch releases:



* Elasticsearch 6.8+, 7.1+



## Role variables

### Main parameters #

There are some variables in defaults/main.yml which can (Or needs to) be overridden:



##### General parameters

* `elastic_cluster`: Specify name for your cluster name.

* `elastic_version`: Specify the Elasticsearch version.

* `elastic_path`: Specify the Elasticsearch data directory.

* `elastic_auth`: A boolean to determine whether or not enable authentication.

* `elastic_pass`: Authorization password.

* `elastic_https`: A boolean to determine whether or not Encrypting HTTP client communications.

* `elastic_heap_size`: Specify the maximum memory allocation pool for a Java virtual machine.

* `elastic_memory_lock`: A boolean to determine whether or not lock the process address space into memory on startup.

* `elastic_node_type`: Type of nodes: default, master, data, ingest and coordinat.



##### Listen port

* `elastic_port_rest`: Elasticsearch REST port.

* `elastic_port_transport`: Elasticsearch transport port ragne.

* `elastic_port_exporter`: Prometheus Elasticsearch Exporter port.



##### Server System Variables

* `elastic_arg.action_destructive_requires_name`: Restricts deletions to specific names, instead of allowing the special _all or wildcard options.

* `elastic_arg.cluster_max_shards_per_node`: Controls the number of shards allowed in the cluster per data node.

* `elastic_arg.http_compression`: Compression when possible with Accept-Encoding.

* `elastic_arg.http_cors_enabled`: Enable or disable cross-origin resource sharing.

* `elastic_arg.http_cors_allow_methods`: Which methods to allow.



##### Service Mesh

* `environments`: Define the service environment.

* `datacenter`: Define the DataCenter.

* `domain`: Define the Domain.

* `customer`: Define the customer name.

* `tags`: Define the service custom label.

* `exporter_is_install`: Whether to install prometheus exporter.

* `consul_public_register`: Whether register a exporter service with public consul client.

* `consul_public_exporter_token`: Public Consul client ACL token.

* `consul_public_http_prot`: The consul Hypertext Transfer Protocol.

* `consul_public_clients`: List of public consul clients.

* `consul_public_http_port`: The consul HTTP API port.



### Other parameters

There are some variables in vars/main.yml:



## Dependencies

- Ansible versions >= 2.8

- Python >= 2.7.5



## Example



### Hosts inventory file

See tests/inventory for an example.



    [syslog]

    node01 ansible_host='192.168.1.10'

    node02 ansible_host='192.168.1.11'

    node03 ansible_host='192.168.1.12'



    [syslog:vars]

    elastic_cluster='siem'

    elastic_version='7.11.2'



### Vars in role configuration

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:



```yaml

- hosts: all

  roles:

     - role: ansible-role-linux-elasticsearch

       elastic_cluster: 'siem'

```



### Combination of group vars and playbook

You can also use the group_vars or the host_vars files for setting the variables needed for this role. File you should change: group_vars/all or host_vars/`group_name`.



```yaml

elastic_cluster: 'siem'

elastic_version: '7.11.2'

elastic_path: '/data'

elastic_auth: true

elastic_pass: 'changeme'

elastic_https: true

elastic_heap_size: 4g'

elastic_memory_lock: false

elastic_node_type: 'default'

elastic_port_rest: '9200'

elastic_port_transport: '9300'

elastic_port_exporter: '9108'

elastic_arg:

  action_destructive_requires_name: true

  cluster_max_shards_per_node: '10000'

  http_compression: true

  http_cors_enabled: true

  http_cors_allow_methods: 'HEAD, GET, POST, PUT, DELETE'

environments: 'prd'

datacenter: 'dc01'

domain: 'local'

customer: 'demo'

tags:

  subscription: 'default'

  owner: 'nobody'

  department: 'Infrastructure'

  organization: 'The Company'

  region: 'China'

exporter_is_install: false

consul_public_register: false

consul_public_exporter_token: '00000000-0000-0000-0000-000000000000'

consul_public_http_prot: 'https'

consul_public_http_port: '8500'

consul_public_clients:

  - '127.0.0.1'

```



## License

![](https://img.shields.io/badge/MIT-purple.svg?style=for-the-badge)



## Author Information

Please send your suggestions to make this role better.



## Donations

Please donate to the following monero address.



    46CHVMbb6wQV2PJYEbahb353SYGqXhcdFQVEWdCnHb6JaR5125h3kNQ6bcqLye5G7UF7qz6xL9qHLDSAY3baagfmLZABz75