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

[DOCS] Convert 'Restore a snapshot' to tutorial #76929

Merged
merged 43 commits into from
Sep 20, 2021
Merged

[DOCS] Convert 'Restore a snapshot' to tutorial #76929

merged 43 commits into from
Sep 20, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Aug 25, 2021

Updates the `Restore a snapshot` guide to be more tutorial-focused. The current
page duplicates reference content from the restore snapshot API docs.

I plan to add a tutorial for restoring a full cluster in a later PR.
@jrodewig jrodewig added :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes v7.14.1 v7.15.1 v7.16.0 labels Aug 25, 2021
@jrodewig jrodewig marked this pull request as ready for review August 25, 2021 17:28
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. labels Aug 25, 2021
@elasticmachine
Copy link
Collaborator

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

@elasticmachine
Copy link
Collaborator

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

@jrodewig jrodewig added the auto-backport Automatically create backport pull requests when merged label Aug 25, 2021
@jrodewig
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/precommit

@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

@jrodewig
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/precommit

@jrodewig jrodewig added auto-backport-and-merge and removed auto-backport Automatically create backport pull requests when merged labels Aug 25, 2021
@martijnvg martijnvg added v7.14.2 and removed v7.14.1 labels Aug 26, 2021
@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

@jrodewig
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs-check

@jrodewig
Copy link
Contributor Author

Going to merge this in. Thanks for the reviews and feedback, everyone!

@jrodewig jrodewig merged commit 2fc3d40 into elastic:master Sep 20, 2021
@jrodewig jrodewig deleted the docs__restore-snapshot-tut branch September 20, 2021 17:17
@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
7.x Commit could not be cherrypicked due to conflicts
7.15 Commit could not be cherrypicked due to conflicts
7.14 Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 76929

@jrodewig
Copy link
Contributor Author

jrodewig commented Sep 20, 2021

Turns out Kibana links to https://www.elastic.co/guide/en/elasticsearch/reference/7.14/snapshots-restore-snapshot.html#change-index-settings-during-restore, which was removed with this PR.

I've opened elastic/kibana#112597 to update the link in Kibana. However, that means I'll only backport this change to 7.x (7.16) and master (8.0), not 7.15 or 7.14.

jrodewig added a commit to elastic/kibana that referenced this pull request Sep 21, 2021
Updates the docs help link for index settings  in the Snapshot and Restore feature.

Currently, the link points to https://www.elastic.co/guide/en/elasticsearch/reference/7.14/snapshots-restore-snapshot.html#change-index-settings-during-restore, which primarily documents related restore snapshot API parameters.

With elastic/elasticsearch#76929, this section was removed. The new link covers all available index settings, which is a bit more relevant.
jrodewig added a commit to elastic/kibana that referenced this pull request Sep 21, 2021
Updates the docs help link for index settings  in the Snapshot and Restore feature.

Currently, the link points to https://www.elastic.co/guide/en/elasticsearch/reference/7.14/snapshots-restore-snapshot.html#change-index-settings-during-restore, which primarily documents related restore snapshot API parameters.

With elastic/elasticsearch#76929, this section was removed. The new link covers all available index settings, which is a bit more relevant.
jrodewig added a commit that referenced this pull request Sep 21, 2021
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 pull request Oct 6, 2021
Fixes a couple of erroneous references related to system indices in the snapshot restore tutorial:

* Calling the delete index API on `*` will only delete
  some system indices, such as the `.security`. It won't delete others, such as
  `.geoip_databases`.

* Not all dot indices are system indices. Some are just hidden indices.

Relates to #76929
elasticsearchmachine pushed a commit that referenced this pull request Oct 6, 2021
Fixes a couple of erroneous references related to system indices in the snapshot restore tutorial:

* Calling the delete index API on `*` will only delete
  some system indices, such as the `.security`. It won't delete others, such as
  `.geoip_databases`.

* Not all dot indices are system indices. Some are just hidden indices.

Relates to #76929
# Conflicts:
#	docs/reference/snapshot-restore/restore-snapshot.asciidoc
@jrodewig jrodewig added v7.15.2 and removed v7.15.2 labels Oct 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 v7.16.0 v8.0.0-beta1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Add more info on Snapshot Restore process