Skip to content

Commit 6bc1372

Browse files
Add docs on searchable snaps costs (#77607) (#77745)
* Add docs on searchable snaps costs Adds a note on why searchable snapshots is cheaper, including warnings that it might be more expensive too. * Split into sections Co-authored-by: James Rodewig <[email protected]> * data -> the shard contents * More wording tweaks * Apply suggestions from code review Co-authored-by: James Rodewig <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: James Rodewig <[email protected]>
1 parent d46c190 commit 6bc1372

File tree

2 files changed

+53
-4
lines changed

2 files changed

+53
-4
lines changed

docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,9 @@ the frozen phase, the action mounts a <<partially-mounted,partially mounted
1717
index>> to the frozen tier. In other phases, the action mounts a
1818
<<fully-mounted,fully mounted index>> to the corresponding data tier.
1919

20-
IMPORTANT: If the `searchable_snapshot` action is used in the hot phase the
21-
subsequent phases cannot include the `shrink`, `forcemerge`, or `freeze`
22-
actions.
20+
If the `searchable_snapshot` action is used in the hot phase the subsequent
21+
phases cannot include the `shrink`, `forcemerge`, or `freeze` actions.
2322

24-
[NOTE]
2523
This action cannot be performed on a data stream's write index. Attempts to do
2624
so will fail. To convert the index to a searchable snapshot, first
2725
<<manually-roll-over-a-data-stream,manually roll over>> the data stream. This
@@ -31,6 +29,12 @@ Using a policy that makes use of the <<ilm-rollover, rollover>> action
3129
in the hot phase will avoid this situation and the need for a manual rollover for future
3230
managed indices.
3331

32+
IMPORTANT: Mounting and relocating the shards of {search-snap} indices involves
33+
copying the shard contents from the snapshot repository. This may incur
34+
different costs from the copying between nodes that happens with regular
35+
indices. These costs are typically lower but, in some environments, may be
36+
higher. See <<searchable-snapshots-costs>> for more details.
37+
3438
By default, this snapshot is deleted by the <<ilm-delete, delete action>> in the delete phase.
3539
To keep the snapshot, set `delete_searchable_snapshot` to `false` in the delete action.
3640

docs/reference/searchable-snapshots/index.asciidoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,51 @@ node that does not have the <<data-frozen-node,`data_frozen`>> role, it will be
200200
is set to `0b`. Additionally, nodes with a shared cache can only have a single
201201
<<path-settings,data path>>.
202202

203+
[discrete]
204+
[[searchable-snapshots-costs]]
205+
=== Reduce costs with {search-snaps}
206+
207+
In most cases, {search-snaps} reduce the costs of running a cluster by removing
208+
the need for replica shards and for shard data to be copied between
209+
nodes. However, if it's particularly expensive to retrieve data from a snapshot
210+
repository in your environment, {search-snaps} may be more costly than
211+
regular indices. Ensure that the cost structure of your operating environment is
212+
compatible with {search-snaps} before using them.
213+
214+
[discrete]
215+
[[searchable-snapshots-costs-replicas]]
216+
==== Replica costs
217+
218+
For resiliency, a regular index requires multiple redundant copies of each shard
219+
across multiple nodes. If a node fails, {es} uses the redundancy to rebuild any
220+
lost shard copies. A {search-snap} index doesn't require replicas. If a node
221+
containing a {search-snap} index fails, {es} can rebuild the lost shard copy
222+
from the snapshot repository.
223+
224+
Without replicas, rarely-accessed {search-snap} indices require far fewer
225+
resources. A cold data tier that contains replica-free fully-mounted
226+
{search-snap} indices requires half the nodes and disk space of a tier
227+
containing the same data in regular indices. The frozen tier, which contains
228+
only partially-mounted {search-snap} indices, requires even fewer resources.
229+
230+
[discrete]
231+
[[snapshot-retrieval-costs]]
232+
==== Data transfer costs
233+
234+
When a shard of a regular index is moved between nodes, its contents are copied
235+
from another node in your cluster. In many environments, the costs of moving data
236+
between nodes are significant, especially if running in a Cloud environment with
237+
nodes in different zones. In contrast, when mounting a {search-snap} index or
238+
moving one of its shards, the data is always copied from the snapshot repository.
239+
This is typically much cheaper.
240+
241+
WARNING: Most cloud providers charge significant fees for data transferred
242+
between regions and for data transferred out of their platforms. You should only
243+
mount snapshots into a cluster that is in the same region as the snapshot
244+
repository. If you wish to search data across multiple regions, configure
245+
multiple clusters and use <<modules-cross-cluster-search,{ccs}>> or
246+
<<xpack-ccr,{ccr}>> instead of {search-snaps}.
247+
203248
[discrete]
204249
[[back-up-restore-searchable-snapshots]]
205250
=== Back up and restore {search-snaps}

0 commit comments

Comments
 (0)