From d5a87cd647d9ffb8c49dacb636a396a7eca057b0 Mon Sep 17 00:00:00 2001 From: Dale McDiarmid Date: Thu, 14 Sep 2017 16:35:26 +0100 Subject: [PATCH] README corrections --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d01f3f0..de79c4f 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,13 @@ e.g. ``` cd /my/repos/ -git https://github.com/elastic/ansible-elasticsearch.git +git clone https://github.com/elastic/ansible-elasticsearch.git cd /my/ansible/playbook mkdir -p roles 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 simplest configuration therefore consists of: @@ -79,7 +79,7 @@ The following illustrates applying configuration parameters to an Elasticsearch 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['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.: ```yml es_plugins: - - plugin: elasticsearch-cloud-aws + - plugin: ingest-geoip ``` * ```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) @@ -384,7 +384,7 @@ To define proxy only for a particular plugin during its installation: ``` es_plugins: - - plugin: elasticsearch-cloud-aws + - plugin: ingest-geoip proxy_host: proxy.example.com proxy_port: 8080 ```