Skip to content
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

Adds a warning about manually mounting snapshots managed by ILM #111883

Merged
merged 2 commits into from
Aug 15, 2024
Merged

Adds a warning about manually mounting snapshots managed by ILM #111883

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2f0bf6
Adds a warning about manually mounting snapshots managed by ILM
kosabogi Aug 14, 2024
d752f9e
Shortens text and moves the warning to Searchable snapshots chapter
kosabogi Aug 15, 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
13 changes: 13 additions & 0 deletions docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@

Mount a snapshot as a searchable snapshot index.

WARNING: Manual Snapshot Mounting
====
When manually mounting a snapshot that was captured by an Index Lifecycle Management (ILM) policy, be aware of the following:
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think you can set the title this way. it ends up just putting this sentence in the note block:

image

I think what you want is this

Suggested change
WARNING: Manual Snapshot Mounting
====
When manually mounting a snapshot that was captured by an Index Lifecycle Management (ILM) policy, be aware of the following:
[WARNING]
====
**Manual snapshot mounting**


* **ILM Managed Snapshots:** Snapshots taken by ILM policies are handled automatically by ILM. If you manually mount these snapshots, it can interfere with ILM's automated processes, such as managing or deleting snapshots.

* **Potential Issues:** Manually mounting a snapshot can disrupt ILM actions, like deletions or phase transitions. This can lead to data loss or complications in managing your snapshots.

* **Best Practice:** It's best to let ILM manage your snapshots. If you must manually mount a snapshot, make sure you understand how this affects ILM and manage the snapshot lifecycle separately.

Always review the documentation and consider the impact on your data management before manually handling snapshots managed by ILM.
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 like to see this formatted as prose rather than broken down like this. there also seems to be overlap between all of the paragraph content so you could slim this down. it will have an added benefit of making the warning much less scary looking.

consider also shrinking this to "don't use this for snapshots taken by ILM policies. [Learn more]" and linking out to the docs around how ILM snapshots are managed (and maybe adding these considerations there).

finally, we prefer sentence case headings over title case headings. see style guide :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the feedback!
I’ve shortened the warning to make it clearer and fixed the formatting issues. I encountered some difficulties with the local build but have resolved those issues now thanks to @szabosteve :)
Based on Dave's feedback, I’ve moved the warning to the section about Searchable Snapshots, where it complements the existing information. In the Mount API description, I’ve added a brief note that links to the warning for further details.

====

[[searchable-snapshots-api-mount-request]]
==== {api-request-title}

Expand Down
Loading