Skip to content

Commit 6d48213

Browse files
committed
Add documentation for v1beta2 flavor change
Document the change of the v1beta2 flavor
1 parent 1eb4414 commit 6d48213

File tree

3 files changed

+146
-44
lines changed

3 files changed

+146
-44
lines changed

docs/book/src/api/v1beta2/api.md

Lines changed: 123 additions & 42 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/book/src/clusteropenstack/configuration.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -759,7 +759,9 @@ spec:
759759
bastion:
760760
enabled: true
761761
spec:
762-
flavor: <Flavor name>
762+
flavor:
763+
filter:
764+
name: <Flavor name>
763765
image: <Image name>
764766
sshKeyName: <Key pair name>
765767
```

docs/book/src/topics/crd-changes/v1beta1-to-v1beta2.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- [v1beta1 compared to v1beta2](#v1beta1-compared-to-v1beta2)
66
- [Migration](#migration)
77
- [API Changes](#api-changes)
8+
- [Flavor field restructure](#flavor-field-restructure)
89
- [Conditions format change](#conditions-format-change)
910
- [Removal of deprecated status fields](#removal-of-deprecated-status-fields)
1011
- [FailureDomains representation change](#failuredomains-representation-change)
@@ -19,12 +20,30 @@ All users are encouraged to migrate their usage of the CAPO CRDs from `v1beta1`
1920

2021
**For most users, no action is required.** The conversion webhooks handle all translation between v1beta1 and v1beta2 automatically. The changes below are relevant primarily for developers writing controllers or tooling that reads CAPO objects directly.
2122

22-
There are **no breaking changes to spec fields**. All spec fields from v1beta1 are present and unchanged in v1beta2. The breaking changes are limited to status fields and internal representations.
23+
The v1beta2 API introduces **no removals** to spec fields. All existing spec fields from v1beta1 are preserved, though some have been renamed or restructured for consistency. Status fields have additional breaking changes beyond renaming.
2324

2425
## API Changes
2526

2627
This only documents backwards incompatible changes. Fields that were added to v1beta2 are not listed here.
2728

29+
### Flavor field restructure
30+
31+
`spec.flavor` (string) and `spec.flavorID` have been replaced by a structured `spec.flavor` object,
32+
following the ID/Filter pattern used by other fields. This applies to `OpenStackMachine` and to
33+
`OpenStackCluster`.
34+
35+
```diff
36+
spec:
37+
- flavor:
38+
- flavorID:
39+
+ flavor:
40+
+ id:
41+
+ filter:
42+
+ name:
43+
```
44+
45+
For `OpenStackCluster` the same change applies under `spec.bastion.spec.flavor`.
46+
2847
### Conditions format change
2948

3049
Conditions have changed from CAPI v1beta1 `Conditions` type to standard Kubernetes `[]metav1.Condition`.

0 commit comments

Comments
 (0)