-
Notifications
You must be signed in to change notification settings - Fork 25.2k
[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
[DOCS] Update snapshot vers compat table to use minor versions #81885
Conversation
Pinging @elastic/es-docs (Team:Docs) |
Pinging @elastic/es-distributed (Team:Distributed) |
There was a problem hiding this 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} |
There was a problem hiding this 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 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.
There was a problem hiding this comment.
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!
There was a problem hiding this 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.
@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! |
There was a problem hiding this 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.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Thanks for the reviews! |
… (#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)
… (#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)
… (#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)
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)
Changes
Preview
https://elasticsearch_81885.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/snapshot-restore.html#snapshot-restore-version-compatibility