Skip to content

[DOCS] Update snapshot vers compat table to use minor versions #81885

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

Merged
merged 7 commits into from
Jan 13, 2022
Merged

[DOCS] Update snapshot vers compat table to use minor versions #81885

merged 7 commits into from
Jan 13, 2022

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Dec 17, 2021

Changes

  • Updates the snapshot version compatibility table to use minor versions rather than major versions.
  • Adds a index creation version and cluster compatibility table. Updates the index compatibility section to use minor versions.
  • Moves the tables to separate files. This'll help prevent merge conflicts.
  • Fixes the heading level for the "Warnings" section.

Preview

https://elasticsearch_81885.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/snapshot-restore.html#snapshot-restore-version-compatibility

@jrodewig jrodewig marked this pull request as ready for review December 17, 2021 17:58
@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 Dec 17, 2021
@elasticmachine
Copy link
Collaborator

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

@elasticmachine
Copy link
Collaborator

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

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

Looks good, loving those en-dashes 😁

I left one request.

[cols="^,^,^,^,^"]
|====
| 4+^h| Cluster version
h| Snapshot version | 5.0–5.6 | 6.0–6.8 | 7.0–{prev-major-last} | 8.0–{minor-version}
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we clarify that by "snapshot version" we really mean the oldest index-created version? For instance a 7.16 cluster can hold indices created in 6.8 but if you take a snapshot of such a cluster you won't be able to fully restore it into an 8.x cluster.

Copy link
Contributor Author

@jrodewig jrodewig Dec 17, 2021

Choose a reason for hiding this comment

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

Thanks for pointing this out. After giving it some thought, I think it may be simpler to keep the concept of "snapshot version" and "index creation version" compatibility separate—even if the version compatibility tables look the same.

Taking your example, a 7.16 snapshot can contain indices created in 7.16, 7.14, and 6.8. Based on my testing and understanding, you can safely restore the 7.16 and 7.14 indices from that snapshot to an 8.0 cluster but not the 6.8. indices. The snapshot is compatible; the 6.8 index is not.

I did make some additional changes to the index compatibility section, including adding a new table that uses minor versions.

Let me know if anything is off the mark!

Copy link
Contributor

@henningandersen henningandersen left a comment

Choose a reason for hiding this comment

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

I left a couple of comments on potential difficulties with 7.0/7.1.

@jrodewig
Copy link
Contributor Author

@henningandersen @DaveCTurner I've updated the table to indicate that you can't restore a 6.8 snapshot to a 7.0/7.1 cluster. Let me know if any other changes are needed. Thanks!

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

Could we clarify that the diagonal of these tables have a bit more nuance: we say that 7.2-7.17 indices/snapshots are compatible with 7.2-7.17 clusters but a 7.17 index/snapshot is not compatible with a 7.2 cluster.

We do say in words You can't restore a snapshot to an earlier version of ES which seems ok for the snapshot compatibility table but the index compatibility table doesn't have those words.

@jrodewig
Copy link
Contributor Author

We do say in words You can't restore a snapshot to an earlier version of ES which seems ok for the snapshot compatibility table but the index compatibility table doesn't have those words.

Thanks @DaveCTurner. I added a paragraph to address this with 4684972.

However, I'm not 100% sure it's needed. AFAIK the only way to restore a 7.17 index to a 7.2 cluster is using a 7.17 or later snapshot, which we already note is not supported. I suppose the extra clarity is worth the redundancy though.

Copy link
Contributor

@henningandersen henningandersen left a comment

Choose a reason for hiding this comment

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

LGTM.

@jrodewig
Copy link
Contributor Author

Thanks for the reviews!

@jrodewig jrodewig merged commit 93bd599 into elastic:master Jan 13, 2022
@jrodewig jrodewig deleted the docs__fix-snapshot-compat-table branch January 13, 2022 20:50
jrodewig added a commit that referenced this pull request Jan 13, 2022
… (#82577)

### Changes

* Updates the snapshot version compatibility table to use minor versions rather than major versions.
* Adds a index creation version and cluster compatibility table. Updates the index compatibility section to use minor versions.
* Moves the tables to separate files. This'll help prevent merge conflicts.
* Fixes the heading level for the "Warnings" section.

(cherry picked from commit 93bd599)
jrodewig added a commit that referenced this pull request Jan 13, 2022
… (#82578)

### Changes

* Updates the snapshot version compatibility table to use minor versions rather than major versions.
* Adds a index creation version and cluster compatibility table. Updates the index compatibility section to use minor versions.
* Moves the tables to separate files. This'll help prevent merge conflicts.
* Fixes the heading level for the "Warnings" section.

(cherry picked from commit 93bd599)
jrodewig added a commit that referenced this pull request Jan 13, 2022
… (#82576)

### Changes

* Updates the snapshot version compatibility table to use minor versions rather than major versions.
* Adds a index creation version and cluster compatibility table. Updates the index compatibility section to use minor versions.
* Moves the tables to separate files. This'll help prevent merge conflicts.
* Fixes the heading level for the "Warnings" section.

(cherry picked from commit 93bd599)
Leaf-Lin added a commit that referenced this pull request Feb 15, 2022
Split 7.0 and 7.1.  Merge 7.1 into 7.2-7.17. 

As per #81885 (comment), 7.1 should be grouped with 7.2-7.17 while 7.0 is the special one.

(alternatively, 7.0 is over a year past EOL maybe we don’t even need to write about it)
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.8.2 v7.9.4 v7.10.3 v7.11.3 v7.12.2 v7.13.5 v7.14.3 v7.15.3 v7.16.4 v7.17.0 v8.0.0-beta1 v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants