Skip to content

Commit f3e2be6

Browse files
authored
Merge pull request #900 from Nordix/document-ports-feature
📖 Document custom ports feature
2 parents 58fb822 + 0d791a7 commit f3e2be6

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/book/src/clusteropenstack/configuration.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
- [Network Filters](#network-filters)
1818
- [Multiple Networks](#multiple-networks)
1919
- [Subnet Filters](#subnet-filters)
20+
- [Ports](#ports)
2021
- [Tagging](#tagging)
2122
- [Metadata](#metadata)
2223
- [Boot From Volume](#boot-from-volume)
@@ -206,6 +207,30 @@ spec:
206207
name: <subnet-name>
207208
```
208209
210+
## Ports
211+
212+
A server can also be connected to networks by describing what ports to create. Describing a server's connection with `ports` allows for finer and more advanced configuration. For example, you can specify per-port security groups, fixed IPs or VNIC type.
213+
214+
```yaml
215+
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha4
216+
kind: OpenStackMachine
217+
metadata:
218+
name: <cluster-name>-controlplane
219+
namespace: <cluster-name>
220+
spec:
221+
ports:
222+
- networkId: <your-network-id>
223+
description: <your-custom-port-description>
224+
vnicType: normal
225+
fixedIPs:
226+
- subnetId: <your-subnet-id>
227+
ipAddress: <your-fixed-ip>
228+
securityGroups:
229+
- <your-security-group-id>
230+
```
231+
232+
Any such ports are created in addition to ports used for connections to networks or subnets.
233+
209234
## Tagging
210235

211236
If your cluster supports tagging servers, you have the ability to tag all resources created by the cluster in the `cluster.yaml` file. Here is an example how to configure tagging:

0 commit comments

Comments
 (0)