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.

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

Emphasize the importance of having snapshot #8051

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

kunisen
Copy link
Contributor

@kunisen kunisen commented Sep 13, 2024

:: Reason for the PR

We have seen many master pods got lost thus having to repair the whole cluster use cases, and we'd like to emphasize the importance about having snapshot to call out it explicitly clear.

:: After merge:

Orange part will be added

image

Text is something similar from ESS - https://www.elastic.co/guide/en/cloud/current/ec-snapshot-restore.html

Snapshots are an efficient way to ensure that your Elasticsearch indices can be recovered in the event of an accidental deletion, or to migrate data across deployments.

But we don't say "deployment" in ECK so I used clusters.

kunisen and others added 2 commits September 13, 2024 16:43
We have seen many master pods got lost thus having to repair the whole cluster use cases, and we'd like to emphasize the importance about having snapshot to call out it explicitly clear.
@kunisen kunisen added the >docs Documentation label Sep 13, 2024
@@ -8,6 +8,8 @@ endif::[]
[id="{p}-{page_id}"]
= Create automated snapshots

NOTE: Snapshots are important to ensure that your Elasticsearch indices can be recovered in the event of an accidental deletion, or to migrate data across clusters.
Copy link
Contributor

Choose a reason for hiding this comment

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

It's up to you to decide, but here's another suggestion that's a little more direct and concise.

Suggested change
NOTE: Snapshots are important to ensure that your Elasticsearch indices can be recovered in the event of an accidental deletion, or to migrate data across clusters.
NOTE: Snapshots are essential for recovering Elasticsearch indices in case of accidental deletion or for migrating data between clusters.

@@ -8,6 +8,8 @@ endif::[]
[id="{p}-{page_id}"]
= Create automated snapshots

NOTE: Snapshots are important to ensure that your Elasticsearch indices can be recovered in the event of an accidental deletion, or to migrate data across clusters.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we have this note as a header of the "Run Elasticsearch on ECK" section here. I'm asking because my feeling is that if someone is looking at the snapshot documentation then it may mean that this person is already aware that it's an important topic (or maybe because it's too late 🙃 )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants