Skip to content

Commit 1807f54

Browse files
Add note about v1alpha3 removal to book
Signed-off-by: killianmuldoon <[email protected]>
1 parent 12f1de5 commit 1807f54

File tree

4 files changed

+13
-7
lines changed

4 files changed

+13
-7
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -179,14 +179,20 @@ Cluster API maintains the most recent release/releases for all supported API and
179179

180180
We are going to remove the apiVersions in upcoming releases:
181181
* v1.5:
182-
* Kubernetes API server will stop serving the v1alpha3 apiVersion
182+
* Kubernetes API server stops serving the v1alpha3 apiVersion
183183
* v1.6:
184-
* v1alpha3 apiVersion will be removed from the CRDs
185-
* Kubernetes API server will stop serving the v1alpha4 apiVersion
184+
* v1alpha3 apiVersion is removed from the CRDs
185+
* Kubernetes API server stops serving the v1alpha4 apiVersion
186186
* v1.7
187-
* v1alpha4 apiVersion will be removed from the CRDs
187+
* v1alpha4 apiVersion is removed from the CRDs
188188
For more details and latest information please see the following issue: [Removing v1alpha3 & v1alpha4 apiVersions](https://github.com/kubernetes-sigs/cluster-api/issues/8038).
189189

190+
Note: Removal of a deprecated APIVersion in Kubernetes [can cause issues with garbage collection by the kube-controller-manager](https://github.com/kubernetes/kubernetes/issues/102641)
191+
This means that some objects which rely on garbage collection for cleanup - e.g. MachineSets and their descendent objects, like Machines and InfrastructureMachines, may not be cleaned up properly if those
192+
objects were created with an APIVersion which is no longer served.
193+
To avoid these issues it's advised to ensure a restart to the kube-controller-manager is done after upgrading to a version of Cluster API which drops support for an APIVersion - e.g. v1.5 and v1.6.
194+
This can be accomplished with any Kubernetes control-plane rollout, including a Kubernetes version upgrade, or by manually stopping and restarting the kube-controller-manager.
195+
190196
## Contributing a Patch
191197

192198
1. If you haven't already done so, sign a Contributor License Agreement (see details above).

REVIEWING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ By extension, the Cluster API contract includes all the util methods that Cluste
106106
making the development of providers simpler and consistent (e.g. everything under `/util` or in `/test/framework`);
107107
documentation of the utility is available [here](https://pkg.go.dev/sigs.k8s.io/cluster-api?tab=subdirectories).
108108

109-
The Cluster API contract is linked to the version of the API (e.g. v1alpha3 Contract), and it is expected to
109+
The Cluster API contract is linked to the version of the API (e.g. v1beta1 Contract), and it is expected to
110110
provide the same set of guarantees in terms of support window, stability, and upgradability.
111111

112112
This makes any change that can impact the Cluster API contract critical and usually:

docs/book/src/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Also, this [guide](https://github.com/kubernetes/registry.k8s.io/tree/main/docs/
2020
<aside class="note">
2121
<h1>Deprecated API removal</h1>
2222

23-
- API version v1alpha3 support will be removed in the upcoming release of v1.5
23+
- API version v1alpha3 support is no longer served in release v1.5
2424
- API version v1alpha4 support will be removed in the upcoming release of v1.6
2525

2626
Review the [support-and-guarantees](./CONTRIBUTING.md#support-and-guarantees) section of the

docs/proposals/20210210-insulate-users-from-kubeadm-API-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ because types are already different (see background info in the implementation d
7777
specs for v1alpha4.
7878
- Define how to use the right version of the kubeadm types generating our kubeadm yaml
7979
file and when interacting with the kubeadm-config ConfigMap.
80-
- Ensure a clean and smooth v1alpha3 to v1aplha4 upgrade experience.
80+
- Ensure a clean and smooth v1alpha3 to v1alpha4 upgrade experience.
8181

8282
### Non-Goals
8383

0 commit comments

Comments
 (0)