Kibana role: Updating README.md

This commit is contained in:
Miguelangel Freitas 2017-07-13 08:49:03 -04:00
parent 3241258836
commit bda913238b

View File

@ -1,40 +1,48 @@
# Ansible Role: Elasticsearch
Ansible Role: Kibana for ELK Stack
------------------------------------
An Ansible Role that installs [Kibana](https://www.elastic.co/products/kibana) and [Wazuh APP](https://github.com/wazuh/wazuh-kibana-app).
An Ansible Role that installs Kibana and WazuhAPP on 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
Available variables are listed below, along with default values (see `vars/main.yml`):
```
---
elasticsearch_http_port: "9200"
elasticsearch_network_host: "127.0.0.1"
kibana_server_host: "0.0.0.0"
kibana_server_port: "5601"
elk_stack_version: 5.4.0
```
elasticsearch_network_host: localhost
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.
elasticsearch_http_port: 9200
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`.
## Example Playbook
- hosts: search
```
- hosts: kibana
roles:
- geerlingguy.java
- geerlingguy.elasticsearch
- { role: ansible-role-kibana, elasticsearch_network_host: '192.168.33.182' }
```
## License
License and copyright
---------------------
MIT / BSD
WAZUH Copyright (C) 2017 Wazuh Inc. (License GPLv3)
## Author Information
### Based on previous work from geerlingguy
This role was created in 2014 by [Jeff Geerling](https://www.jeffgeerling.com/), author of [Ansible for DevOps](https://www.ansiblefordevops.com/).
- https://github.com/geerlingguy/ansible-role-elasticsearch
## Modified
### Modified by Wazuh
The playbooks have been modified by Wazuh, Inc, including some specific requirements, templates and configuration for integrating Elastic Stack and Wazuh ecosystem.
The playbooks have been modified by Wazuh, including some specific requirements, templates and configuration to improve integration with Wazuh ecosystem.