Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Fix network-related docs for API v1alpha7 #1764

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 70 additions & 55 deletions docs/book/src/clusteropenstack/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,9 +303,11 @@ metadata:
name: <cluster-name>-controlplane
namespace: <cluster-name>
spec:
networks:
- filter:
name: <network-name>
template:
spec:
ports:
- network:
name: <network-name>
```

## Multiple Networks
Expand All @@ -319,12 +321,17 @@ metadata:
name: <cluster-name>-controlplane
namespace: <cluster-name>
spec:
networks:
- filter:
name: myNetwork
tags: myTag
- uuid: your_network_id
- subnet_id: your_subnet_id
template:
spec:
ports:
- network:
name: myNetwork
tags: myTag
- network:
id: your_network_id
- fixedIPs:
- subnet:
id: your_subnet_id
```

## Subnet Filters
Expand All @@ -338,12 +345,14 @@ metadata:
name: <cluster-name>-controlplane
namespace: <cluster-name>
spec:
networks:
- filter:
name: <network-name>
subnets:
- filter:
name: <subnet-name>
template:
spec:
ports:
- network:
name: <network-name>
fixedIPs:
- subnet:
name: <subnet-name>
```

## Ports
Expand All @@ -357,26 +366,28 @@ metadata:
name: <cluster-name>-controlplane
namespace: <cluster-name>
spec:
ports:
- network:
id: <your-network-id>
fixedIPs:
- subnet:
id: <your-subnet-id>
ipAddress: <your-fixed-ip>
- subnet:
name: <your-subnet-name>
tags:
- tag1
- tag2
nameSuffix: <your-port-name>
description: <your-custom-port-description>
vnicType: normal
securityGroups:
- <your-security-group-id>
profile:
capabilities:
- <capability>
template:
spec:
ports:
- network:
id: <your-network-id>
fixedIPs:
- subnet:
id: <your-subnet-id>
ipAddress: <your-fixed-ip>
- subnet:
name: <your-subnet-name>
tags:
- tag1
- tag2
nameSuffix: <your-port-name>
description: <your-custom-port-description>
vnicType: normal
securityGroups:
- <your-security-group-id>
profile:
capabilities:
- <capability>
```

Any such ports are created in addition to ports used for connections to networks or subnets.
Expand Down Expand Up @@ -453,12 +464,14 @@ metadata:
name: <cluster-name>-controlplane
namespace: <cluster-name>
spec:
ports:
- network:
id: <your-network-id>
...
disablePortSecurity: true
...
template:
spec:
ports:
- network:
id: <your-network-id>
...
disablePortSecurity: true
...
```

## Security groups
Expand Down Expand Up @@ -554,20 +567,22 @@ spec:

For example in `OpenStackMachineTemplate` set `spec.rootVolume.diskSize` to something greater than `0` means boot from volume.

```yaml
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha7
kind: OpenStackMachineTemplate
metadata:
name: <cluster-name>-controlplane
namespace: <cluster-name>
spec:
...
rootVolume:
diskSize: <image size>
volumeType: <a cinder volume type (*optional)>
availabilityZone: <the cinder availability zone for the root volume (*optional)>
...
```
```yaml
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha7
kind: OpenStackMachineTemplate
metadata:
name: <cluster-name>-controlplane
namespace: <cluster-name>
spec:
template:
spec:
...
rootVolume:
diskSize: <image size>
volumeType: <a cinder volume type (*optional)>
availabilityZone: <the cinder availability zone for the root volume (*optional)>
...
```

If `volumeType` is not specified, cinder will use the default volume type.

Expand Down
2 changes: 1 addition & 1 deletion versions.mk
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

MDBOOK_VERSION := v0.4.5
MDBOOK_VERSION := v0.4.35
PLANTUML_VERSION := 1.2022.6
GH_VERSION := 1.2.0