Tracking issue for v1Beta2

[fabriziopandini]

Introduce the new API type

P0: mandatory for first alpha
P1: nice 2 have for first alpha

• v1beta2 API (not strictly related to this issue)
  • Prepare main branch for v1.11: 🌱 Prepare main for v1.11 development #12000
  • Create v1beta2 types for core, bootstrap, controlplane, make controllers/webhooks to use it
    • Drop hardcoded v1beta1 references 🌱 Drop hardcoded v1beta1 references #12027
    • Create API types ⚠️ Add v1beta2 types #12037
    • Promote v1Beta2Conditions
      • Introduce deprecated struct, move v1beta2 top level ⚠️ Promote v1beta2 conditions #12066
      • Move conditions fields as the first field in the struct
        • rif. 📖 Proposal: Improving status in CAPI resources #10897 (comment)
    • [P0] Add minReadySeconds to machine, remove it from KCP. MD ⚠️ Add MinReadySeconds to Machine and remove it from MachineDeployment, MachineSet, MachinePool. #12153
    • Implement v1beta2 contract fields:
      • Cluster: InfrastructureReady, ControlPlaneReady ⚠️ Add initialization to Cluster status #12098
      • Machine: BootstrapReady, InfrastructureReady ⚠️ Add initialization to Machine Status #12101
      • KubeadmConfig: Ready, DataSecretName ⚠️ Implement v1beta2 contract in cluster controller, KCP, CABPK #12094
      • KCP: Initialized, Ready ⚠️ Implement v1beta2 contract in cluster controller, KCP, CABPK #12094
      • MachinePool: BootstrapReady, InfrastructureReady ⚠️ Add initialization to MachinePool Status #12102
      • Ensure both CABPK & KCP are declaring the v1beta2 contract (via labels on their CRDs)
  • [P1] Create v1beta2 types for CAPD(ev) (ensure v1beta1 uses v1beta1 conditions, ...)
    • Create v1beta2 CAPD API as a mirror copy of CAPD v1beta1 API (prior art ⚠️ Add v1beta2 types #12037)
      • Implement conversions (no op at this stage)
      • Change all the infrav1 imports to use v1beta2
    • Move v1beta2 conditions top level, v1beta1 conditions to deprecated (prior art ⚠️ Promote v1beta2 conditions #12066)
      • Fix conversions
    • Rename conditions const (prior art ⚠️ conditions: add V1Beta1 suffix and remove V1Beta2 suffix from condition types and reasons in v1beta2 packages #12091)
    • Implement changes for the v1beta2 contract (prior art ⚠️ Add initialization to Cluster status #12098, ⚠️ Add initialization to Machine Status #12101)
      • Add initialization struct, move ready into it
      • Fix conversions
      • Annotate CAPD CRDs to declare they are implementing the v1beta2 contract
      • Bump v1.11 in test/e2e/data/shared/main/docker/metadata.yaml to v1beta2
    • Stop using v1beta1 conditions, old replica counters, failureReason and failureMessage in controllers
    • Migrate E2E tests to v1beta2
  • [P0] Add v1beta2 ExtensionConfig (ensure v1alpha1 uses v1beta1 conditions, ...): ⚠️ Add v1beta2 API for ExtensionConfig #12197
• Fine tuning of print columns
  • rif 📖 Proposal: Improving status in CAPI resources #10897 (review)
  • rif 📖 Proposal: Improving status in CAPI resources #10897 (comment)
  • from Apr 9th office hours, let's consider if to hide phase by default (aligns to K8s guidelines)
• Documentation
  • Migration guide for v1beta1 => v1beta2 📖 Update contract documentation #12093
    • changes to spec fields (before vs after YAML)
    • changes to status fields (before vs after YAML)
  • Update book (e.g. all the examples v1beta1 --> v1beta2)
  • Update example templates
• Change metrics & dashboards
• Others
  • [P0] Move APIs from api/v1beta2 => api/core/v1beta2: Move APIs into a central location #12203
  • [P1] Deprecate types in v1beta1 packages: at least top-level CRD Go types + heavily used types like Conditions, FailureDomains, ...
  • Think about limitations of v1beta1 <=> v1beta2 conversion: round-trip only works if clients have v1.9 v1beta1 structs
  • Consider if to step up test coverage where API version is relevant (e.g. CC, topology controller, Runtime Extension)

Introduce support for compatible contracts

• Add support for compatible contracts in clusterctl 🌱 Add support for compatible contracts to clusterctl #12018
• Implement v1beta2 contract changes to the contract package + handle fallback to v1beta2 contract
  • Machine controller ✨ Implement v1beta2 contract in Machine controller #12038
    • Improve "path .status.ready: field not found" error logs (xref: https://storage.googleapis.com/kubernetes-ci-logs/logs/periodic-cluster-api-e2e-main/1909623599107411968/artifacts/clusters/bootstrap/logs/capi-system/capi-controller-manager/capi-controller-manager-655d6cb6cc-c5wsz/manager.log)
  • Cluster controller ⚠️ Implement v1beta2 contract in cluster controller, KCP, CABPK #12094
  • Stop calling external.FailuresFrom => we still need this for deprecated.v1beta1 fields
    ⚠️ Implement v1beta2 contract in cluster controller, KCP, CABPK #12094
• Update contract docs 📖 Update contract documentation #12093

Improving status Implementation Phase2 (1.11)

• Promote v1beta conditions
  • Rename packages for condition utils (conditions-->deprecated conditions, v1beta2conditions --> conditions) ⚠️ Swap condition packages #12086
  • Rename condition interfaces and method implementations (current--> deprecated, v1beta2--> current) ⚠️ Swap condition packages #12086
  • Rename condition consts (current--> deprecated, v1beta2--> current) ; mark old conditions type and util as deprecated ⚠️ conditions: add V1Beta1 suffix and remove V1Beta2 suffix from condition types and reasons in v1beta2 packages #12091
• Use new conditions / Audit usage of old conditions: 🌱 Drop usage of v1beta1 conditions #12109
• Stop using failure reason and message ⚠️ Stop using FailureReason and FailureMessage in controllers #12148
• Stop using deprecated replica counters / Audit usage of old fields ⚠️ Stop using deprecated replica counters in controllers #12149
• Other notes (implemented as part of 🌱 Drop usage of v1beta1 conditions #12109)
  • MachineDeployment controller
    • Also fix: Machinedeployment replicas not in sync with Machineset #12035
  • 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
• [P1] Clusterctl
  • clusterctl describe (drop v1beta2 flag, introduce deprecated flag, switch default behaviour in the implementation)

Others

• [P1] Think about version of the Cluster object embedded in lifecycle hooks
• Consider if to run a new scale test (e.g. we changed which changes are relevant for the topology reconciler)
• [P0] Consider dropping DefaulterRemoveUnknownOrOmitableFields option on CAPI mutating web hooks (clarify pro & cons with @sbueringer first)

Backlog for improving status

Looking for volunteers (like everything else MachinePools)

• 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

If and when we have bandwidth

• Drop fake objects from controller tests and use the test/util/builders package

[sivchari]

Hi, @fabriziopandini
If it's ok, can I work on Create v1beta2 types for CAPD(ev) (ensure v1beta1 uses v1beta1 conditions, ...) ?
However, I don't fully understand the steps to take, so it may take some time to respond. If it seems urgent, I can't proceed. If I can proceed, would it be better to refer to the implementation at #12037?

[fabriziopandini]

@sivchari your offer is really appreciated.
I will try to add more details / pointers to previous PRs for Create v1beta2 types for CAPD(ev) (ensure v1beta1 uses v1beta1 conditions, ...) ASAP

[fabriziopandini]

@sivchari I broke down "Create v1beta2 types for CAPD(ev) (ensure v1beta1 uses v1beta1 conditions, ...)" into 4 sequential steps, linking to priort art PRs for the core APIs.

If you need more clarification for some step, feel free to ping me in slack