kubernetes-sigs / kubernetes-sigs/cluster-api
Umbrella issue: API changes / wish list
- Dominant language
- Go
- Stars
- 4.3k
- Forks
- 1.6k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 113
Description
Goal of this issue is to provide an overview over issues related to API changes.
Let's try to make it explicitly clear going forward which changes require an apiVersion bump when we add new issues to the list
General
* [ ] When introducing a new apiVersion, update logic introduced in https://github.com/kubernetes-sigs/cluster-api/pull/13338
* [ ] Consider to stop embedding structs, e.g.:
* [ ] Machine struct directly in MD/MS (e.g. fields like clusterName, providerID don't belong there)
* [ ] Improve CRD printcolumns
* [ ] Consider how we can improve our columns once we can rely on CEL for CRD columns:
* [ ] Consider introducing a class.namespace column on the Cluster object once we can rely on CEL support for CRD columns: https://github.com/kubernetes-sigs/cluster-api/pull/11802#issuecomment-2706880487
* [ ] Improve Machine InternalIP/ExternalIP columns to show all IPs
* [ ] Check if we can combine replica numbers like e.g. on Deployments (and then we might be able to use that space on Cluster to add ControlPlane endpoint `host:port`)
ClusterClass & Cluster.spec.topology:
* [ ] #8211
* [ ] #6706
Cluster:
* [ ] [TBD] #7538
Machine:
* [ ] [TBD] Take another look at Bootstrap
* Check in all the places where we use MachineSpec (MD/MS/MP/...)
* Think about use cases where user set dataSecretName: "" (usually because they don't want to use bootstrap) (https://github.com/kubernetes-sigs/cluster-api/issues/10943#issuecomment-)
* [ ] [TBD] #9692
MachineDeployment
* [ ] cleanup revisionHistoryAnnotation after https://github.com/kubernetes-sigs/cluster-api/pull/12274
* [ ] [TBD] #6966:
* Check behavior of upstream Deployment.spec.paused, see if the same makes sense for us, if yes => suggest to rename the field to disambiguate
MachineHealthCheck
* [ ] #5291 [not planned]
MachinePool:
* [ ] #7248 [not planned] [TBD if blocker for MP graduation]
KubeadmConfig:
* [ ] Potential follow-up from [Taint Propagation](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20250513-propogate-taints.md#behavior-with-cluster-api-bootstrap-provider-kubeadms-taints-fields): Consider deprecating the related fields (i.e. KubeadmConfig taints) and propose using the machine taints instead
* Note: We might want to keep the KubeadmConfig taints field as it gives additional options with ClusterClass regarding how exposed the taint config is to users (that usually only modify the Cluster object)
Annotations+Labels:
* [ ] **Consider** migrate "internal" annotations to new annotation keys with an internal prefix
* [ ] **Consider** migrate "internal" labels to new label keys with an internal prefix
Finalizers:
* [ ] [TBD] #10914
Backlog: (require some design/proposal)
* [x] #5294
* [ ] #5517
Contributor guide
Assessment
This issue has not been assessed yet.