From dd5e590b2a25001ef60fef2fb58bbd44539c55ff Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Wed, 29 Nov 2023 15:42:56 +0000
Subject: [PATCH 1/3] Bump mdbook version
0.4.5 is ancient. Use the latest and greatest version.
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
---
versions.mk | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/versions.mk b/versions.mk
index df636b6081..7122854b71 100644
--- a/versions.mk
+++ b/versions.mk
@@ -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
From 38f28daddca9a4801d4556ff2f202b9dba981c38 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Wed, 29 Nov 2023 16:00:01 +0000
Subject: [PATCH 2/3] docs: Correct OpenStackMachineTemplate examples
Our examples indicated:
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha7
kind: OpenStackMachineTemplate
...
spec:
foo:
...
when in fact it should read:
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha7
kind: OpenStackMachineTemplate
...
spec:
template:
spec:
foo:
...
Correct this oversight.
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
---
.../src/clusteropenstack/configuration.md | 122 ++++++++++--------
1 file changed, 67 insertions(+), 55 deletions(-)
diff --git a/docs/book/src/clusteropenstack/configuration.md b/docs/book/src/clusteropenstack/configuration.md
index 2bccf24f98..6dbcd3982d 100644
--- a/docs/book/src/clusteropenstack/configuration.md
+++ b/docs/book/src/clusteropenstack/configuration.md
@@ -303,9 +303,11 @@ metadata:
name: <cluster-name>-controlplane
namespace: <cluster-name>
spec:
- networks:
- - filter:
- name: <network-name>
+ template:
+ spec:
+ networks:
+ - filter:
+ name: <network-name>
```
## Multiple Networks
@@ -319,12 +321,14 @@ 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:
+ networks:
+ - filter:
+ name: myNetwork
+ tags: myTag
+ - uuid: your_network_id
+ - subnet_id: your_subnet_id
```
## Subnet Filters
@@ -338,12 +342,14 @@ metadata:
name: <cluster-name>-controlplane
namespace: <cluster-name>
spec:
- networks:
- - filter:
- name: <network-name>
- subnets:
- - filter:
- name: <subnet-name>
+ template:
+ spec:
+ networks:
+ - filter:
+ name: <network-name>
+ subnets:
+ - filter:
+ name: <subnet-name>
```
## Ports
@@ -357,26 +363,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.
@@ -453,12 +461,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
@@ -554,20 +564,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.
From fc76995d79a12be77031b0455bf71087f67ac599 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Wed, 29 Nov 2023 16:10:03 +0000
Subject: [PATCH 3/3] docs: Update network examples
The 'network' filter has been removed in API v1alpha7. Update our docs
to reflect this.
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
---
.../src/clusteropenstack/configuration.md | 71 ++++++++++---------
1 file changed, 37 insertions(+), 34 deletions(-)
diff --git a/docs/book/src/clusteropenstack/configuration.md b/docs/book/src/clusteropenstack/configuration.md
index 6dbcd3982d..3f4e9dc58f 100644
--- a/docs/book/src/clusteropenstack/configuration.md
+++ b/docs/book/src/clusteropenstack/configuration.md
@@ -305,9 +305,9 @@ metadata:
spec:
template:
spec:
- networks:
- - filter:
- name: <network-name>
+ ports:
+ - network:
+ name: <network-name>
```
## Multiple Networks
@@ -323,12 +323,15 @@ metadata:
spec:
template:
spec:
- networks:
- - filter:
- name: myNetwork
- tags: myTag
- - uuid: your_network_id
- - subnet_id: your_subnet_id
+ ports:
+ - network:
+ name: myNetwork
+ tags: myTag
+ - network:
+ id: your_network_id
+ - fixedIPs:
+ - subnet:
+ id: your_subnet_id
```
## Subnet Filters
@@ -344,12 +347,12 @@ metadata:
spec:
template:
spec:
- networks:
- - filter:
- name: <network-name>
- subnets:
- - filter:
- name: <subnet-name>
+ ports:
+ - network:
+ name: <network-name>
+ fixedIPs:
+ - subnet:
+ name: <subnet-name>
```
## Ports
@@ -366,25 +369,25 @@ spec:
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>
+ - 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.