X-Git-Url: https://gerrit.mcp.mirantis.com/gitweb?p=salt-formulas%2Felasticsearch.git;a=blobdiff_plain;f=README.rst;h=21be912a18760c1feb733382a56380f782839c13;hp=7e9ccce455e46e13bd84fe9b82ccb29cd43f5ca9;hb=1657066a170832505ff127e26384feba4ddbe476;hpb=911588c0a9c69234b52e26a8c37cfc66e4e42762;ds=sidebyside

diff --git a/README.rst b/README.rst
index 7e9ccce..21be912 100644
--- a/README.rst
+++ b/README.rst
@@ -24,6 +24,17 @@ Single-node elasticsearch with clustering disabled:
           shards: 1
           replicas: 0
 
+Setup shared repository for snapshots:
+
+.. code-block:: bash
+
+    elasticsearch:
+      server:
+        snapshot:
+          reponame:
+            path: /var/lib/glusterfs/repo
+            compress: true
+
 Cluster with manually defined members:
 
 .. code-block:: yaml
@@ -57,6 +68,7 @@ Common definition for curator:
           timeout: 900
           logfile: /var/log/elasticsearch/curator.log
           logformat: json
+          master_only: true
           actions:
             - action: delete_indices
               description: >-
@@ -119,6 +131,76 @@ Common definition for curator:
                   unit: days
                   unit_count: 2
 
+Client setup
+------------
+
+Client with host and port:
+
+.. code-block:: yaml
+
+    elasticsearch:
+      client:
+        enabled: true
+        server:
+          host: elasticsearch.host
+          port: 9200
+
+Client where you download an index template that is stored in the directory
+*files/*:
+
+.. code-block:: yaml
+
+    elasticsearch:
+      client:
+        enabled: true
+        server:
+          host: elasticsearch.host
+          port: 9200
+        index:
+          my_index:
+            enabled: true
+            template: elasticsearch/files/my_index_template.json
+
+Client where you download an index template from the metadata definition and force index creation:
+
+.. code-block:: yaml
+
+    elasticsearch:
+      client:
+        enabled: true
+        server:
+          host: elasticsearch.host
+          port: 9200
+        index:
+          my_index:
+            enabled: true
+            force_operation: true
+            definition:
+              template: notifications
+              settings:
+                number_of_shards: 5
+                number_of_replicas: 1
+              mappings:
+                notification:
+                  properties:
+                    applicationId:
+                      type: long
+                    content:
+                      type: text
+                      fields:
+                        keyword:
+                          type: keyword
+                          ignore_above: 256
+
+Upgrade operations
+------------------
+
+Default elasticsearch client state can only create index temlates. To update exisiting ones according to pillar dedicated state should be run explicitly:
+
+.. code-block:: bash
+
+    salt -C 'I@elasticsearch:client' state.sls elasticsearch.client.update_index_templates
+
 Read more
 =========