docs: Add snap upgrades how-to #934
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HomayoonAlimohammadi
force-pushed
the
KU-2420/snap-upgrades-how-to
branch
from
b1095aa to
4929fd7
Compare
HomayoonAlimohammadi
force-pushed
the
KU-2420/snap-upgrades-how-to
branch
from
4929fd7 to
c369bb0
Compare
nhennigan
reviewed
Jan 8, 2025
bschimke95
reviewed
Jan 9, 2025
There was a problem hiding this comment.
Looks good to me, minor comments
Great work @HomayoonAlimohammadi
bschimke95
approved these changes
Jan 9, 2025
Comment on lines
+11
to
+17
| - According to the [upstream Kubernetes][1], skipping **minor** versions while | ||
| upgrading is not supported. For more details, please visit the | ||
| [Version Skew Policy][2]. | ||
| - Before performing an upgrade, it's important to back up the cluster data. | ||
| This can be done by following the steps outlined in the [backup guide][3]. | ||
| - For more information on managing snap updates, please refer to the | ||
| [snap documentation][4]. |
There was a problem hiding this comment.
Suggested change
| - According to the [upstream Kubernetes][1], skipping **minor** versions while | |
| upgrading is not supported. For more details, please visit the | |
| [Version Skew Policy][2]. | |
| - Before performing an upgrade, it's important to back up the cluster data. | |
| This can be done by following the steps outlined in the [backup guide][3]. | |
| - For more information on managing snap updates, please refer to the | |
| [snap documentation][4]. | |
| - According to the [upstream Kubernetes], skipping **minor** versions while | |
| upgrading is not supported. For more details, please visit the | |
| [Version Skew Policy]. | |
| - Before performing an upgrade, it's important to back up the cluster data. | |
| This can be done by following the steps outlined in the [backup guide]. | |
| - For more information on managing snap updates, please refer to the | |
| [snap documentation]. |
Comment on lines
+103
to
+108
| [1]: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade/ | ||
| [2]: https://kubernetes.io/docs/setup/release/version-skew-policy/ | ||
| [3]: ./backup-restore.md | ||
| [4]: https://snapcraft.io/docs/managing-updates | ||
| [5]: ../../charm/index.md | ||
| [6]: ../../capi/index.md |
There was a problem hiding this comment.
Suggested change
| [1]: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade/ | |
| [2]: https://kubernetes.io/docs/setup/release/version-skew-policy/ | |
| [3]: ./backup-restore.md | |
| [4]: https://snapcraft.io/docs/managing-updates | |
| [5]: ../../charm/index.md | |
| [6]: ../../capi/index.md | |
| [upstream Kubernetes]: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade/ | |
| [Version Skew Policy]: https://kubernetes.io/docs/setup/release/version-skew-policy/ | |
| [backup guide]: ./backup-restore.md | |
| [snap documentation]: https://snapcraft.io/docs/managing-updates | |
| [5]: ../../charm/index.md | |
| [6]: ../../capi/index.md |
There was a problem hiding this comment.
Also, I think 5 and 6 are unused?
| Patch upgrades address bug fixes and are typically safe, introducing no | ||
| breaking changes. | ||
| Snaps automatically check for updates of their specific track | ||
| (e.g. `1.32-classic`) several times a day and apply them when available. |
There was a problem hiding this comment.
Suggested change
| (e.g. `1.32-classic`) several times a day and apply them when available. | |
| (e.g. `1.32-classic`) 4 times a day and apply them when available. |
There was a problem hiding this comment.
There was a problem hiding this comment.
This is what I initially had, but changed according to this comment: #934 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds a how-to guide on snap upgrades.