Skip to content

Commit a80eff1

Browse files
committed
Add docs on replicating APM Server or Beats indices (#36333)
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.
1 parent 35d510c commit a80eff1

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

docs/reference/ccr/requirements.asciidoc

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,26 @@ The number of soft deletes to retain. Soft deletes are collected during merges
4242
on the underlying Lucene index yet retained up to the number of operations
4343
configured by this setting. The default value is `0`.
4444

45-
For more information about index settings, see {ref}/index-modules.html[Index modules].
45+
For more information about index settings, see {ref}/index-modules.html[Index modules].
46+
47+
[float]
48+
[[ccr-overview-beats]]
49+
==== Setting soft deletes on indices created by APM Server or Beats
50+
51+
If you want to replicate indices created by APM Server or Beats, and are
52+
allowing APM Server or Beats to manage index templates, you need to enable
53+
soft deletes on the underlying index templates. To enable soft deletes on the
54+
underlying index templates, add the following changes to the relevant APM Server
55+
or Beats configuration file.
56+
57+
["source","yaml"]
58+
----------------------------------------------------------------------
59+
setup.template.overwrite: true
60+
setup.template.settings:
61+
index.soft_deletes.enabled: true
62+
index.soft_deletes.retention.operations: 1024
63+
----------------------------------------------------------------------
64+
65+
For additional information on controlling the index templates managed by APM
66+
Server or Beats, see the relevant documentation on loading the Elasticsearch
67+
index template.

0 commit comments

Comments
 (0)