Cluster API v1.3 compared to v1.4
This document provides an overview over relevant changes between Cluster API v1.3 and v1.4 for maintainers of providers and consumers of our Go API.
Minimum Go version
- The Go version used by Cluster API is still Go 1.19.x
Note: Only the most relevant dependencies are listed,
gomega dependencies in Cluster API are kept in sync with the versions used by
- sigs.k8s.io/kind: v0.17.x => v0.18.x
- sigs.k8s.io/controller-runtime: v0.13.x => v0.14.x
- sigs.k8s.io/controller-tools: v0.10.x => v0.11.x
- github.com/joelanford/go-apidiff: 0.5.0 => 0.6.0
Changes by Kind
The api versions
v1alpha4are deprecated and will be removed.
v1alpha3will be removed in v1.5
v1alpha4will be removed in v1.6
For more information please see the note in the contributors guide.
util/conversion.GetCRDWithContracthas been removed.
clusterctl backuphas been removed.
clusterctl restorehas been removed.
api/v1beta1.MachineHealthCheckSuccededConditioncondition type has been removed.
controllers/external/util.CloneTemplateInputhas been removed.
- The option
clusterctl initsubcommand has been removed.
exp/runtime/server.NewServerhas been removed.
clusterctl describe clustersubcommand has been removed
api/v1beta1.ClusterTopologyManagedFieldsAnnotationfield has been removed.
api/v1beta1.PopulateDefaultsMachineDeploymentfunc has been removed.
APIReaderparameter because it’s not required anymore as we now only handle CRDs with compliant names.
Backup(options BackupOptions) errorin the Client interface has been removed.
Restore(options RestoreOptions) errorin the Client interface has been removed.
cmd/clusterctl/client.RolloutOptionshas been removed,
RolloutUndoOptionshave been added instead.
- Annotation constant
DisableMachineCreatehas been updated to
- Below Label constant have been updated
- Below Condition and Reason constants have been updated
api/v1beta1.MachineDeployment.Defaultfunc has been replaced through
- clusterctl now emits an error for provider CRDs which don’t comply with the CRD naming conventions. This warning can be skipped for resources not referenced by Cluster API
core resources via the
clusterctl.cluster.x-k8s.io/skip-crd-name-preflight-checkannotation. The contracts specify:
The CRD name must have the format produced by sigs.k8s.io/cluster-api/util/contract.CalculateCRDName(Group, Kind)
clusterctl upgrade applyno longer requires a namespace when updating providers. It is now optional and in a future release it will be deprecated. The new syntax is
WatchDeploymentLogsis changed to
WatchDeploymentLogsByName, it works same as before. Another function
WatchDeploymentLogsByLabelSelectoris added to stream logs of deployment by label selector.
- Cluster API controllers are now using an explicit security context by default.
- It is recommended to drop usages of
logs.AddFlags(fs, logs.SkipLoggingConfigurationFlags()). It was previously used to configure deprecated logging flags, but with the bump to component-base
v0.26.0this function is not configuring any flags anymore. Please note that the following logging flags have been removed: (in
component-base, but this affects all CAPI controllers):
--stderrthreshold. For more information, please see: https://github.com/kubernetes/enhancements/issues/2845
- A new
KCPRemediationSpectest has been added providing better test coverage for KCP remediation most common use cases. As a consequence
MachineRemediationSpechas been renamed to
MachineDeploymentRemediationSpecand now only tests remediation of worker machines (NOTE: we plan to improve this test as well in a future iteration).
test/infrastructure/docker/internal/third_party/forked/loadbalancerhas been moved to
test/infrastructure/docker/internal/loadbalancerto allow it to diverge from the upstream Kind package.
Suggested changes for providers
- Providers should add an explicit security context to their controllers deployment, see #7831 for reference.