openstack-k8s-operators · klgill · Nov 14, 2025
diff --git a/docs_user/modules/proc_configuring-networking-for-control-plane-services.adoc b/docs_user/modules/proc_configuring-networking-for-control-plane-services.adoc
@@ -53,19 +53,19 @@ spec:
       "ipam": {
         "type": "whereabouts",
         "range": "172.17.0.0/24",
-        "range_start": "172.17.0.20", <1>
-        "range_end": "172.17.0.50", <2>
-        "exclude": [ <3>
+        "range_start": "172.17.0.20",
+        "range_end": "172.17.0.50",
+        "exclude": [
           "172.17.0.24/32",
           "172.17.0.44/31"
         ]
       }
     }
 ----
 +
-<1> Defines the start of the IP range.
-<2> Defines the end of the IP range.
-<3> Excludes part of the IP range. This example excludes IP addresses `172.17.0.24/32` and `172.17.0.44/31` from the allocation pool.
+* `spec.config.ipam.range_start` defines the start of the IP range.
+* `spec.config.ipam.range_end` defines the end of the IP range.
+* `spec.config.ipam.exclude` excludes part of the IP range. This example excludes IP addresses `172.17.0.24/32` and `172.17.0.44/31` from the allocation pool.
 
 . If your {OpenStackShort} services require load balancer IP addresses, define the pools for these services in an `IPAddressPool` CR. For example:
 +

diff --git a/docs_user/modules/proc_deploying-backend-services.adoc b/docs_user/modules/proc_deploying-backend-services.adoc
@@ -142,7 +142,7 @@ metadata:
   name: openstack
 spec:
   secret: osp-secret
-  storageClass: <storage_class> <1>
+  storageClass: <storage_class>
 
   barbican:
     enabled: false
@@ -167,7 +167,7 @@ spec:
             annotations:
               metallb.universe.tf/address-pool: ctlplane
               metallb.universe.tf/allow-shared-ip: ctlplane
-              metallb.universe.tf/loadBalancerIPs: 192.168.122.80 <2>
+              metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP>
 
           spec:
             type: LoadBalancer
@@ -213,7 +213,7 @@ spec:
         secret: osp-secret
         replicas: 3
         storageRequest: 5G
-      openstack-cell1: <3>
+      openstack-cell1:
         secret: osp-secret
         replicas: 3
         storageRequest: 5G
@@ -270,7 +270,7 @@ spec:
             metadata:
               annotations:
                 metallb.universe.tf/address-pool: internalapi
-                metallb.universe.tf/loadBalancerIPs: 172.17.0.85
+                metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP>
             spec:
               type: LoadBalancer
       rabbitmq-cell1:
@@ -281,7 +281,7 @@ spec:
             metadata:
               annotations:
                 metallb.universe.tf/address-pool: internalapi
-                metallb.universe.tf/loadBalancerIPs: 172.17.0.86
+                metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP>
 
             spec:
               type: LoadBalancer
@@ -293,7 +293,7 @@ spec:
             metadata:
               annotations:
                 metallb.universe.tf/address-pool: internalapi
-                metallb.universe.tf/loadBalancerIPs: 172.17.0.87
+                metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP>
             spec:
               type: LoadBalancer
       rabbitmq-cell3:
@@ -304,12 +304,12 @@ spec:
             metadata:
               annotations:
                 metallb.universe.tf/address-pool: internalapi
-                metallb.universe.tf/loadBalancerIPs: 172.17.0.88
+                metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP>
             spec:
               type: LoadBalancer
   telemetry:
     enabled: false
-  tls: <4>
+  tls:
     podLevel:
       enabled: false
     ingress:
@@ -326,10 +326,28 @@ spec:
 EOF
 ----
 +
-<1> Select an existing `<storage_class>` in your {OpenShiftShort} cluster.
-<2> Replace `<loadBalancer_IP>` with the LoadBalancer IP address.
-<3> This example provides the required infrastructure database and messaging services for 3 Compute cells named `cell1`, `cell2`, and `cell3`. Adjust the values for fields such as `replicas`, `storage`, or `storageRequest`, for each Compute cell as needed.
-<4> If you enabled TLS-e in your {OpenStackShort} environment, in the `spec:tls` section set `tls` to the following:
+where:
+
+<storage_class>::
+Specifies an existing storage class in your {OpenShiftShort} cluster.
+
+<loadBalancer_IP>::
+Specifies the LoadBalancer IP address. If you use IPv6, change the load balancer IPs to the IPs in your environment, for example:
++
+----
+...
+metallb.universe.tf/allow-shared-ip: ctlplane
+metallb.universe.tf/loadBalancerIPs: fd00:aaaa::80
+...
+metallb.universe.tf/address-pool: internalapi
+metallb.universe.tf/loadBalancerIPs: fd00:bbbb::85
+...
+metallb.universe.tf/address-pool: internalapi
+metallb.universe.tf/loadBalancerIPs: fd00:bbbb::86
+----
+
+* `galera.openstack-cell1` provides the required infrastructure database and messaging services for the Compute cells, for example, `cell1`, `cell2`, and `cell3`. Adjust the values for fields such as `replicas`, `storage`, or `storageRequest`, for each Compute cell as needed.
+* `spec.tls` specifies whether TLS-e is enabled. If you enabled TLS-e in your {OpenStackShort} environment, set `tls` to the following:
 +
 ----
 spec:
@@ -351,22 +369,6 @@ spec:
         customIssuer: rootca-internal
       enabled: true
 ----
-+
-[NOTE]
-====
-If you use IPv6, change the load balancer IPs to the IPs in your environment, for example:
-----
-...
-metallb.universe.tf/allow-shared-ip: ctlplane
-metallb.universe.tf/loadBalancerIPs: fd00:aaaa::80
-...
-metallb.universe.tf/address-pool: internalapi
-metallb.universe.tf/loadBalancerIPs: fd00:bbbb::85
-...
-metallb.universe.tf/address-pool: internalapi
-metallb.universe.tf/loadBalancerIPs: fd00:bbbb::86
-----
-====
 endif::[]
 
 ifeval::["{build_variant}" == "ospdo"]
@@ -382,7 +384,7 @@ metadata:
   name: openstack
 spec:
   secret: osp-secret
-  storageClass: <storage_class> <1>
+  storageClass: <storage_class>
 
 
   barbican:
@@ -406,9 +408,9 @@ spec:
         service:
           metadata:
             annotations:
-              metallb.universe.tf/address-pool: <address_pool> <2>
+              metallb.universe.tf/address-pool: <address_pool>
               metallb.universe.tf/allow-shared-ip: <address_pool>
-              metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP> <3>
+              metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP>
           spec:
             type: LoadBalancer
       options:
@@ -453,7 +455,7 @@ spec:
         secret: osp-secret
         replicas: 3
         storageRequest: 5G
-      openstack-cell1: <4>
+      openstack-cell1:
         secret: osp-secret
         replicas: 3
         storageRequest: 5G
@@ -492,7 +494,7 @@ spec:
         ovndbcluster-nb:
           replicas: 3
           dbType: NB
-          networkAttachment: <networkAttachment_name> <5>
+          networkAttachment: <networkAttachment_name>
         ovndbcluster-sb:
           replicas: 3
           dbType: SB
@@ -549,7 +551,7 @@ spec:
   telemetry:
     enabled: false
 
-  tls: <6>
+  tls:
     podLevel:
       enabled: false
     ingress:
@@ -567,12 +569,34 @@ spec:
 EOF
 ----
 +
-<1> Select an existing `<storage_class>` in your {OpenShiftShort} cluster.
-<2> Replace `<address_pool>` with the name of your network definition.
-<3> Replace `<loadBalancer_IP>` with the LoadBalancer IP address.
-<4> This example provides the required infrastructure database and messaging services for 3 Compute cells named `cell1`, `cell2`, and `cell3`. Adjust the values for fields such as `replicas`, `storage`, or `storageRequest`, for each Compute cell as needed.
-<5> Replace `<networkAttachment_name>` with the name of your network.
-<6> If you enabled TLS-e in your {OpenStackShort} environment, in the `spec:tls` section set `tls` to the following:
+where:
+
+<storage_class>::
+Specifies an existing storage class in your {OpenShiftShort} cluster.
+
+<address_pool>::
+Specifies name of your network definition.
+
+<loadBalancer_IP>::
+Specifies the LoadBalancer IP address. If you use IPv6, change the load balancer IPs to the IPs in your environment, for example:
++
+----
+...
+metallb.universe.tf/allow-shared-ip: ctlplane
+metallb.universe.tf/loadBalancerIPs: fd00:aaaa::80
+...
+metallb.universe.tf/address-pool: internalapi
+metallb.universe.tf/loadBalancerIPs: fd00:bbbb::85
+...
+metallb.universe.tf/address-pool: internalapi
+metallb.universe.tf/loadBalancerIPs: fd00:bbbb::86
+----
+
+<networkAttachment_name>::
+Specifies the name of your network.
+
+* `galera.openstack-cell1` provides the required infrastructure database and messaging services for the Compute cells, for example, `cell1`, `cell2`, and `cell3`. Adjust the values for fields such as `replicas`, `storage`, or `storageRequest`, for each Compute cell as needed.
+* `spec.tls` specifies whether TLS-e is enabled. If you enabled TLS-e in your {OpenStackShort} environment, set `tls` to the following:
 +
 ----
 spec:
@@ -594,22 +618,6 @@ spec:
         customIssuer: rootca-internal
       enabled: true
 ----
-
-[NOTE]
-====
-If you use IPv6, change the load balancer IPs to the IPs in your environment, for example:
-----
-...
-metallb.universe.tf/allow-shared-ip: ctlplane
-metallb.universe.tf/loadBalancerIPs: fd00:aaaa::80
-...
-metallb.universe.tf/address-pool: internalapi
-metallb.universe.tf/loadBalancerIPs: fd00:bbbb::85
-...
-metallb.universe.tf/address-pool: internalapi
-metallb.universe.tf/loadBalancerIPs: fd00:bbbb::86
-----
-====
 endif::[]
 
 

diff --git a/docs_user/modules/proc_deploying-file-systems-service-control-plane.adoc b/docs_user/modules/proc_deploying-file-systems-service-control-plane.adoc
@@ -71,7 +71,7 @@ spec:
                 annotations:
                   metallb.universe.tf/address-pool: internalapi
                   metallb.universe.tf/allow-shared-ip: internalapi
-                  metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <1>
+                  metallb.universe.tf/loadBalancerIPs: <172.17.0.80>
               spec:
                 type: LoadBalancer
       manilaScheduler:
@@ -85,16 +85,16 @@ spec:
             host = hostgroup
             [cephfs]
             driver_handles_share_servers=False
-            share_backend_name=cephfs <2>
+            share_backend_name=cephfs
             share_driver=manila.share.drivers.cephfs.driver.CephFSDriver
             cephfs_conf_path=/etc/ceph/ceph.conf
             cephfs_auth_id=openstack
             cephfs_cluster_name=ceph
             cephfs_volume_mode=0755
             cephfs_protocol_helper_type=CEPHFS
-          networkAttachments: <3>
+          networkAttachments:
               - storage
-      extraMounts: <4>
+      extraMounts:
       - name: v1
         region: r1
         extraVol:
@@ -112,10 +112,10 @@ spec:
 __EOF__
 ----
 +
-<1> If you use IPv6, change the load balancer IP to the load balancer IP in your environment, for example, `metallb.universe.tf/loadBalancerIPs: fd00:bbbb::80`.
-<2> Ensure that the names of the back ends (`share_backend_name`) are the same as they were in {OpenStackShort} {rhos_prev_ver}.
-<3> Ensure that you specify the appropriate storage management network in the `networkAttachments` section. For example, the `manilaShares` instance with the CephFS back-end driver is connected to the `storage` network.
-<4> If you need to add extra files to any of the services, you can use `extraMounts`. For example, when using {Ceph}, you can add the {rhos_component_storage_file} Ceph user's keyring file as well as the `ceph.conf` configuration file.
+* `metallb.universe.tf/loadBalancerIPs:<172.17.0.80>` specifies the load balancer IP in your environment. If you use IPv6, change the load balancer IP to the load balancer IP in your environment, for example, `metallb.universe.tf/loadBalancerIPs: fd00:bbbb::80`.
+* `share_backend_name` specifies the names of the back ends to use in {rhos_long}. Ensure that the names of the back ends are the same as they were in {OpenStackShort} {rhos_prev_ver}.
+* `networkAttachments` specifies the appropriate storage management network. For example, the `manilaShares` instance with the CephFS back-end driver is connected to the `storage` network.
+* `extraMounts` specifies additional files to add to any of the services. For example, when using {Ceph}, you can add the {rhos_component_storage_file} Ceph user's keyring file as well as the `ceph.conf` configuration file.
 +
 The following example patch file uses CephFS through NFS:
 +
@@ -141,7 +141,7 @@ spec:
                 annotations:
                   metallb.universe.tf/address-pool: internalapi
                   metallb.universe.tf/allow-shared-ip: internalapi
-                  metallb.universe.tf/loadBalancerIPs: 172.17.0.80
+                  metallb.universe.tf/loadBalancerIPs: <172.17.0.80>
               spec:
                 type: LoadBalancer
       manilaScheduler:

diff --git a/docs_user/modules/proc_deploying-the-bare-metal-provisioning-service.adoc b/docs_user/modules/proc_deploying-the-bare-metal-provisioning-service.adoc
@@ -60,7 +60,7 @@ spec:
                 annotations:
                   metallb.universe.tf/address-pool: internalapi
                   metallb.universe.tf/allow-shared-ip: internalapi
-                  metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <1>
+                  metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP> <1>
               spec:
                 type: LoadBalancer
       ironicConductors:
@@ -100,7 +100,10 @@ spec:
 '
 ----
 +
-<1> If you use IPv6, change the load balancer IP to the load balancer IP in your environment, for example, `metallb.universe.tf/loadBalancerIPs: fd00:bbbb::80`.
+where:
+
+<loadBalancer_IP>::
+Specifies the load balancer IP in your environment. If you use IPv6, change the load balancer IP to the load balancer IP in your environment, for example, `metallb.universe.tf/loadBalancerIPs: fd00:bbbb::80`.
 
 . Wait for the {bare_metal} control plane services CRs to become ready:
 +