Skip to content

Commit

Permalink
Document BYO dual-stack network
Browse files Browse the repository at this point in the history
This commit adds a section to the book explaining the
modification of the `OpenStackClusterSpec.Subnet` API field.
  • Loading branch information
MaysaMacedo committed Jan 18, 2024
1 parent ebe8b00 commit 7006019
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/book/src/topics/crd-changes/v1alpha7-to-v1alpha8.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- [Changes to image](#change-to-image)
- [Removal of imageUUID](#removal-of-imageuuid)
- [Change to floatingIP](#change-to-floatingip)
- [Change to subnet](#change-to-subnet)

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

Expand Down Expand Up @@ -156,3 +157,23 @@ spec:
bastion:
floatingIP: "1.2.3.4"
```

#### ⚠️ Change to subnet

In v1alpha8, `Subnet` of `OpenStackCluster` is modified to `Subnets` to allow specification of two existent subnets for the dual-stack scenario.

```yaml
subnet:
id: a532beb0-c73a-4b5d-af66-3ad05b73d063
```

In v1alpha8, this will be automatically converted to:

```yaml
subnets:
- id: a532beb0-c73a-4b5d-af66-3ad05b73d063
```

`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`.

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 comments on commit 7006019

Please sign in to comment.