Skip to content

Commit

Permalink
Document custom ports feature in the book
Browse files Browse the repository at this point in the history
  • Loading branch information
macaptain committed Jun 9, 2021
1 parent 62092ce commit 0d791a7
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/book/src/clusteropenstack/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- [Network Filters](#network-filters)
- [Multiple Networks](#multiple-networks)
- [Subnet Filters](#subnet-filters)
- [Ports](#ports)
- [Tagging](#tagging)
- [Metadata](#metadata)
- [Boot From Volume](#boot-from-volume)
Expand Down Expand Up @@ -206,6 +207,30 @@ spec:
name: <subnet-name>
```
## Ports
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.

```yaml
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha4
kind: OpenStackMachine
metadata:
name: <cluster-name>-controlplane
namespace: <cluster-name>
spec:
ports:
- networkId: <your-network-id>
description: <your-custom-port-description>
vnicType: normal
fixedIPs:
- subnetId: <your-subnet-id>
ipAddress: <your-fixed-ip>
securityGroups:
- <your-security-group-id>
```

Any such ports are created in addition to ports used for connections to networks or subnets.

## Tagging

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:
Expand Down

0 comments on commit 0d791a7

Please sign in to comment.