Skip to content

Commit

Permalink
Linting fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
berkayoz committed Sep 18, 2024
1 parent 0c46e8e commit c7093f2
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions docs/src/capi/howto/in-place-upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,30 +44,40 @@ kubectl annotate machine c1-control-plane-xyzbw "v1beta2.k8sd.io/in-place-upgrad
```

`<upgrade-option>` can be one of:
* `channel=<snap-channel>` which refreshes k8s to the given snap channel. e.g. `channel=1.30-classic/stable`
* `revision=<revision>` which refreshes k8s to the given revision. e.g. `revision=123`
* `localPath=<path>` which refreshes k8s with the snap file from the given absolute path. `localPath=full/path/to/k8s.snap`

Please refer to the [ClusterAPI Annotations Reference][capi-annotations-reference] for further
details on these options.
* `channel=<snap-channel>` which refreshes k8s to the given snap channel.
e.g. `channel=1.30-classic/stable`
* `revision=<revision>` which refreshes k8s to the given revision.
e.g. `revision=123`
* `localPath=<path>` which refreshes k8s with the snap file from
the given absolute path. e.g. `localPath=full/path/to/k8s.snap`

Please refer to the [ClusterAPI Annotations Reference][annotations-reference]
for further details on these options.

## Monitor the in-place upgrade

Watch the status of the in-place upgrade for the machine, by running the
following command and checking the `v1beta2.k8sd.io/in-place-upgrade-status` annotation:
Watch the status of the in-place upgrade for the machine,
by running the following command and checking the
`v1beta2.k8sd.io/in-place-upgrade-status` annotation:

```
kubectl get machine c1-control-plane-xyzbw -o yaml
```

On a successful upgrade:
* Value of the `v1beta2.k8sd.io/in-place-upgrade-status` annotation will be changed to `done`
* Value of the `v1beta2.k8sd.io/in-place-upgrade-release` annotation will be changed to the `<upgrade-option>` used to perform the upgrade.

* Value of the `v1beta2.k8sd.io/in-place-upgrade-status` annotation
will be changed to `done`
* Value of the `v1beta2.k8sd.io/in-place-upgrade-release` annotation
will be changed to the `<upgrade-option>` used to perform the upgrade.

## Cancelling a failing upgrade

The upgrade is retried periodically if the operation was unsuccessful.

The upgrade can be cancelled by running the following commands that remove the annotations:
The upgrade can be cancelled by running the following commands
that remove the annotations:

```
kubectl annotate machine c1-control-plane-xyzbw "v1beta2.k8sd.io/in-place-upgrade-to-"
Expand All @@ -85,4 +95,4 @@ kubectl --kubeconfig c1-kubeconfig.yaml get nodes -o wide

<!-- LINKS -->
[getting-started]: ../tutorial/getting-started.md
[capi-annotations-reference]: ../reference/annotations.md
[annotations-reference]: ../reference/annotations.md

0 comments on commit c7093f2

Please sign in to comment.