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, and v1alpha7 some time 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.
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
Detailed changes
- 🌱 Import CAPI v1.6.0 by @EmilienM in #1731
- 🐛 Revert "Move FloatingIP to Bastion spec" by @mdbooth in #1778
- 🐛 Don't apply worker SG to control plane machines by @stephenfin in #1785
- ⚠️ Add v1alpha8 by @EmilienM in #1782
- Remove Tobias and Sean as maintainer by @tobiasgiese in #1793
- 🌱 Update links in release docs by @lentzi90 in #1798
- 🌱 Make it possible to use a pre-created volume type in e2e tests by @maxrantil in #1766
- 🐛 Fix potential panic during instance create by @mandre in #1803
- ✨ Add
flatcar-sysexttemplate to use regular Flatcar images by @tormath1 in #1776 - 🐛 Move flatcar-sysext to v1alpha8 by @EmilienM in #1812
- 🌱 Improve method signatures of conversion functions by @mdbooth in #1813
- ✨ New API for Server Groups by @stephenfin in #1779
- ✨ New API: OpenStackCluster.Spec.ExternalNetwork by @EmilienM in #1790
- ✨ Add flags for configuring rate limits by @tobiasgiese in #1815
- 🐛 Fall back to cluster identityRef in absence of machine identityRef by @stephenfin in #1768
- 🐛 Fix patching OpenstackMachine's immutable spec during reconcile by @strudelPi in #1807
- 🌱 change how we register scheme as per capi 1.6 by @kranurag7 in #1797
- 🐛 fix: skip port deletion when instances have no port by @dulek in #1818
- CI fixes by @mandre in #1820
- 🌱 Bump e2e node images to v1.28.5 by @lentzi90 in #1823
- 🐛 Fix random instance port deletion by @zioc in #1753
- ✨ Change API for OpenStackMachine.Spec.Image by @EmilienM in #1796
- 🌱 Bump controller-tools to v0.14.0 by @mdbooth in #1825
- ✨ Update CI to use OpenStack Bobcat by @EmilienM in #1804
- ⚠️ Move FloatingIP to Bastion spec by @mdbooth in #1824
- ✨ Allow AZs to be Omitted at Runtime by @spjmurray in #1769
- 🐛 Persist API FloatingIP immediately on creation by @mdbooth in #1829
- ✨ Support BYO dual-stack Network by @MaysaMacedo in #1789
- ✨ IPAM provider for floating ips by @bilbobrovall in #1763
- e2e: remove "allow-all-in-cluster-traffic" patch by @EmilienM in #1834
- 🐛 controllers: do not return a RequeueAfter and an error at the same time by @EmilienM in #1839
- 🌱 Enhance Tilt integration with CAPO using a ClusterClass template by @maxrantil in #1833
- 🐛 Fill up OpenStack cluster ReferencedResources with Image ID by @EmilienM in #1845
- 🌱 Update the dev-test ClusterClass by @lentzi90 in #1848
- ⚠️ Convert ServerMetadata from a map to a list by @mdbooth in #1828
- 🌱 Decrease number of machines in e2e tests by @lentzi90 in #1849
- Migrate Dockerfile to use golang 1.21 to match go.mod in project by @huxcrux in #1857
- 🐛Fix a stacktrace in LB logic by removing listener name from an error message when not set by @huxcrux in #1853
- 🌱 test: bump Flatcar version by @tormath1 in #1858
- fix: fix the block device type name in doc by @okozachenko1203 in #1865
- 🐛 api: openstackcluster.status default to false by @EmilienM in #1842
- 🐛 Adds Kind to ipaddress pool name index by @bilbobrovall in #1864
- ✨ add TLS configuration flags by @tuminoid in #1867
- OpenstackFloatingIPPool: Adds popped ip to claimedIPs #1869 by @bilbobrovall in #1870
- 🐛Make sure that allowedCidrs lists are compared correctly to avoid patching LB listener when not needed by @huxcrux in #1854
- 🐛 Prevent the bastion to be removed before it's been disabled by @EmilienM in #1866
- ✨ Move subnet options to SubnetSpec by @dulek in #1856
- ✨ Bump Go to 1.22.0 by @EmilienM in #1877
- 🐛 Fix cluster network cleanup by @dulek in #1880
- 🐛 Ignore 'OS_*' environment variables by @stephenfin in #1883
- ⚠️ Stop serving v1alpha5 by @mdbooth in #1888
- 🌱 Fix doc references to NodeCIDR in v1alpha8 by @mdbooth in #1889
- 🐛 e2e: stop testing upgrades from v1alpha5 (v0.6) by @EmilienM in #1893
- 🌱 Enforce restricted pod security standards by @lentzi90 in #1895
- ✨ Adds MaxIPs to OpenstackFloatingIPPool by @bilbobrovall in #1862
- 🌱 E2E: Add clusterctl upgrade test for v0.9 -> main by @lentzi90 in #1894
- 🐛 loadbalancer: resolve ControlPlaneEndpoint.Host when needed by @EmilienM in #1738
- ✨ AllNodes security groups API by @EmilienM in #1826
- Add emilienm to CAPO reviewers by @EmilienM in #1898
- ✨ Modify OpenStackCluster.Spec.Network API by @MaysaMacedo in #1836
- 🌱 Deprecate v1alpha6 by @EmilienM in #1900
- ✨ Move
spec.allowAllInClusterTraffictospec.ManagedSecurityGroupsby @EmilienM in #1892 - 🐛 e2e: bastion tests by @EmilienM in #1822
- 🐛 Remove
IdentityRef.Kindby @EmilienM in #1903 - ✨ Re-work ports management by @EmilienM in #1788
- ✨ Add support to set
allocation_poolsfor subnet by @dulek in #1847 - 🌱 Rename
v1alpha8tov1beta1by @EmilienM in #1902 - 🌱 Enhancements to how controller-gen is invoked by @mdbooth in #1911
- 🌱 Reduce cyclomatic complexity of ReconcileLoadBalancer by @mdbooth in #1904
- 🐛 Remove logger from scope by @mdbooth in #1913
- 🌱 Reduce cyclomatic complexity of reconcileNetworkComponents by @mdbooth in #1905
- 📖 Add API reference documentation generation by @alexandrevilain in #1702
- 🐛 api/additionalPorts: don't create UDP rules by @EmilienM in #1899
- ⚠️ API cleanup of PortOpts by @mdbooth in #1914
- ⚠️Move CloudName into IdentityRef and make cluster IdentityRef required by @mdbooth in #1915
- 🐛 ci: fix upgrades by dropping cloudName by @EmilienM in #1916
- Transform neutron filter tags into lists by @EmilienM in #1909
- 🐛 Make LB additional ports security-group generation are dynamic by @huxcrux in #1918
- ✨ Add API validation test framework by @mdbooth in #1919
- 🌱 Move webhooks into pkg/webhooks by @mdbooth in #1920
- 🌱 Split v1alpha6 & v1alpha7 conversion into multiple files by @mdbooth in #1923
- ⚠️ Simplify v1alpha6 cluster restorer by @mdbooth in #1925
- Fix CRD generation by @mdbooth in #1928
- 🌱 Allow generating api-docs for individual versions by @mdbooth in #1929
- ⚠️ Rename fields to correctly do uppercase acronyms by @dulek in #1934
- 🐛 CI: Specify external network by name by @mdbooth in #1932
- ✨ Add junit output to e2e tests by @mdbooth in #1935
- 🌱 Move filter conversions out of /api by @mdbooth in #1924
- ⚠️ OpenStackCluster api general cleanup by @mdbooth in #1930
- ⚠️ Cleanup APILoadBalancer by @mdbooth in #1937
- 🌱 Rename Ports fields in status by @mdbooth in #1938
- 🐛 v1alpha5: Fix panic in conversion when port has no binding profile by @mdbooth in #1949
- ⚠️ ImageFilter - add exclusive validation -> pointers by @dulek in #1939
- ✨ Adds IPAM support for floating ips in OpenStackMachine by @bilbobrovall in #1762
- test: bump Flatcar version by @tormath1 in #1936
- 🐛 Fix port name after port creation failure by @mdbooth in #1941
- 🐛 Fix accidental parsing of password by @JanGutter in #1953
- 🐛 Fix a race when updating status before reconcile completes by @mdbooth in #1955
- 🌱 Deduplicate AdoptMachinePorts and AdoptBastionPorts by @mdbooth in #1944
- ⚠️ Remove security group rules from status by @mdbooth in #1957
- 🌱 Add .gitattributes to identify generated files to GitHub by @mdbooth in #1963
- 🌱 Update FloatingIPPool to use v1beta1 by @mdbooth in #1962
- 🐛 Fix server metadata length validation by @mdbooth in #1964
- ⚠️ Bastion cleanup by @dulek in #1959
- 🐛 Revert accidental update to previous API templates by @mdbooth in #1966
- ⚠️ Store []ResolvedPortSpec in ReferencedMachineResources by @mdbooth in #1951
- 🌱 Rename referencedResources and dependentResources by @mdbooth in #1965
- ⚠️ Resolved and Resources become optional pointer types by @mdbooth in #1967
- 🐛 Consolidate and fix v1beta1 fuzzer funcs by @mdbooth in #1981
- ⚠️ NetworkFilter to NetworkParam by @mdbooth in #1972
- ⚠️ SubnetFilter to SubnetParam by @mdbooth in #1971
- 🐛 Add fuzz tests for v1alpha5 conversion by @mdbooth in #1984
- ⚠️SecurityGroupFilter to SecurityGroupParam by @mdbooth in #1974
- ⚠️ Split ImageFilter into ImageParam by @mdbooth in #1970
- ⚠️ RouterFilter to RouterParam by @mdbooth in #1978
- 🐛 Fix v1alpha7 machine restorer and test by @mdbooth in #1987
- ⚠️ Bastion is enabled by default if specified by @mdbooth in #1990
- ⚠️ Move InstanceID from Spec to Status by @mdbooth in #1988
- 🐛 Fix multiple panics in restore functions by @mdbooth in #1989
- ⚠️ ServerGroupFilter to ServerGroupParam by @mdbooth in #1991
- 📖 Document changes to Filters by @mdbooth in #1982
- ✨ Add API docs for v1alpha1 by @mdbooth in #1993
- 🌱 Bump version artifacts for release-0.10 by @mdbooth in #1994
New Contributors
- @mandre made their first contribution in #1803
- @strudelPi made their first contribution in #1807
- @kranurag7 made their first contribution in #1797
- @zioc made their first contribution in #1753
- @bilbobrovall made their first contribution in #1763
- @JanGutter made their first contribution in #1953
Full Changelog: v0.9.0...v0.10.0-alpha.0