Skip to content

Commit

Permalink
Address comments
Browse files Browse the repository at this point in the history
  • Loading branch information
HomayoonAlimohammadi committed Jan 9, 2025
1 parent 0216e2b commit bc66164
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions docs/src/snap/howto/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Upgrading the Kubernetes version of a node is a critical operation that
requires careful planning and execution. {{product}} is shipped as a snap,
which simplifies the upgrade process.
This how-to guide will cover the steps to upgrade the {{product}} snap to a
new version as well as how to freeze upgrades.
This how-to guide will cover the steps to upgrade the {{product}} snap
and how to put a hold on upgrades if desired.

## Important Considerations Before Upgrading

Expand All @@ -20,10 +20,9 @@ This can be done by following the steps outlined in the [backup guide][3].

Patch upgrades address bug fixes and are typically safe, introducing no
breaking changes.
{{product}} snap is installed using a specific track (e.g. `1.32-classic`).
Snaps automatically check for updates several times a day and apply
them when available.
These updates ensure the latest changes in the installed track are applied.
Snaps automatically check for updates of their specific track
(e.g. `1.32-classic`) several times a day and apply them when available.
These updates ensure that the latest changes in the installed track are applied.
Patch upgrades can also be triggered manually by following the steps below.

1. **List available revisions:**

Check failure on line 28 in docs/src/snap/howto/upgrades.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Lists should be surrounded by blank lines

docs/src/snap/howto/upgrades.md:28 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. **List available revisions:..."] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md032.md
Expand Down Expand Up @@ -77,9 +76,9 @@ In a multi-node cluster, the upgrade should be performed on all nodes.

## Freezing Upgrades

To prevent automatic updates, the snap can be frozen to a specific revision.
`snap refresh --hold[=<duration>]` holds refreshes for a specified duration
(or forever, if no value is specified).
To prevent automatic updates, the snap can be tied to a specific revision.
`snap refresh --hold[=<duration>]` holds snap refreshes for a specified
duration (or forever, if no value is specified).
```
snap refresh k8s --hold
```
Expand Down

0 comments on commit bc66164

Please sign in to comment.