Skip to content

Commit

Permalink
Adds a warning about manually mounting snapshots managed by ILM (elas…
Browse files Browse the repository at this point in the history
…tic#111883)

* Adds a warning about manually mounting snapshots managed by ILM

* Shortens text and moves the warning to Searchable snapshots chapter
  • Loading branch information
kosabogi authored and davidkyle committed Sep 5, 2024
1 parent 3e412ba commit 6798b2b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ For more information, see <<security-privileges>>.
[[searchable-snapshots-api-mount-desc]]
==== {api-description-title}

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

[[searchable-snapshots-api-mount-path-params]]
==== {api-path-parms-title}
Expand Down
11 changes: 11 additions & 0 deletions docs/reference/searchable-snapshots/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,17 @@ do not have a dedicated frozen tier, you must configure the
cache on one or more nodes. Partially mounted indices are only allocated to
nodes that have a shared cache.

[[manually-mounting-snapshots]]
[WARNING]
.Manual snapshot mounting
====
Manually mounting snapshots captured by an Index Lifecycle Management ({ilm-init}) policy can
interfere with {ilm-init}'s automatic management. This may lead to issues such as data loss
or complications with snapshot handling. For optimal results, allow {ilm-init} to manage
snapshots automatically. If manual mounting is necessary, be aware of its potential
impact on {ilm-init} processes. For more information, learn about <<index-lifecycle-management,{ilm-init} snapshot management>>.
====

[[searchable-snapshots-shared-cache]]
`xpack.searchable.snapshot.shared_cache.size`::
(<<static-cluster-setting,Static>>)
Expand Down

0 comments on commit 6798b2b

Please sign in to comment.