Umbrella issue: API changes in v1.11 / v1beta2 #10852
Description
Goal of this issue is to provide an overview over issues related to API changes.
Important:
- Audit our APIs:
- [P0] Audit at least the Cluster object
- Get rid of pointer struct fields when not needed (like in 99% of the cases)
- Consistency: Improve API consistency #12497
- Audit Machine-level fields across CC, Cluster.spec.topology, MD, MS, KCP and check if we can make it more consistent
- Audit all strategy fields, including rolloutStrategy / rolloutBefore / rolloutAfter Configurable machine replacement #10946 Improve API around machine deletion strategy #7021 (also future-proof for in-place & for Cluster.nodeDeletionStrategy) / deletionStrategy (?, e.g. timeout fields)
- [P0] Audit at least the Cluster object
- API field best practices
- statusoptional: all direct children within status should be optional: 🌱 Enable statusoptional linter #12229
- nomaps: ⚠️ Enable nomaps linter, Remove unused kubeadm ClusterStatus struct, Migrate Cluster.status.failureDomains to array #12083
- nodurations: Remove Duration types: ⚠️ Migrate API to use *Seconds instead of metav1.Duration fields #12327
- notimestamp: ✨ Bump KAL & add the notimestamps linter #12520 ⚠️ Rename LastRemediationStatus.Timestamp to Time in KCP #12452
- ssatags: ✨ Enable ssatags KAL linter #12470
- requiredfields: ✨ Bump KAL to pick up latest requiredfields linter, add Min/MaxLength to BootstrapToken #12563
- optionalfields: 🌱 Enable optionalfields linter and fix remaining findings #12299
- 🌱 Set minimum=1 on ObservedGeneration and KubeadmConfig APIEndpoint bindPort #12417
- 📖 Align v1beta2 contract to API conventions around optional fields #12418
- ⚠️ Use MachineSetDeletePolicy enum in MD & MS API #12419
- ⚠️ Make Template in MachineSet & Spec in MachineTemplateSpec required #12420
- ⚠️ Change type of int32 fields with valid zero value to *int32 #12424
- ⚠️ Change type of *string fields with invalid zero value to string #12429
- ⚠️ Align Spec fields to optionalfields API conventions #12431
- ⚠️ Align Status fields to optionalfields API conventions #12435
- ⚠️ Change bool to *bool for all API types #12436
- 🌱 Enable optionalfields linter and fix remaining findings #12299
Status fields & conditions:
- @fabriziopandini (📖 Proposal: Improving status in CAPI resources #10897)
- Consider aligning Cluster API conditions to upstream conditions #7635
- Deprecate KCP.Available condition #10532
- Improve status.Ready Fields in the contract #10707
- Mismatch between ControlPlaneReady and Conditions.ControlPlaneReady #7099
- Add MachineNodeHealthyCondition to Machine’s Ready condition #3974
- Add conditions to MachineDeployment Object #3486
- Machine failures not propagated up to MachineDeployment.Status #5635
- [P1] Consistent reporting of paused resources #10130
- The ready condition of MachineDeployment doesn't change when a Machine CR is deleted #7461
- out of scope for the first iteration of the proposal, but the same principles will apply
CRD Columns: #12534
- [P0] Audit if we broke something when introducing v1beta2
- Fine tuning of print columns
- Also Ensure consistency across replica-based CLI printer columns #6238. Rename 'replicas' to 'current' in KubeadmControlPlane, MachineDeployments and MachineSet kubectl output #6227, API conventions: CRD columns: status vs intent #5332, Add more print columns to ClusterResourceSet/Bindings for better tracking #9007
- Remove DefaulterRemoveUnknownOrOmitableFields from CABPK/ KCP (reintroduced in ⚠️ Partially revert: Remove DefaulterRemoveUnknownOrOmitableFields mutating webhook option #12290)
- prepare replacing corev1.ObjectReference in v1beta2 #6539
ClusterClass & Cluster.spec.topology:
- v1beta2: Class Namespace API change #11500: ⚠️ Restructure classRef field in Cluster.spec.topology #12235
- Deprecate definitionFrom in cluster variables #10666 [deprecated] [will be removed in v1beta2]: ⚠️ Remove ClusterVariable.DefinitionFrom field #12202
- Remove IP Family from API types and cluster class builtin variables #7521 [deprecated] [will be removed in v1beta2]: ⚠️ Remove IPFamily from public APIs (move to CAPD/kind util) #12215
- Introduce InfrastructureClass (context in Add namingStrategy for InfrastructureCluster #11671 (comment)): ⚠️ Move infrastructure namingStrategy field in ClusterClass #12216
- Simplify external patch definition in ClusterClass #8210
MachineDeployment:
- Remove spec.ProgressDeadlineSeconds in MachineDeployments #11470 [deprecated] [will be removed in v1beta2]: ⚠️ Remove MD spec.progressDeadlineSeconds #12232
- Remove revision management in MachineDeployments #10479 [deprecated] [will be removed in v1beta2]: ⚠️ Drop revisionHistory in MachineDeployment #12274
KubeadmConfig / KubeadmConfigTemplate / KubeadmControlPlane / KubeadmControlPlaneTemplate:
- Remove TypeMeta in InitConfiguration/...
- Implement support for kubeadm v1beta4 API #10708
- Remove experimentalRetryJoin #6942 [deprecated] [will be removed in v1beta2]: ⚠️ Remove KubeadmConfig UseExperimentalRetryJoin #12234
- Remove ClusterConfiguration.KubernetesVersion field (be careful regarding rollouts) (follow-up to: Upgrade is not updating KubeadmConfigSpec. ClusterConfiguration. KubernetesVersion #11344)
- Remove Networking.ServiceSubnet, Networking.PodSubnet, Domain: ⚠️ Add MaxLength & MinLength markers #11949 (comment)
- PR: ⚠️ Remove redundant fields from CABPK / KCP ClusterConfiguration #12319
MachineHealthCheck:
- Rename conditions to nodeConditions: ⚠️ Rename MHC unhealthyConditions to unhealthyNodeConditions #12245
- Deprecate MachineHealthCheck MaxUnhealthy and UnhealthyRange #10722 [deprecated] => fields will be renamed and the deprecation will be removed
ClusterResourceSet:
- When the clusterresourcesetbinding is v1beta2, set the clusterName field to be required. #8267: ⚠️ Make clusterName field in ClusterResourceSetBinding required #12276
clusterctl:
- Deprecate & remove "clusterctl alpha topology plan" #10138 [deprecated]: ⚠️ Remove clusterctl alpha topology plan #12283
Done
Smaller improvements: (can be already done today)