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

Jump to bottom

[Docs] Add more info on Snapshot Restore process #72497

Closed
stefnestor opened this issue Apr 29, 2021 · 6 comments · Fixed by #76929
Closed

[Docs] Add more info on Snapshot Restore process #72497

stefnestor opened this issue Apr 29, 2021 · 6 comments · Fixed by #76929
Assignees
@jrodewig
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team

Comments

@stefnestor
Copy link
Contributor

@jrodewig / team - I'd like to recommend adding into docs the two most common methods of using your docs to restore snapshots (delete and restore, or restore side-by-side and then delete).

Outlined here: https://medium.com/@stefnestor/tldr-elasticsearch-snapshot-restore-7b72dd75d74a

(It does include some non-documented but working Elasticsearch URLs, hope that's ok.)

Thanks for the great work you do!
@stefnestor stefnestor added >docs General docs changes :Docs Team:Docs Meta label for docs team labels Apr 29, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@jrodewig
Copy link
Contributor

jrodewig commented Apr 29, 2021 •
edited
Loading

(It does include some non-documented but working Elasticsearch URLs, hope that's ok.)

That's a-okay. That's likely a content gap on our end. Thanks for raising this @stefnestor!

@jrodewig jrodewig added :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs and removed :Docs labels Apr 29, 2021
@elasticmachine elasticmachine added the Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. label Apr 29, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@stefnestor
Copy link
Contributor Author

Also for full cluster restores, I've been recommended to turn off Kibana, ML, ILM, & SLM.

  • ILM
  • Kibana: stop service on local machine, in ESS "stop routing requests" (not fully necessary maybe unless you have users doing heavy search requests)
  • SLM: start & stop
  • ML

@jrodewig jrodewig self-assigned this Aug 16, 2021
@jrodewig
Copy link
Contributor

It looks like we already document full cluster restores in Back up a cluster. However, we don't mention stopping ILM, Kibana, SLM, or ML. We could probably also streamline those docs a bit and cross-link from the snapshot and restore section.

@jrodewig jrodewig mentioned this issue Aug 25, 2021
Merged
@jrodewig
Copy link
Contributor

#72497 covers how to restore an index/data stream from a snapshot.

I'll raise another PR for the full cluster restore docs once that's merged.

jrodewig added a commit that referenced this issue Sep 20, 2021
@jrodewig
[DOCS] Convert 'Restore a snapshot' to tutorial (#76929)
2fc3d40 
Updates the 'Restore a snapshot' guide to be more tutorial-focused.
Adds a tutorial for restoring an entire cluster.

Closes #72497.
jrodewig added a commit that referenced this issue Sep 21, 2021
@jrodewig
[DOCS] Convert 'Restore a snapshot' to tutorial (#76929) (#78021)
11b429d 
Updates the 'Restore a snapshot' guide to be more tutorial-focused.
Adds a tutorial for restoring an entire cluster.

Closes #72497.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jrodewig jrodewig

Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOCS] Convert 'Restore a snapshot' to tutorial
3 participants
@elasticmachine @stefnestor @jrodewig