Elasticseach role: Updating README.md

This commit is contained in:
Miguelangel Freitas 2017-07-12 19:08:50 -04:00
parent 32a1dfc3d4
commit 6589384a9b

View File

@ -1,45 +1,50 @@
# Ansible Role: Elasticsearch Ansible Role: Elasticsearch
===========================
An Ansible Role that installs [Elasticsearch](https://www.elastic.co/products/elasticsearch).
An Ansible Role that installs Elasticsearch RedHat/CentOS. Requirements
------------
## Requirements This role will work on:
* Red Hat
* CentOS
* Fedora
* Debian
* Ubuntu
Requires at least Java 8 (Java 8+ preferred). Role Variables
--------------
## Role Variables Defaults variables are listed below, along with its values (see `defaults/main.yml`):
Available variables are listed below, along with default values (see `vars/main.yml`):
elasticsearch_cluster_name: wazuh ```
elasticsearch_node_name: node-1 elasticsearch_cluster_name: wazuh
elasticsearch_http_port: 9200 elasticsearch_node_name: node-1
elasticsearch_network_host: 192.168.33.182 elasticsearch_http_port: 9200
elasticsearch_jvm_xms: 1g elasticsearch_network_host: 127.0.0.1
elasticsearch_jvm_xms: 1g
elk_stack_version: 5.4.0
```
Example Playbook
----------------
Network host to listen for incoming connections on. By default we only listen on the localhost interface. Change this to the IP address to listen on a specific interface, or `0.0.0.0` to listen on all interfaces. ```
- hosts: elasticsearch
roles:
- { role: ansible-role-elasticsearch, elasticsearch_network_host: '192.168.33.182' }
```
elasticsearch_http_port: 9200 License and copyright
---------------------
Whether to allow inline scripting against ElasticSearch. You should read the following link as there are possible security implications for enabling these options: [Enable Dynamic Scripting](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html#enable-dynamic-scripting). Available options include: `true`, `false`, and `sandbox`. WAZUH Copyright (C) 2017 Wazuh Inc. (License GPLv3)
### Based on previous work from geerlingguy
- https://github.com/geerlingguy/ansible-role-elasticsearch
## Example Playbook ### Modified by Wazuh
- hosts: search The playbooks have been modified by Wazuh, including some specific requirements, templates and configuration to improve integration with Wazuh ecosystem.
roles:
- geerlingguy.java
- geerlingguy.elasticsearch
## License
MIT / BSD
## Author Information
This role was created in 2014 by [Jeff Geerling](https://www.jeffgeerling.com/), author of [Ansible for DevOps](https://www.ansiblefordevops.com/).
## Modified
The playbooks have been modified by Wazuh, Inc, including some specific requirements, templates and configuration for integrating Elastic Stack and Wazuh ecosystem.