From 028cedf1f467556ba8827ff8d48770cc77b45ddb Mon Sep 17 00:00:00 2001 From: Jason Tedor Date: Thu, 6 Dec 2018 15:03:24 -0500 Subject: [PATCH 1/2] Add docs on replicating APM Server or Beats indices This commit adds a brief note to the documentation on how to manage the index templates that are used to create APM Server and Beats indices. --- docs/reference/ccr/requirements.asciidoc | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/reference/ccr/requirements.asciidoc b/docs/reference/ccr/requirements.asciidoc index 57f3f59eb354a..00800ddcc0f37 100644 --- a/docs/reference/ccr/requirements.asciidoc +++ b/docs/reference/ccr/requirements.asciidoc @@ -42,4 +42,25 @@ The number of soft deletes to retain. Soft deletes are collected during merges on the underlying Lucene index yet retained up to the number of operations configured by this setting. The default value is `0`. -For more information about index settings, see {ref}/index-modules.html[Index modules]. \ No newline at end of file +For more information about index settings, see {ref}/index-modules.html[Index modules]. + +[float] +[[ccr-overview-beats]] +==== Setting soft deletes on indices created by APM Server or Beats + +If you want to replicate indices created by APM Server or Beats, and are +allowing APM Server or Beats to manage index templates you will want to add some +settings to enable soft deletes. For example, you could make the following +changes to the relevant APM Server or Beats configuration file. + +["source","yaml"] +---------------------------------------------------------------------- +setup.template.overwrite: true +setup.template.settings: + index.soft_deletes.enabled: true + index.soft_deletes.retention.operations: 1024 +---------------------------------------------------------------------- + +For additional information on controlling the index templates managed by APM +Server or Beats, see the relevant documentation on loading the Elasticsearch +index template. From f807f7ba5fd09ac8c52f2f5e9ba32be6a42a545d Mon Sep 17 00:00:00 2001 From: Jason Tedor Date: Thu, 6 Dec 2018 15:56:57 -0500 Subject: [PATCH 2/2] Reword based on feedback --- docs/reference/ccr/requirements.asciidoc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/reference/ccr/requirements.asciidoc b/docs/reference/ccr/requirements.asciidoc index 00800ddcc0f37..14ac66a8b9c2f 100644 --- a/docs/reference/ccr/requirements.asciidoc +++ b/docs/reference/ccr/requirements.asciidoc @@ -49,9 +49,10 @@ For more information about index settings, see {ref}/index-modules.html[Index mo ==== Setting soft deletes on indices created by APM Server or Beats If you want to replicate indices created by APM Server or Beats, and are -allowing APM Server or Beats to manage index templates you will want to add some -settings to enable soft deletes. For example, you could make the following -changes to the relevant APM Server or Beats configuration file. +allowing APM Server or Beats to manage index templates, you need to enable +soft deletes on the underlying index templates. To enable soft deletes on the +underlying index templates, add the following changes to the relevant APM Server +or Beats configuration file. ["source","yaml"] ----------------------------------------------------------------------