Browse Source

Add guidance on using CCR with Logstash (#36609)

* Add guidance on using CCR with Logstash

This commit adds a note to the documentation regarding how to configure
Logstash indices in the context of being available as leader indices for
cross-cluster replication.

* Oh okay

* idk

* notconsole
Jason Tedor 6 years ago
parent
commit
692cff830a
1 changed files with 36 additions and 2 deletions
  1. 36 2
      docs/reference/ccr/requirements.asciidoc

+ 36 - 2
docs/reference/ccr/requirements.asciidoc

@@ -49,8 +49,8 @@ For more information about index settings, see {ref}/index-modules.html[Index mo
 If you want to replicate indices created by APM Server or Beats, and are
 allowing APM Server or Beats to manage index templates, you need to configure
 soft deletes on the underlying index templates. To configure soft deletes on the
-underlying index templates, add the following changes to the relevant APM Server
-or Beats configuration file.
+underlying index templates, incorporate the following changes to the relevant
+APM Server or Beats configuration file.
 
 ["source","yaml"]
 ----------------------------------------------------------------------
@@ -62,3 +62,37 @@ setup.template.settings:
 For additional information on controlling the index templates managed by APM
 Server or Beats, see the relevant documentation on loading the Elasticsearch
 index template.
+
+[float]
+[[ccr-overview-logstash]]
+==== Setting soft deletes on indices created by Logstash
+
+If you want to replicate indices created by Logstash, and are using Logstash to
+manage index templates, you need to configure soft deletes on a custom Logstash
+index template. To configure soft deletes on the underlying index template,
+incorporate the following change to a custom Logstash template.
+
+["source","js"]
+----------------------------------------------------------------------
+{
+  "settings" : {
+    "index.soft_deletes.retention.operations" : 1024
+  }
+}
+----------------------------------------------------------------------
+// NOTCONSOLE
+
+Additionally, you will need to configure the Elasticsearch output plugin to use
+this custom template.
+
+["source","ruby"]
+----------------------------------------------------------------------
+output {
+  elasticsearch {
+    template => "/path/to/custom/logstash/template.json"
+  }
+}
+----------------------------------------------------------------------
+
+For additional information on controlling the index templates managed by
+Logstash, see the relevant documentation on the Elasticsearch output plugin.