Skip to content

Add warning about restart migration #116769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 14, 2024
Merged

Add warning about restart migration #116769

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1bbd571
Add warning about restart migration
bcully Nov 13, 2024
f401d30
Merge branch 'main' of github.com:elastic/elasticsearch into doc-snap…
bcully Nov 14, 2024
d1950c5
PR feedback on doc update
bcully Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/reference/searchable-snapshots/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,10 +176,10 @@ nodes that have a shared cache.
====
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.
or complications with snapshot handling.

For optimal results, allow {ilm-init} to manage
snapshots automatically.
snapshots automatically.

<<ilm-searchable-snapshot,Learn more about {ilm-init} snapshot management>>.
====
Expand Down Expand Up @@ -293,6 +293,14 @@ repository. If you wish to search data across multiple regions, configure
multiple clusters and use <<modules-cross-cluster-search,{ccs}>> or
<<xpack-ccr,{ccr}>> instead of {search-snaps}.

It's worth noting that if a searchable snapshot index has no replicas (as is the default
in the cold tier), then when the node hosting it is shut down, allocation will immediately
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer to avoid the default mention in this section, we speak of replicas just above this section.

Suggested change
It's worth noting that if a searchable snapshot index has no replicas (as is the default
in the cold tier), then when the node hosting it is shut down, allocation will immediately
It's worth noting that if a searchable snapshot index has no replicas, then when the node hosting it is shut down, allocation will immediately

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

try to relocate the index to a new node in order to maximize availability. For fully mounted
indices this will result in the new node downloading the entire index snapshot from
the cloud repository, which might be expensive especially during rolling restarts. Temporarily
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we generally expect those costs to be very low and only exceptionally for it to have real cost implications, so I'd like to remove the cost mention:

Suggested change
the cloud repository, which might be expensive especially during rolling restarts. Temporarily
the cloud repository. Temporarily

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

disabling allocation during planned node restart will prevent this, as described in
the <<restart-cluster-rolling,cluster restart procedure>>.

[discrete]
[[back-up-restore-searchable-snapshots]]
=== Back up and restore {search-snaps}
Expand Down
Loading