Skip to content

Commit f1ff3e3

Browse files
committed
Add docs
1 parent 93de903 commit f1ff3e3

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
4+
5+
- [v1alpha7 compared to v1alpha8](#v1alpha7-compared-to-v1alpha8)
6+
- [Migration](#migration)
7+
- [API Changes](#api-changes)
8+
- [`OpenStackMachine`](#openstackmachine)
9+
- [Change to `serverGroupID`](#change-to-servergroupid)
10+
11+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
12+
13+
# v1alpha7 compared to v1alpha8
14+
15+
> ⚠️ v1alpha8 has not been released yet.
16+
## Migration
17+
18+
All users are encouraged to migrate their usage of the CAPO CRDs from older versions to `v1alpha8`. This includes yaml files and source code. As CAPO implements automatic conversions between the CRD versions, this migration can happen after installing the new CAPO release.
19+
20+
## API Changes
21+
22+
This only documents backwards incompatible changes. Fields that were added to v1alpha8 are not listed here.
23+
24+
### `OpenStackMachine`
25+
26+
#### Change to `serverGroupID`
27+
28+
The `spec`'s field `serverGroupID` has been renamed to `serverGroup` and isn't a string anymore but a reference to a `ServerGroupFilter` object.
29+
30+
```yaml
31+
serverGroupID: "e60f19e7-cb37-49f9-a2ee-0a1281f6e03e"
32+
```
33+
34+
becomes
35+
36+
```yaml
37+
serverGroup:
38+
id: "e60f19e7-cb37-49f9-a2ee-0a1281f6e03e"
39+
```
40+
41+
It is now possible to specify a `ServerGroupFilter` object to select the external network to use for the cluster. The `ServerGroupFilter` object allows to select the server group by name or by ID.
42+
43+
```yaml
44+
serverGroup:
45+
name: "workers"
46+
```
47+
48+
If a server group is provided and found, it'll be added to `OpenStackMachine.Status.ReferencedResources.ServerGroupID`. If the server group can't be found or filter matches multiple server groups, an error will be returned.
49+
If empty object or null is provided, Machine will not be added to any server group and `OpenStackMachine.Status.ReferencedResources.ServerGroupID` will be empty.

0 commit comments

Comments
 (0)