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] Overhaul snapshot and restore docs #79081

Merged
merged 45 commits into from
Nov 15, 2021
Merged

[DOCS] Overhaul snapshot and restore docs #79081

merged 45 commits into from
Nov 15, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Oct 13, 2021

Makes several changes to consolidate snapshot and backup-related docs.

Highlights:

  • Adds info about supported ESS snapshot repository types
  • Adds docs for Kibana's Snapshot and Restore feature
  • Combines tutorial pages related to taking and managing snapshots
  • Consolidates explanations of the snapshot process
  • Incorporates SLM into the snapshot tutorial
  • Removes duplicate "back up a cluster" pages

Previews

Highlights:

* Adds info about cloud snapshot repositories
* Adds info about Kibana's Snapshot and Restore feature
* Combines tutorial pages related to taking and managing snapshots
* Consolidates snapshot process explanations
* Incorporates SLM into the standard snapshot and restore workflow
* Removes duplicate "back up a cluster" pages
@jrodewig jrodewig marked this pull request as ready for review October 13, 2021 18:07
@jrodewig jrodewig added :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes v7.16.0 labels Oct 13, 2021
@elasticmachine elasticmachine added Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team labels Oct 13, 2021
@elasticmachine
Copy link
Collaborator

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

@elasticmachine
Copy link
Collaborator

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

Comment on lines +262 to +263
=== Clean up a repository

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think there's some more room for improvement in this section, but this PR is already massive. I'll take a second pass in a follow-up.

jrodewig added a commit that referenced this pull request Oct 21, 2021
Changes:

- Notes snapshot names support date math
- Sorts request body parameters alphabetically
- Adds the `expand_wildcards` request body parameter
- Reuses cluster state contents list from the restore snapshot API
- Notes the `indices` and `feature_states` parameters support a special `none` value

Relates to #79081
elasticsearchmachine pushed a commit that referenced this pull request Oct 21, 2021
* [DOCS] Fix create snapshot API parameters (#79209)

Changes:

- Notes snapshot names support date math
- Sorts request body parameters alphabetically
- Adds the `expand_wildcards` request body parameter
- Reuses cluster state contents list from the restore snapshot API
- Notes the `indices` and `feature_states` parameters support a special `none` value

Relates to #79081

* Update `expand_wildcards` default

* Fix xref

* Fix xref
elasticsearchmachine pushed a commit that referenced this pull request Oct 21, 2021
* [DOCS] Fix create snapshot API parameters (#79209)

Changes:

- Notes snapshot names support date math
- Sorts request body parameters alphabetically
- Adds the `expand_wildcards` request body parameter
- Reuses cluster state contents list from the restore snapshot API
- Notes the `indices` and `feature_states` parameters support a special `none` value

Relates to #79081

* Update `expand_wildcards` default

* Fix xref

* Fix xref
@jrodewig
Copy link
Contributor Author

@williamrandolph pointed out some documentation gaps for feature states in #79675.

I'm going to convert this PR to a draft while I add those missing docs.

@jrodewig jrodewig marked this pull request as draft October 22, 2021 19:01
Copy link
Contributor

@williamrandolph williamrandolph left a comment

Choose a reason for hiding this comment

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

Thanks for addressing my comments! This looks really good, from my dev's perspective.

@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

@jrodewig
Copy link
Contributor Author

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

@jrodewig jrodewig merged commit 659e0d3 into elastic:master Nov 15, 2021
@jrodewig jrodewig deleted the docs__snapshot-restore branch November 15, 2021 17:45
jrodewig added a commit that referenced this pull request Nov 15, 2021
Makes several changes to consolidate snapshot and backup-related docs.

Highlights:

* Adds info about supported ESS snapshot repository types
* Adds docs for Kibana's Snapshot and Restore feature
* Combines tutorial pages related to taking and managing snapshots
* Consolidates explanations of the snapshot process
* Incorporates SLM into the snapshot tutorial
* Removes duplicate "back up a cluster" pages
jrodewig added a commit that referenced this pull request Nov 15, 2021
Makes several changes to consolidate snapshot and backup-related docs.

Highlights:

* Adds info about supported ESS snapshot repository types
* Adds docs for Kibana's Snapshot and Restore feature
* Combines tutorial pages related to taking and managing snapshots
* Consolidates explanations of the snapshot process
* Incorporates SLM into the snapshot tutorial
* Removes duplicate "back up a cluster" pages
jrodewig added a commit to elastic/kibana that referenced this pull request Nov 16, 2021
With elastic/elasticsearch#79081, we now cover Kibana's **Snapshot and Restore** feature in the Elasticsearch docs. This removes and redirects the related docs from Kibana.

It also updates some references to the `.kibana` system indices to include the `kibana` feature state. The `kibana` feature state is now the preferred way to back up and restore system indices and other configuration data for Kibana.

Relates to elastic/elasticsearch#79675
jrodewig added a commit to elastic/kibana that referenced this pull request Nov 16, 2021
With elastic/elasticsearch#79081, we now cover Kibana's **Snapshot and Restore** feature in the Elasticsearch docs. This removes and redirects the related docs from Kibana.

It also updates some references to the `.kibana` system indices to include the `kibana` feature state. The `kibana` feature state is now the preferred way to back up and restore system indices and other configuration data for Kibana.

Relates to elastic/elasticsearch#79675
jrodewig added a commit to elastic/kibana that referenced this pull request Nov 17, 2021
With elastic/elasticsearch#79081, we now cover Kibana's **Snapshot and Restore** feature in the Elasticsearch docs. This removes and redirects the related docs from Kibana.

It also updates some references to the `.kibana` system indices to include the `kibana` feature state. The `kibana` feature state is now the preferred way to back up and restore system indices and other configuration data for Kibana.

Relates to elastic/elasticsearch#79675
# Conflicts:
#	docs/setup/upgrade.asciidoc
#	docs/template.asciidoc
jrodewig added a commit to elastic/stack-docs that referenced this pull request Nov 29, 2021
dmlemeshko pushed a commit to elastic/kibana that referenced this pull request Nov 29, 2021
With elastic/elasticsearch#79081, we now cover Kibana's **Snapshot and Restore** feature in the Elasticsearch docs. This removes and redirects the related docs from Kibana.

It also updates some references to the `.kibana` system indices to include the `kibana` feature state. The `kibana` feature state is now the preferred way to back up and restore system indices and other configuration data for Kibana.

Relates to elastic/elasticsearch#79675
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-rc1 v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants