Skip to content

Commit e7518fb

Browse files
authored
Adds a warning about manually mounting snapshots managed by ILM (#111883)
* Adds a warning about manually mounting snapshots managed by ILM * Shortens text and moves the warning to Searchable snapshots chapter
1 parent 2261883 commit e7518fb

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ For more information, see <<security-privileges>>.
2323
[[searchable-snapshots-api-mount-desc]]
2424
==== {api-description-title}
2525

26+
This API mounts a snapshot as a searchable snapshot index.
27+
Note that manually mounting {ilm-init}-managed snapshots can <<manually-mounting-snapshots,interfere>> with <<index-lifecycle-management,{ilm-init} processes>>.
2628

2729
[[searchable-snapshots-api-mount-path-params]]
2830
==== {api-path-parms-title}

docs/reference/searchable-snapshots/index.asciidoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,17 @@ do not have a dedicated frozen tier, you must configure the
170170
cache on one or more nodes. Partially mounted indices are only allocated to
171171
nodes that have a shared cache.
172172

173+
[[manually-mounting-snapshots]]
174+
[WARNING]
175+
.Manual snapshot mounting
176+
====
177+
Manually mounting snapshots captured by an Index Lifecycle Management ({ilm-init}) policy can
178+
interfere with {ilm-init}'s automatic management. This may lead to issues such as data loss
179+
or complications with snapshot handling. For optimal results, allow {ilm-init} to manage
180+
snapshots automatically. If manual mounting is necessary, be aware of its potential
181+
impact on {ilm-init} processes. For more information, learn about <<index-lifecycle-management,{ilm-init} snapshot management>>.
182+
====
183+
173184
[[searchable-snapshots-shared-cache]]
174185
`xpack.searchable.snapshot.shared_cache.size`::
175186
(<<static-cluster-setting,Static>>)

0 commit comments

Comments
 (0)