santerikainulainen/ansible-role-elasticsearch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #376 from gingerwizard/master

Browse source 
README corrections
This commit is contained in:
Dale McDiarmid 2017-09-14 16:36:30 +01:00 • committed by GitHub
commit 57fbed33cf
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -22,13 +22,13 @@ e.g.
``` ```
cd /my/repos/ cd /my/repos/
git https://github.com/elastic/ansible-elasticsearch.git git clone https://github.com/elastic/ansible-elasticsearch.git
cd /my/ansible/playbook cd /my/ansible/playbook
mkdir -p roles mkdir -p roles
ln -s /my/repos/ansible-elasticsearch ./roles/elasticsearch ln -s /my/repos/ansible-elasticsearch ./roles/elasticsearch
``` ```
Then create your playbook yaml adding the role elasticsearch. By default, the user is only required to specify a unique es_instance_name per role application. This should be unique per node. Then create your playbook yaml adding the role elasticsearch. By default, the user is only required to specify a unique es_instance_name per role application. This should be unique per node.
The application of the elasticsearch role results in the installation of a node on a host. The application of the elasticsearch role results in the installation of a node on a host.
The simplest configuration therefore consists of: The simplest configuration therefore consists of:
@ -79,7 +79,7 @@ The following illustrates applying configuration parameters to an Elasticsearch
es_api_port: 9201 es_api_port: 9201
``` ```
The role utilises Elasticsearch version defaults. The following should be set to ensure a successful cluster forms. Whilst the role installs Elasticsearch with the default configuration parameters, the following should be configured to ensure a cluster successfully forms:
* ```es_config['http.port']``` - the http port for the node * ```es_config['http.port']``` - the http port for the node
* ```es_config['transport.tcp.port']``` - the transport port for the node * ```es_config['transport.tcp.port']``` - the transport port for the node
@ -340,7 +340,7 @@ In addition to es_config, the following parameters allow the customization of th
* ```es_plugins``` an array of plugin definitions e.g.: * ```es_plugins``` an array of plugin definitions e.g.:
```yml ```yml
es_plugins: es_plugins:
- plugin: elasticsearch-cloud-aws - plugin: ingest-geoip
``` ```
* ```es_allow_downgrades``` For development purposes only. (true or false (default) ) * ```es_allow_downgrades``` For development purposes only. (true or false (default) )
* ```es_java_install``` If set to false, Java will not be installed. (true (default) or false) * ```es_java_install``` If set to false, Java will not be installed. (true (default) or false)
@ -384,7 +384,7 @@ To define proxy only for a particular plugin during its installation:
``` ```
es_plugins: es_plugins:
- plugin: elasticsearch-cloud-aws - plugin: ingest-geoip
proxy_host: proxy.example.com proxy_host: proxy.example.com
proxy_port: 8080 proxy_port: 8080
``` ```