Skip to content

Commit afd0d8a

Browse files
Documentation for the chained upgrade feature
1 parent 64c0753 commit afd0d8a

File tree

8 files changed

+496
-69
lines changed

8 files changed

+496
-69
lines changed

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
- [Implementing Runtime Extensions](./tasks/experimental-features/runtime-sdk/implement-extensions.md)
4040
- [Implementing Lifecycle Hook Extensions](./tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md)
4141
- [Implementing Topology Mutation Hook Extensions](./tasks/experimental-features/runtime-sdk/implement-topology-mutation-hook.md)
42+
- [Implementing Upgrade Plan Runtime Extensions](./tasks/experimental-features/runtime-sdk/implement-upgrade-plan-hooks.md)
4243
- [Deploying Runtime Extensions](./tasks/experimental-features/runtime-sdk/deploy-runtime-extension.md)
4344
- [Ignition Bootstrap configuration](./tasks/experimental-features/ignition.md)
4445
- [Running multiple providers](./tasks/multiple-providers.md)
221 KB
Loading

docs/book/src/reference/glossary.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Table of Contents
22

3-
[A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [H](#h) | [I](#i) | [K](#k) | [L](#l)| [M](#m) | [N](#n) | [O](#o) | [P](#p) | [R](#r) | [S](#s) | [T](#t) | [W](#w)
3+
[A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [H](#h) | [I](#i) | [K](#k) | [L](#l)| [M](#m) | [N](#n) | [O](#o) | [P](#p) | [R](#r) | [S](#s) | [T](#t) | [U](#u) |[W](#w)
44

55
# A
66
---
@@ -132,6 +132,15 @@ Cluster API IPAM Provider Metal3
132132
### CAREX
133133
Cluster API Runtime Extensions Provider Nutanix
134134

135+
### Chained upgrade
136+
An upgrade sequence that goes from one Kubernetes version to another by passing through a set of intermediate versions.
137+
e.g., Upgrading from v1.31.0 (current state) to v1.34.0 (target version) requires
138+
a chained upgrade with the following steps: v1.32.0 (first intermediate version)-> v1.33.0 (second intermediate version) -> v1.34.0 (target version).
139+
140+
The sequence of versions in a chained upgrade is also called [upgrade plan](#upgrade-plan).
141+
142+
See also [efficient upgrade](#efficient-upgrade).
143+
135144
### Cloud provider
136145

137146
Or __Cloud service provider__
@@ -219,6 +228,14 @@ A feature implementation offered as part of the Cluster API project and maintain
219228
# E
220229
---
221230

231+
### Efficient upgrade
232+
233+
A [chained upgrade](#chained-upgrade) where worker nodes skip some of the intermediate versions,
234+
when allowed by the [Kubernetes version skew policy](https://kubernetes.io/releases/version-skew-policy/).
235+
236+
When the chained upgrade is also an efficient upgrade, the [upgrade plan](#upgrade-plan) for worker machines is a subset
237+
of the [upgrade plan](#upgrade-plan) for control plane machines.
238+
222239
### External patch
223240

224241
[Patch](#patch) generated by an external component using [Runtime SDK](#runtime-sdk). Alternative to [inline patch](#inline-patch).
@@ -460,6 +477,16 @@ A [Runtime Hook](#runtime-hook) that allows external components to generate [pat
460477

461478
See [Topology Mutation](../tasks/experimental-features/runtime-sdk/implement-topology-mutation-hook.md)
462479

480+
# U
481+
---
482+
483+
### Upgrade plan
484+
The sequence of intermediate versions ... target version that a Cluster must upgrade to when
485+
performing a [chained upgrade](#chained-upgrade).
486+
487+
Notably, the upgrade plan for control plane machines might be a superset of the upgrade plan for
488+
workers machines.
489+
463490
# W
464491
---
465492

0 commit comments

Comments
 (0)