Tracking issue for Improving status in CAPI resources

[fabriziopandini]

This is a tracking issue for activities related to #10897

Enablement

Activities that are required to unblock implementation

• @fabriziopandini Implement conditions utils ✨ Implement utils for v1beta2 conditions #10997
• @fabriziopandini Add support for metav1 conditions in patch helper 🌱 Add support for v1beta2 conditions to patch helper #11150
• @sbueringer Improve Cluster Cache Tracker to allow tracking of connection problems ✨ Introduce new ClusterCache #11247
• @chrischdi MD foreground deletion 🌱 Foreground deletion for MachineDeployments and MachineSets #11174
• @sbueringer Handle finalizers early in Reconciles#11286

Documentation updates

• @fabriziopandini add superseded by notice to old condition proposal ⚠️ Add superseded notice to the old condition proposal #11189)
• @fabriziopandini update provider contracts with notices about future changes & clarify requirements about conditions in provider contracts. Note, no backport is planned
  • @fabriziopandini 📖 Drop k8s.gcr.io deprecation notice #11190
  • @fabriziopandini 📖 Drop old version of migration docs #11191
  • @fabriziopandini 📖 Group API reference docs #11194
  • @fabriziopandini 📖 Refactor provider's implementers guide #11195
  • @fabriziopandini 📖 Refactor core developer guide #11208
  • @fabriziopandini 📖 Refactor InfraCluster contract #11213
  • @fabriziopandini 📖 Refactor InfraMachine contract #11223
  • @fabriziopandini 📖 Refactor the BootstrapConfig contract #11235
  • @fabriziopandini 📖 Refactor ControlPlane contract #11285
  • machine pool contract

Implementation Phase1

Focus on phase 1 of the implementation, where new field are added but not yet used by controllers

• API modeling
  • @fabriziopandini ✨ Add v1beta2 structs to object status #11234
  • @chrischdi 🌱 api: deprecate FailureMessage and FailureReason #11317
• Machine controller
  • @fabriziopandini ✨ Update machine with v1beta2 status #11276
  • @fabriziopandini KCP ✨ Add machine UpToDate condition to KCP #11389
  • @fabriziopandini ✨ Add machine UpToDate condition to MachineSet #11393
  • @sbueringer 🌱 Implement Machine Deleting condition #11291
• MachineHealthCheck controller
  • @fabriziopandini ✨ Update MHC with v1Beta2 status #11290
• MachineSet controller
  • @chrischdi ✨ Update machineset with v1beta2 status test #11278
  • @sbueringer 🌱 Implement MS remediating conditions  #11382
  • @sbueringer 🌱 Implement MS remediating conditions  #11382
  • @sbueringer 🌱 Implement KCP and MS Deleting conditions #11381
  • @sbueringer 🌱 Extend MS ScalingUp and Remediationg conditions to include preflight check errors #11390
• MachineDeployment controller
  • @fabriziopandini ✨ Add v1beta2 condition to MD controller #11338
• KubeadmControlPlane controller
  • @fabriziopandini ✨ Add v1beta2 Etcd and ControlPlaneComponents conditions to KCP #11302
  • @fabriziopandini ✨ Add v1beta2 available condition to KCP #11383
  • @sbueringer 🌱 Implement KCP and MS Deleting conditions #11381
  • @chrischdi 🌱 kcp: ensure ReadinessGates for v1beta2 conditions get set #11335
  • @fabriziopandini ✨ Add v1beta2 OwnerRemediated condition to KCP #11297
  • @fabriziopandini ✨ Add v1beta2 Etcd and ControlPlaneComponents conditions to KCP #11302
  • @sbueringer 🌱 Implement grace period for KCP remote conditions #11339
• Cluster controller
  • @fabriziopandini ✨ Add v1beta2 condition to Cluster controller #11364
  • @sbueringer ✨ Introduce new ClusterCache #11247
• Topology controller
  • @sbueringer 🌱 Implement Cluster TopologyReconciled v1beta2 condition #11394
• ClusterClass controller
  • @sbueringer 🌱 Add v1beta2 conditions to ClusterClass #11428
• KubeadmConfig controller
  • @fabriziopandini 🌱 Add v1beta2 conditions to CABPK #11452
• clusterctl describe cluster
  • @fabriziopandini ✨ Add support for v1beta2 conditions to clusterctl describe #11277

Follow up / before release

Activities that could be deferred to after we get a first version of this proposal implemented

• P0: Check initializations of the status structs to catch cases like this
• P0: Double check deprecations notices: fields that are marked as deprecated in the proposal, utils, etc (note: some of them should be deferred to phase 2)
• P0: Prune fields not yet implemented before release
• Fine tuning of godocs for API trypes (make them kubectl explain compliant)
  - rif 📖 Proposal: Improving status in CAPI resources #10897 (comment)
• Add support for negative polarity conditions to ReadinessGates and AvailabilityGates
  • rif 📖 Proposal: Improving status in CAPI resources #10897 (review)
• Extending CC to allow the definition of AvailabilityGates & ReadinessGates (and Cluster topology)
  • rif 📖 Proposal: Improving status in CAPI resources #10897 (comment)
  • rif ✨ Add v1beta2 structs to object status #11234 (comment)
• Allow customisation of remote-conditions-grace-period at cluster level
  • rif 📖 Proposal: Improving status in CAPI resources #10897 (comment)
• Consider if to allow users to add arbitrary ReadinessGates to KCP machines
• Rename test types to align to API types (v1Beta2 in the middle)
• Check if NodeNetworkUnavailable must be added to MachineNodeHealthyCondition
• ExtensionConfig
  • Add v1beta2 struct
  • Paused
• ClusterResourceSet, ClusterResourceSetBinding
  • Add v1beta2 struct
  • Paused
• InMemoryCluster and InMemoryMachine controllers ?
• DockerCluster and DockerMachine controllers
• MachinePool conditions
  • Implement conditions on MachinePools and MachinePool Machines (UpToDate)
  • Revert 🐛 Disable aggregation of not reported MachinePool conditions for Cluster #11416
• DockerMachinePool
  • Add v1beta2 struct
  • Paused
• Drop fake objects from controller tests and use the test/util/builders package

Implementation Phase2

Initial notes for phase 2 of the implementation, where new field are added but not yet used by controllers

• ...
• API modeling
  • Introduce deprecated struct, move v1beta2 top level
  • Rename condition interfaces and method implementations (current--> deprecated, v1beta2--> current)
  • Rename condition consts (current--> deprecated, v1beta2--> current)
  • Move conditions fields as the first field in the struct
    • rif. 📖 Proposal: Improving status in CAPI resources #10897 (comment)
  • Fine tuning of print columns
    • rif 📖 Proposal: Improving status in CAPI resources #10897 (review)
    • rif 📖 Proposal: Improving status in CAPI resources #10897 (comment)
  • Add minReadySeconds to machine, remove it from KCP. MD
• Change contracts
  • ...
• Use new fields
  • MachineHealthCheck controller
    • Change test for ControlPlaneInitializedCondition in reconcile
    • Get MachineHealthCheckSucceededCondition in patchUnhealthyTargets
    • Drop failureReson/failureMessage test from needsRemediation
    • Change test for ControlPlaneInitializedCondition, InfrastructureReadyCondition in needsRemediation (few places)
  • KCP controller
    • Change test for MachineEtcdMemberHealthyCondition in canSafelyRemoveEtcdMember + add a test for ClusterHealthy if not already there
    • We should use the Initialized condition instead of the Available condition to calculate remoteConditionsGracePeriod
• Condition utils
  • Rename packages for condition utils (conditions-->deprecated conditions, v1beta2conditions --> conditions)
• Clusterctl
  • clusterctl describe (drop v1beta2 flag, introduce deprecated flag, switch default behaviour in the implementation)

Implementation Phase3

• ...

Backlog / unprioritized

• Scale testing with CAPD (check for condition flakiness)