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] Add docs for restoring to new cluster #79683

Merged
merged 12 commits into from
Oct 26, 2021
Merged

[DOCS] Add docs for restoring to new cluster #79683

merged 12 commits into from
Oct 26, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Oct 22, 2021

When restoring a snapshot to a new cluster, users may expect the cluster
to not contain any conflicting indices or data streams. However, some
features, such as the GeoIP processor, automatically create indices at
startup.

This adds and updates related procedures in the restore a snapshot tutorial.
I plan to improve other documentation related to feature states in snapshots
in a separate PR(s).

This PR also updates the restore snapshot API's example to include
the indices and feature_states parameters.

Relates to #79675

Preview

https://elasticsearch_79683.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/snapshots-restore-snapshot.html

When restoring a snapshot to a new cluster, users may expect the cluster
to not contain any conflicting indices or data streams. However, some
features, such as the GeoIP processor, automatically create indices at
startup.

This adds a related procedure to the restore a snapshot tutorial. I plan
to improve other documentation related to feature states in snapshots
in a separate PR(s).

Relates to #79675
@jrodewig jrodewig marked this pull request as ready for review October 22, 2021 23:56
@jrodewig jrodewig added >docs General docs changes v7.15.2 v7.16.1 labels Oct 22, 2021
@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Oct 22, 2021
@elasticmachine
Copy link
Collaborator

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

@jrodewig jrodewig added :Core/Infra/Core Core issues without another label :Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs labels Oct 22, 2021
@elasticmachine elasticmachine added Team:Core/Infra Meta label for core/infra team Team:Distributed Meta label for distributed team labels Oct 22, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (Team:Core/Infra)

@elasticmachine
Copy link
Collaborator

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

Copy link
Contributor

@gwbrown gwbrown left a comment

Choose a reason for hiding this comment

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

LGTM but see my comment about changes coming soon to 8.0 that will necessitate further changes (in another PR, probably the same PR as the changes). I will also note that I haven't read #79081 yet.

Comment on lines +83 to +85
By default, a restore request attempts to restore all indices and data streams
in a snapshot, including <<system-indices,system indices and system data
streams>>. In most cases, you only need to restore a specific index or data
Copy link
Contributor

Choose a reason for hiding this comment

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

This is true for 7.16, for 8.0 this will not be the case when we get to merging this PR: #79670

After we merge that, 8.0 will restore (in order of preference, so feature_states always wins:

  • The indices owned by the features named in feature_states
  • All system indices if include_global_state is true
  • No system indices otherwise

We can merge this PR as-is though, because this is correct for the current 8.0-SNAPSHOT builds, and update the docs in #79670.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! And yeah -- #79670 will make these docs much simpler. Thanks for making those changes.

@jrodewig jrodewig merged commit 3ab6144 into elastic:master Oct 26, 2021
@jrodewig
Copy link
Contributor Author

Thanks @gwbrown!

@jrodewig jrodewig deleted the docs__restore-new-cluster branch October 26, 2021 21:27
elasticsearchmachine pushed a commit that referenced this pull request Oct 26, 2021
When restoring a snapshot to a new cluster, users may expect the cluster
to not contain any conflicting indices or data streams. However, some
features, such as the GeoIP processor, automatically create indices at
startup.

This adds and updates related procedures in the restore a snapshot tutorial.
I plan to improve other documentation related to feature states in snapshots
in a separate PR(s).

This PR also updates the restore snapshot API's example to include
the `indices` and `feature_states` parameters.

Relates to #79675
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Core/Infra/Core Core issues without another label :Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Core/Infra Meta label for core/infra team Team:Distributed Meta label for distributed team 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.

6 participants