X-Git-Url: https://gerrit.mcp.mirantis.com/gitweb?p=salt-formulas%2Felasticsearch.git;a=blobdiff_plain;f=README.rst;h=cc8cfdb7a39ff567b57c9f4fbdd225909bf4a69d;hp=0c7021fe964da360b522c1df7c46718a61f73981;hb=13fa94cd734fa3d7708dbcd61558c4a344d925db;hpb=63c8c25b95de6f4d545d3c918c1b045681d1d26b

diff --git a/README.rst b/README.rst
index 0c7021f..cc8cfdb 100644
--- a/README.rst
+++ b/README.rst
@@ -47,6 +47,108 @@ Cluster with manually defined members:
           shards: 5
           replicas: 1
 
+Common definition for curator:
+
+.. code-block:: yaml
+
+    elasticsearch:
+      server:
+        curator:
+          timeout: 900
+          logfile: /var/log/elasticsearch/curator.log
+          logformat: json
+          actions:
+            - action: delete_indices
+              description: >-
+                Delete indices older than 45 days (based on index name).
+                Ignore the error if the filter does not result in an actionable
+                list of indices (ignore_empty_list) and exit cleanly.
+              options:
+                ignore_empty_list: True
+                continue_if_exception: False
+                disable_action: False
+              filters:
+                - filtertype: pattern
+                  kind: regex
+                  value: '.*\-\d\d\d\d\.\d\d\.\d\d$'
+                - filtertype: age
+                  source: name
+                  direction: older
+                  timestring: '%Y.%m.%d'
+                  unit: days
+                  unit_count: 90
+            - action: replicas
+              description: >-
+                Reduce the replica count to 0 for indices older than 30 days
+                (based on index creation_date)
+              options:
+                count: 0
+                wait_for_completion: False
+                continue_if_exception: False
+                disable_action: False
+              filters:
+                - filtertype: pattern
+                  kind: regex
+                  value: '.*\-\d\d\d\d\.\d\d\.\d\d$'
+                - filtertype: age
+                  source: creation_date
+                  direction: older
+                  unit: days
+                  unit_count: 30
+            - action: forcemerge
+              description: >-
+                forceMerge indices older than 2 days (based on index
+                creation_date) to 2 segments per shard.  Delay 120 seconds
+                between each forceMerge operation to allow the cluster to
+                quiesce.
+                This action will ignore indices already forceMerged to the same
+                or fewer number of segments per shard, so the 'forcemerged'
+                filter is unneeded.
+              options:
+                max_num_segments: 2
+                delay: 120
+                continue_if_exception: False
+                disable_action: True
+              filters:
+                - filtertype: pattern
+                  kind: regex
+                  value: '.*\-\d\d\d\d\.\d\d\.\d\d$'
+                - filtertype: age
+                  source: creation_date
+                  direction: older
+                  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 direcotry
+*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
+
 Read more
 =========