Skip to content

Commit 7f94159

Browse files
committed
Document BYO dual-stack network
This commit adds a section to the book explaining the modification of the `OpenStackClusterSpec.Subnet` API field.
1 parent 0bb9c7e commit 7f94159

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/book/src/topics/crd-changes/v1alpha7-to-v1alpha8.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
- [Changes to image](#change-to-image)
1313
- [Removal of imageUUID](#removal-of-imageuuid)
1414
- [Change to floatingIP](#change-to-floatingip)
15+
- [Change to subnet](#change-to-subnet)
1516

1617
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1718

@@ -156,3 +157,23 @@ spec:
156157
bastion:
157158
floatingIP: "1.2.3.4"
158159
```
160+
161+
#### ⚠️ Change to subnet
162+
163+
In v1alpha8, `Subnet` of `OpenStackCluster` is modified to `Subnets` to allow specification of two existent subnets for the dual-stack scenario.
164+
165+
```yaml
166+
subnet:
167+
id: a532beb0-c73a-4b5d-af66-3ad05b73d063
168+
```
169+
170+
In v1alpha8, this will be automatically converted to:
171+
172+
```yaml
173+
subnets:
174+
- id: a532beb0-c73a-4b5d-af66-3ad05b73d063
175+
```
176+
177+
`Subnets` allows specifications of maximum two `SubnetFilter` one being IPv4 and the other IPv6. Both subnets must be on the same network. Any filtered subnets will be added to `OpenStackCluster.Status.Network.Subnets`.
178+
179+
When subnets are not specified on `OpenStackCluster` and only the network is, the network is used to identify the subnets to use. If more than two subnets exist in the network, the user must specify which ones to use by defining the `OpenStackCluster.Spec.Subnets` field.

0 commit comments

Comments
 (0)