Release v0.10.0

[mdbooth]

Breaking API Changes

v0.10.0 is a major update which brings major changes to the API.

v1alpha5 is no longer served

If you are still using v1alpha5, this will not work in v0.10.0. However, for this release only objects are still defined in the CRDs and the code is still present, so as a temporary workaround it is possible to manually edit the CRDs to set versions.served to true for v1alpha5 objects. This is not tested, and we have low confidence that this will work without problems. Some manual effort may be required to check and fix automatically converted objects.

v1alpha6 and v1alpha7 are deprecated

v1alpha6 and v1alpha7 objects will be automatically converted to v1beta during use. This is well tested. We don’t anticipate problems with these conversions.

We will stop serving and testing v1alpha6 in the next release.

v1alpha7 is not marked deprecated in v0.10.0 to allow a switch-over period without deprecation warnings, but will be marked deprecated in the next release. Will will stop serving and testing it in a release after that.

You should update to use v1beta1 natively as soon as possible.

v1beta1 is released

v1beta1 marks a major update to the CAPO API. The specific changes from v1alpha7 are documented here: https://cluster-api-openstack.sigs.k8s.io/topics/crd-changes/v1alpha7-to-v1beta1

More than this, though, it marks an intention by the maintainers to stop making breaking changes. The API will continue to evolve, but we will make every effort to do this without introducing more backwards-incompatible changes.

Removal of hardcoded Calico CNI security group rules

This is documented more completely in the API upgrade documentation.

Prior to v1beta1, when using managed security groups we would automatically add certain rules which were specific to Calico CNI. It was not possible to add rules for any other CNI. A common way to work round this was to set allowAllInClusterTraffic: true.

With v1beta1 there are no longer any implicit rules for any CNI. However, it is now possible to specify custom rules in the cluster spec which will be automatically added to managed security groups. Users of Calico CNI must now add these rules explicitly. Users of other CNIs now have the option of using managed security groups.

Calico CNI rules will be added automatically when upgrading to v1beta1 from a previous API version.

The Calico CNI rules have been added to the release templates, so for now creating a cluster with clusterctl will continue to have Calico rules when using the default templates.

Management cluster changes

Removal of MutatingWebhookConfiguration

CAPO no longer uses a mutating webhook, and its configuration is removed. If you upgrade your management cluster with clusterctl this will be handled correctly. If you do it manually you must ensure you remove the MutatingWebhookConfiguration capo-mutating-webhook-configuration. If you do not you may see errors like the one in #1927.

Minimum management cluster version is now 1.25

v0.10.0 now uses https://kubernetes.io/docs/reference/using-api/cel/ for some API validations, which only became available without a feature gate in 1.25. Consequently we now require the management cluster to be at least k8s 1.25.

Highlighted new features

API Reference documentation

We now automatically publish API reference documentation! The documentation for v1beta1 can be found here: https://cluster-api-openstack.sigs.k8s.io/api/v1beta1/api

Floating IP IPAM Provider

It is now possible to allocate floating IPs for individual machines using the new Floating IP IPAM Provider documented here: https://cluster-api-openstack.sigs.k8s.io/api/v1alpha1/api#infrastructure.cluster.x-k8s.io/v1alpha1.OpenStackFloatingIPPool

Attach them to a machine via the new floatingIPPoolRef in OpenStackMachineSpec: https://cluster-api-openstack.sigs.k8s.io/api/v1beta1/api#infrastructure.cluster.x-k8s.io/v1beta1.OpenStackMachineSpec

What's Changed

New Features

• ✨ Add flatcar-sysext template to use regular Flatcar images by @tormath1 in ✨ Add flatcar-sysext template to use regular Flatcar images #1776
• ✨ Add flags for configuring rate limits by @tobiasgiese in ✨ Add flags for configuring rate limits #1815
• ✨ Change API for OpenStackMachine.Spec.Image by @EmilienM in ✨ Change API for OpenStackMachine.Spec.Image #1796
• ✨ Update CI to use OpenStack Bobcat by @EmilienM in ✨ Update CI to use OpenStack Bobcat #1804
• ✨ Allow AZs to be Omitted at Runtime by @spjmurray in ✨ Allow AZs to be Omitted at Runtime #1769
• ✨ Support BYO dual-stack Network by @MaysaMacedo in ✨ Support BYO dual-stack Network #1789
• ✨ IPAM provider for floating ips by @bilbobrovall in ✨ IPAM provider for floating ips #1763
• ✨ add TLS configuration flags by @tuminoid in ✨ add TLS configuration flags #1867
• ✨ Adds MaxIPs to OpenstackFloatingIPPool by @bilbobrovall in ✨ Adds MaxIPs to OpenstackFloatingIPPool #1862
• ✨ Re-work ports management by @EmilienM in ✨ Re-work ports management #1788
• ✨ Add support to set allocation_pools for subnet by @dulek in https://github.com/kubernetes-sigs/cluster-api-provider-
• ✨ Add API docs for v1alpha1 by @mdbooth in ✨ Add API docs for v1alpha1 #1993
• ✨ Adds IPAM support for floating ips in OpenStackMachine by @bilbobrovall in ✨ Adds IPAM support for floating ips in OpenStackMachine #1762
• 🐛 Fall back to cluster identityRef in absence of machine identityRef by @stephenfin in 🐛 Fall back to cluster identityRef in absence of machine identityRef #1768
• 🌱 Enforce restricted pod security standards by @lentzi90 in 🌱 Enforce restricted pod security standards #1895
• 📖 Add API reference documentation generation by @alexandrevilain in 📖 Add API reference documentation generation #1702
• 🐛 Make LB additional ports security-group generation are dynamic by @huxcrux in 🐛 Make LB additional ports security-group generation are dynamic #1918
• feat: add configurable loadbalancer network by @oblazek in feat: add configurable loadbalancer network #1922
• 🐛 Include more device_owners when looking for a port for floating ip by @bilbobrovall in 🐛 Include more device_owners when looking for a port for floating ip #1996

Bug fixes

• 🐛 Don't apply worker SG to control plane machines by @stephenfin in 🐛 Don't apply worker SG to control plane machines #1785
• 🐛 Fix potential panic during instance create by @mandre in 🐛 Fix potential panic during instance create #1803
• 🐛 Fix patching OpenstackMachine's immutable spec during reconcile by @strudelPi in 🐛 Fix patching OpenstackMachine's immutable spec during reconcile #1807
• 🐛 fix: skip port deletion when instances have no port by @dulek in 🐛 fix: skip port deletion when instances have no port #1818
• 🐛 Fix random instance port deletion by @zioc in 🐛 Fix random instance port deletion #1753
• 🐛 Persist API FloatingIP immediately on creation by @mdbooth in 🐛 Persist API FloatingIP immediately on creation #1829
• 🐛 controllers: do not return a RequeueAfter and an error at the same time by @EmilienM in 🐛 controllers: do not return a RequeueAfter and an error at the same time #1839
• 🐛Fix a stacktrace in LB logic by removing listener name from an error message when not set by @huxcrux in 🐛Fix a stacktrace in LB logic by removing listener name from an error message when not set #1853
• 🐛Make sure that allowedCidrs lists are compared correctly to avoid patching LB listener when not needed by @huxcrux in 🐛Make sure that allowedCidrs lists are compared correctly to avoid patching LB listener when not needed #1854
• 🐛 Prevent the bastion to be removed before it's been disabled by @EmilienM in 🐛 Prevent the bastion to be removed before it's been disabled #1866
• 🐛 Ignore 'OS_*' environment variables by @stephenfin in 🐛 Ignore 'OS_*' environment variables #1883
• 🐛 Fix cluster network cleanup by @dulek in 🐛 Fix cluster network cleanup #1880
• 🐛 loadbalancer: resolve ControlPlaneEndpoint.Host when needed by @EmilienM in 🐛 loadbalancer: resolve ControlPlaneEndpoint.Host when needed #1738
• 🐛 api/additionalPorts: don't create UDP rules by @EmilienM in 🐛 api/additionalPorts: don't create UDP rules #1899
• 🐛 v1alpha5: Fix panic in conversion when port has no binding profile by @mdbooth in 🐛 v1alpha5: Fix panic in conversion when port has no binding profile #1949
• 🐛 Fix accidental parsing of password by @JanGutter in 🐛 Fix accidental parsing of password #1953

Documentation

• 🌱 Update links in release docs by @lentzi90 in 🌱 Update links in release docs #1798
• fix: fix the block device type name in doc by @okozachenko1203 in fix: fix the block device type name in doc #1865
• 🌱 Fix doc references to NodeCIDR in v1alpha8 by @mdbooth in 🌱 Fix doc references to NodeCIDR in v1alpha8 #1889

Administrative

• Remove Tobias and Sean as maintainer by @tobiasgiese in Remove Tobias and Sean as maintainer #1793
• Add emilienm to CAPO reviewers by @EmilienM in Add emilienm to CAPO reviewers #1898
  openstack/pull/1836

API changes

• ⚠️ Stop serving v1alpha5 by @mdbooth in ⚠️ Stop serving v1alpha5 #1888
• 🌱 Deprecate v1alpha6 by @EmilienM in 🌱 Deprecate v1alpha6 #1900
• 🐛 Revert "Move FloatingIP to Bastion spec" by @mdbooth in 🐛 Revert "Move FloatingIP to Bastion spec" #1778
• ⚠️ Add v1alpha8 by @EmilienM in ⚠️ Add v1alpha8 #1782
• ✨ New API for Server Groups by @stephenfin in ✨ New API for Server Groups #1779
• ✨ New API: OpenStackCluster.Spec.ExternalNetwork by @EmilienM in ✨ New API: OpenStackCluster.Spec.ExternalNetwork #1790
• ✨ Move subnet options to SubnetSpec by @dulek in ✨ Move subnet options to SubnetSpec #1856
• ✨ AllNodes security groups API by @EmilienM in ✨ AllNodes security groups API #1826
• ✨ Modify OpenStackCluster.Spec.Network API by @MaysaMacedo in https://github.com/kubernetes-sigs/cluster-api-provider-
• ✨ Move spec.allowAllInClusterTraffic to spec.ManagedSecurityGroups by @EmilienM in ✨ Move spec.allowAllInClusterTraffic to spec.ManagedSecurityGroups #1892
• ⚠️ Move FloatingIP to Bastion spec by @mdbooth in ⚠️ Move FloatingIP to Bastion spec #1824
• ⚠️ Convert ServerMetadata from a map to a list by @mdbooth in ⚠️ Convert ServerMetadata from a map to a list #1828
• 🐛 api: openstackcluster.status default to false by @EmilienM in 🐛 api: openstackcluster.status default to false #1842
• 🐛 Adds Kind to ipaddress pool name index by @bilbobrovall in 🐛 Adds Kind to ipaddress pool name index #1864
• OpenstackFloatingIPPool: Adds popped ip to claimedIPs OpenstackFloatingIPPool: Can return the same IP for multiple claims #1869 by @bilbobrovall in OpenstackFloatingIPPool: Adds popped ip to claimedIPs #1869  #1870
• 🐛 Remove IdentityRef.Kind by @EmilienM in 🐛 Remove IdentityRef.Kind #1903
  openstack/pull/1847
• 🌱 Rename v1alpha8 to v1beta1 by @EmilienM in 🌱 Rename v1alpha8 to v1beta1 #1902
• ⚠️ API cleanup of PortOpts by @mdbooth in ⚠️ API cleanup of PortOpts #1914
• ⚠️Move CloudName into IdentityRef and make cluster IdentityRef required by @mdbooth in ⚠️Move CloudName into IdentityRef and make cluster IdentityRef required #1915
• Transform neutron filter tags into lists by @EmilienM in Transform neutron filter tags into lists #1909
• ⚠️ Rename fields to correctly do uppercase acronyms by @dulek in ⚠️ Rename fields to correctly do uppercase acronyms #1934
• ⚠️ OpenStackCluster api general cleanup by @mdbooth in ⚠️ OpenStackCluster api general cleanup #1930
• ⚠️ Cleanup APILoadBalancer by @mdbooth in ⚠️ Cleanup APILoadBalancer #1937
• 🌱 Rename Ports fields in status by @mdbooth in 🌱 Rename Ports fields in status #1938
• ⚠️ ImageFilter - add exclusive validation -> pointers by @dulek in ⚠️ ImageFilter - add exclusive validation -> pointers #1939
• ⚠️ Remove security group rules from status by @mdbooth in ⚠️ Remove security group rules from status #1957
• 🌱 Update FloatingIPPool to use v1beta1 by @mdbooth in 🌱 Update FloatingIPPool to use v1beta1 #1962
• 🐛 Fix server metadata length validation by @mdbooth in 🐛 Fix server metadata length validation #1964
• ⚠️ Bastion cleanup by @dulek in ⚠️ Bastion cleanup #1959
• ⚠️ Store []ResolvedPortSpec in ReferencedMachineResources by @mdbooth in ⚠️ Store []ResolvedPortSpec in ReferencedMachineResources #1951
• 🌱 Rename referencedResources and dependentResources by @mdbooth in 🌱 Rename referencedResources and dependentResources #1965
• ⚠️ Resolved and Resources become optional pointer types by @mdbooth in ⚠️ Resolved and Resources become optional pointer types #1967
• ⚠️ NetworkFilter to NetworkParam by @mdbooth in ⚠️ NetworkFilter to NetworkParam #1972
• ⚠️ SubnetFilter to SubnetParam by @mdbooth in ⚠️ SubnetFilter to SubnetParam #1971
• ⚠️SecurityGroupFilter to SecurityGroupParam by @mdbooth in ⚠️SecurityGroupFilter to SecurityGroupParam #1974
• ⚠️ Split ImageFilter into ImageParam by @mdbooth in ⚠️ Split ImageFilter into ImageParam #1970
• ⚠️ RouterFilter to RouterParam by @mdbooth in ⚠️ RouterFilter to RouterParam #1978
• ⚠️ Bastion is enabled by default if specified by @mdbooth in ⚠️ Bastion is enabled by default if specified #1990
• ⚠️ Move InstanceID from Spec to Status by @mdbooth in ⚠️ Move InstanceID from Spec to Status #1988
• ⚠️ ServerGroupFilter to ServerGroupParam by @mdbooth in ⚠️ ServerGroupFilter to ServerGroupParam #1991
• 📖 Document changes to Filters by @mdbooth in 📖 Document changes to Filters #1982
• 🐛 Rules are optional in security group rules before v1beta1 by @mdbooth in 🐛 Rules are optional in security group rules before v1beta1 #2000
• 🐛 Make floatingIPNetwork a pointer and if there's only one external network use it as default by @bilbobrovall in 🐛 Make floatingIPNetwork a pointer and if there's only one external network use it as default #1998
• 📖 Document the change of instanceID in v1beta1 by @pierreprinetti in 📖 Document the change of instanceID in v1beta1 #2003
• Add opt to use AZ for APISeverLoadBalancer by @dulek in Add opt to use AZ for APISeverLoadBalancer #2004
• ⚠️ Allow explicitly empty volume AZ by @mdbooth in ⚠️ Allow explicitly empty volume AZ #2008

Changes to build, test, and CI, minor changes, and code tidy ups

• ✨ Add API validation test framework by @mdbooth in ✨ Add API validation test framework #1919
• ✨ Add junit output to e2e tests by @mdbooth in ✨ Add junit output to e2e tests #1935
• 🌱 Make it possible to use a pre-created volume type in e2e tests by @maxrantil in 🌱 Make it possible to use a pre-created volume type in e2e tests  #1766
• 🐛 Move flatcar-sysext to v1alpha8 by @EmilienM in 🐛 Move flatcar-sysext to v1alpha8 #1812
• CI fixes by @mandre in CI fixes #1820
• 🌱 Bump e2e node images to v1.28.5 by @lentzi90 in 🌱 Bump e2e node images to v1.28.5 #1823
• e2e: remove "allow-all-in-cluster-traffic" patch by @EmilienM in e2e: remove "allow-all-in-cluster-traffic" patch #1834
• 🌱 Decrease number of machines in e2e tests by @lentzi90 in 🌱 Decrease number of machines in e2e tests #1849
• Migrate Dockerfile to use golang 1.21 to match go.mod in project by @huxcrux in Migrate Dockerfile to use golang 1.21 to match go.mod in project #1857
• 🌱 test: bump Flatcar version by @tormath1 in 🌱 test: bump Flatcar version #1858
• 🌱 Import CAPI v1.6.0 by @EmilienM in 🌱 Import CAPI v1.6.0 #1731
• ✨ Bump Go to 1.22.0 by @EmilienM in ✨ Bump Go to 1.22.0 #1877
• 🌱 Improve method signatures of conversion functions by @mdbooth in 🌱 Improve method signatures of conversion functions #1813
• 🌱 change how we register scheme as per capi 1.6 by @kranurag7 in 🌱 change how we register scheme as per capi 1.6 #1797
• 🌱 Bump controller-tools to v0.14.0 by @mdbooth in 🌱 Bump controller-tools to v0.14.0 #1825
• 🌱 Enhance Tilt integration with CAPO using a ClusterClass template by @maxrantil in 🌱 Enhance Tilt integration with CAPO using a ClusterClass template #1833
• 🐛 Fill up OpenStack cluster ReferencedResources with Image ID by @EmilienM in 🐛 Fill up OpenStack cluster ReferencedResources with Image ID #1845
• 🌱 Update the dev-test ClusterClass by @lentzi90 in 🌱 Update the dev-test ClusterClass #1848
• 🐛 e2e: stop testing upgrades from v1alpha5 (v0.6) by @EmilienM in 🐛 e2e: stop testing upgrades from v1alpha5 (v0.6) #1893
• 🌱 E2E: Add clusterctl upgrade test for v0.9 -> main by @lentzi90 in 🌱 E2E: Add clusterctl upgrade test for v0.9 -> main #1894
• 🐛 e2e: bastion tests by @EmilienM in 🐛 e2e: bastion tests #1822
• 🌱 Enhancements to how controller-gen is invoked by @mdbooth in 🌱 Enhancements to how controller-gen is invoked #1911
• 🌱 Reduce cyclomatic complexity of ReconcileLoadBalancer by @mdbooth in 🌱 Reduce cyclomatic complexity of ReconcileLoadBalancer #1904
• 🐛 Remove logger from scope by @mdbooth in 🐛 Remove logger from scope #1913
• 🌱 Reduce cyclomatic complexity of reconcileNetworkComponents by @mdbooth in 🌱 Reduce cyclomatic complexity of reconcileNetworkComponents #1905
• 🐛 ci: fix upgrades by dropping cloudName by @EmilienM in 🐛 ci: fix upgrades by dropping cloudName #1916
• 🌱 Move webhooks into pkg/webhooks by @mdbooth in 🌱 Move webhooks into pkg/webhooks #1920
• 🌱 Split v1alpha6 & v1alpha7 conversion into multiple files by @mdbooth in 🌱 Split v1alpha6 & v1alpha7 conversion into multiple files #1923
• ⚠️ Simplify v1alpha6 cluster restorer by @mdbooth in ⚠️ Simplify v1alpha6 cluster restorer #1925
• Fix CRD generation by @mdbooth in Fix CRD generation #1928
• 🌱 Allow generating api-docs for individual versions by @mdbooth in 🌱 Allow generating api-docs for individual versions #1929
• 🐛 CI: Specify external network by name by @mdbooth in 🐛 CI: Specify external network by name #1932
• 🌱 Move filter conversions out of /api by @mdbooth in 🌱 Move filter conversions out of /api #1924
• 🌱 Add .gitattributes to identify generated files to GitHub by @mdbooth in 🌱 Add .gitattributes to identify generated files to GitHub #1963
• test: bump Flatcar version by @tormath1 in test: bump Flatcar version #1936
• 🐛 Fix port name after port creation failure by @mdbooth in 🐛 Fix port name after port creation failure #1941
• 🐛 Fix a race when updating status before reconcile completes by @mdbooth in 🐛 Fix a race when updating status before reconcile completes #1955
• 🌱 Deduplicate AdoptMachinePorts and AdoptBastionPorts by @mdbooth in 🌱 Deduplicate AdoptMachinePorts and AdoptBastionPorts #1944
• 🐛 Revert accidental update to previous API templates by @mdbooth in 🐛 Revert accidental update to previous API templates #1966
• 🐛 Consolidate and fix v1beta1 fuzzer funcs by @mdbooth in 🐛 Consolidate and fix v1beta1 fuzzer funcs #1981
• 🐛 Add fuzz tests for v1alpha5 conversion by @mdbooth in 🐛 Add fuzz tests for v1alpha5 conversion #1984
• 🐛 Fix v1alpha7 machine restorer and test by @mdbooth in 🐛 Fix v1alpha7 machine restorer and test #1987
• 🐛 Fix multiple panics in restore functions by @mdbooth in 🐛 Fix multiple panics in restore functions #1989
• 🌱 Bump version artifacts for release-0.10 by @mdbooth in 🌱 Bump version artifacts for release-0.10 #1994
• 🌱 Remove legacy v1alpha7 filterconvert utils by @mdbooth in 🌱 Remove legacy v1alpha7 filterconvert utils #1992
• 🌱 Minor improvements to api validation tests by @mdbooth in 🌱 Minor improvements to api validation tests #2001
• 🌱 Cleanup security group created by e2e test by @mdbooth in 🌱 Cleanup security group created by e2e test #2010
• 🐛 Don't try to resolve machine on delete if cluster not ready by @mdbooth in 🐛 Don't try to resolve machine on delete if cluster not ready #2006
• 🐛 Fix idempotent restore when setting ControlPlaneEndpoint by @mdbooth in 🐛 Fix idempotent restore when setting ControlPlaneEndpoint #2011
• 🌱 Bump k8s dep to 0.29.3 by @mdbooth in 🌱 Bump k8s dep to 0.29.3 #2014
• 🐛 Fix crash on delete with no bastion by @mdbooth in 🐛 Fix crash on delete with no bastion #2017

New Contributors

• @mandre made their first contribution in 🐛 Fix potential panic during instance create #1803
• @strudelPi made their first contribution in 🐛 Fix patching OpenstackMachine's immutable spec during reconcile #1807
• @kranurag7 made their first contribution in 🌱 change how we register scheme as per capi 1.6 #1797
• @zioc made their first contribution in 🐛 Fix random instance port deletion #1753
• @bilbobrovall made their first contribution in ✨ IPAM provider for floating ips #1763
• @JanGutter made their first contribution in 🐛 Fix accidental parsing of password #1953
• @oblazek made their first contribution in feat: add configurable loadbalancer network #1922
• @nguyenhuukhoi made their first contribution in Add opt to use AZ for APISeverLoadBalancer #2004

Full Changelog: v0.9.0...v0.10.0

---

This discussion was created from the release Release v0.10.0.