Skip to content

Commit a10bf45

Browse files
klgillklgill
authored
Merge pull request #1152 from klgill/docs-fix-callouts-pt2
rewriting callouts
2 parents 2df6d47 + b6886d2 commit a10bf45

14 files changed

+92
-55
lines changed

‎docs_user/modules/proc_adopting-image-service-with-nfs-backend.adoc‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ tenant true false ["172.19.0.80-172.19.0.90"]
6262

6363
. Adopt the {image_service} and create a new `default` `GlanceAPI` instance that is connected with the existing NFS share:
6464
+
65+
[subs="+quotes"]
6566
----
6667
$ cat << EOF > glance_nfs_patch.yaml
6768
@@ -77,8 +78,8 @@ spec:
7778
volumes:
7879
- name: nfs
7980
nfs:
80-
path: <exported_path> <1>
81-
server: <ip_address> <2>
81+
*path: <exported_path>*
82+
*server: <ip_address>*
8283
name: r1
8384
region: r1
8485
glance:
@@ -106,17 +107,22 @@ spec:
106107
annotations:
107108
metallb.universe.tf/address-pool: internalapi
108109
metallb.universe.tf/allow-shared-ip: internalapi
109-
metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <3>
110+
metallb.universe.tf/loadBalancerIPs: *<172.17.0.80>*
110111
spec:
111112
type: LoadBalancer
112113
networkAttachments:
113114
- storage
114115
EOF
115116
----
116117
+
117-
<1> Replace `<exported_path>` with the exported path in the `nfs-server`.
118-
<2> Replace `<ip_address>` with the IP address that you use to communicate with the `nfs-server`.
119-
<3> 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`.
118+
where:
119+
120+
<exported_path>::
121+
Specifies the exported path in the `nfs-server`.
122+
<ip_address>::
123+
Specifies the IP address that you use to communicate with the `nfs-server`.
124+
<172.17.0.80>::
125+
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`.
120126

121127
. Patch the `OpenStackControlPlane` CR to deploy the {image_service} with an NFS back end:
122128
+

‎docs_user/modules/proc_adopting-image-service-with-object-storage-backend.adoc‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ spec
3333

3434
. Create a new file, for example, `glance_swift.patch`, and include the following content:
3535
+
36+
[subs="+quotes"]
3637
----
3738
spec:
3839
glance:
@@ -66,14 +67,17 @@ spec:
6667
annotations:
6768
metallb.universe.tf/address-pool: internalapi
6869
metallb.universe.tf/allow-shared-ip: internalapi
69-
metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <1>
70+
metallb.universe.tf/loadBalancerIPs: *<172.17.0.80>*
7071
spec:
7172
type: LoadBalancer
7273
networkAttachments:
7374
- storage
7475
----
7576
+
76-
<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`.
77+
where:
78+
79+
<172.17.0.80>::
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`.
7781
+
7882
[NOTE]
7983
The {object_storage} as a back end establishes a dependency with the {image_service}. Any deployed `GlanceAPI` instances do not work if the {image_service} is configured with the {object_storage} that is not available in the `OpenStackControlPlane` custom resource.

‎docs_user/modules/proc_adopting-key-manager-service.adoc‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ $ oc set data secret/osp-secret "BarbicanSimpleCryptoKEK=$($CONTROLLER1_SSH "pyt
2424

2525
. Patch the `OpenStackControlPlane` CR to deploy the {key_manager}:
2626
+
27+
[subs="+quotes"]
2728
----
2829
$ oc patch openstackcontrolplane openstack --type=merge --patch '
2930
spec:
@@ -51,7 +52,7 @@ spec:
5152
annotations:
5253
metallb.universe.tf/address-pool: internalapi
5354
metallb.universe.tf/allow-shared-ip: internalapi
54-
metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <1>
55+
metallb.universe.tf/loadBalancerIPs: *<172.17.0.80>*
5556
spec:
5657
type: LoadBalancer
5758
barbicanWorker:
@@ -61,7 +62,10 @@ spec:
6162
'
6263
----
6364
+
64-
<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`.
65+
where:
66+
67+
<172.17.0.80>::
68+
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`.
6569

6670
.Verification
6771

‎docs_user/modules/proc_adopting-networker-services-to-the-data-plane.adoc‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,15 @@ networkers+=(
5757
[NOTE]
5858
You can reuse most of the `nodeTemplate` section from the `OpenStackDataPlaneNodeSet` CR that is designated for your Compute nodes. You can omit some of the variables because of the limited set of services that are running on the Networker nodes.
5959
+
60+
[subs="+quotes"]
6061
----
6162
$ oc apply -f - <<EOF
6263
apiVersion: dataplane.openstack.org/v1beta1
6364
kind: OpenStackDataPlaneNodeSet
6465
metadata:
6566
name: openstack-networker
6667
spec:
67-
tlsEnabled: false <1>
68+
tlsEnabled: false
6869
networkAttachments:
6970
- ctlplane
7071
preProvisioned: true
@@ -205,15 +206,15 @@ endif::[]
205206
edpm_nodes_validation_validate_gateway_icmp: false
206207
207208
# edpm ovn-controller configuration
208-
edpm_ovn_bridge_mappings: <bridge_mappings> <2>
209+
edpm_ovn_bridge_mappings: <bridge_mappings>
209210
edpm_ovn_bridge: br-int
210211
edpm_ovn_encap_type: geneve
211212
ovn_monitor_all: true
212213
edpm_ovn_remote_probe_interval: 60000
213214
edpm_ovn_ofctrl_wait_before_clear: 8000
214215
215216
# serve as a OVN gateway
216-
edpm_enable_chassis_gw: true <3>
217+
edpm_enable_chassis_gw: true
217218
218219
timesync_ntp_servers:
219220
ifeval::["{build}" != "downstream"]
@@ -254,9 +255,9 @@ endif::[]
254255
EOF
255256
----
256257
+
257-
<1> If TLS Everywhere is enabled, change `spec:tlsEnabled` to `true`.
258-
<2> Set to the same values that you used in your {rhos_prev_long} {rhos_prev_ver} deployment.
259-
<3> Set to `true` to run `ovn-controller` in gateway mode.
258+
* `spec.tlsEnabled` specifies whether TLS Everywhere is enabled. If TLS is enabled, change `spec:tlsEnabled` to `true`.
259+
* `edpm_ovn_bridge_mappings: <bridge_mappings>` specifies the bridge mapping values that you used in your {rhos_prev_long} {rhos_prev_ver} deployment.
260+
* `edpm_enable_chassis_gw` specifies whether to run `ovn-controller` in gateway mode.
260261

261262
. Ensure that you use the same `ovn-controller` settings in the `OpenStackDataPlaneNodeSet` CR that you used in the Networker nodes before adoption. This configuration is stored in the `external_ids` column in the `Open_vSwitch` table in the Open vSwitch database:
262263
+

‎docs_user/modules/proc_adopting-the-block-storage-service.adoc‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ $ oc patch openstackcontrolplane openstack --type=merge --patch-file=<patch_name
3333
+
3434
The following example shows a `cinder_api.patch` file:
3535
+
36-
[source,yaml]
36+
[subs="+quotes"]
3737
----
3838
spec:
3939
extraMounts:
@@ -69,7 +69,7 @@ spec:
6969
annotations:
7070
metallb.universe.tf/address-pool: internalapi
7171
metallb.universe.tf/allow-shared-ip: internalapi
72-
metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <1>
72+
metallb.universe.tf/loadBalancerIPs: *<172.17.0.80>*
7373
spec:
7474
type: LoadBalancer
7575
replicas: 1
@@ -89,7 +89,10 @@ spec:
8989
replicas: 0
9090
----
9191
+
92-
<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`.
92+
where:
93+
94+
<172.17.0.80>::
95+
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`.
9396

9497
. Retrieve the list of the previous scheduler and backup services:
9598
+

‎docs_user/modules/proc_adopting-the-compute-service.adoc‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,16 @@ RENAMED_CELLS="cell1"
3838
This procedure assumes that {compute_service} metadata is deployed on the top level and not on each cell level. If the {OpenStackShort} deployment has a per-cell metadata deployment, adjust the following patch as needed. You cannot run the metadata service in `cell0`.
3939
To enable the metadata services of a local cell, set the `enabled` property in the `metadataServiceTemplate` field of the local cell to `true` in the `OpenStackControlPlane` CR.
4040
+
41+
[subs="+quotes"]
4142
----
4243
$ rm -f celltemplates
4344
$ for CELL in $(echo $RENAMED_CELLS); do
4445
$ cat >> celltemplates << EOF
4546
> ${CELL}:
46-
> hasAPIAccess: true <1>
47+
> *hasAPIAccess: true*
4748
> cellDatabaseAccount: nova-$CELL
48-
> cellDatabaseInstance: openstack-$CELL <2>
49-
> cellMessageBusInstance: rabbitmq-$CELL <3>
49+
> *cellDatabaseInstance: openstack-$CELL*
50+
> *cellMessageBusInstance: rabbitmq-$CELL*
5051
> metadataServiceTemplate:
5152
> enabled: false
5253
> override:
@@ -85,7 +86,7 @@ $ cat > oscp-patch.yaml << EOF
8586
> annotations:
8687
> metallb.universe.tf/address-pool: internalapi
8788
> metallb.universe.tf/allow-shared-ip: internalapi
88-
> metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <4>
89+
> metallb.universe.tf/loadBalancerIPs: <172.17.0.80>
8990
> spec:
9091
> type: LoadBalancer
9192
> customServiceConfig: |
@@ -99,7 +100,7 @@ $ cat > oscp-patch.yaml << EOF
99100
> annotations:
100101
> metallb.universe.tf/address-pool: internalapi
101102
> metallb.universe.tf/allow-shared-ip: internalapi
102-
> metallb.universe.tf/loadBalancerIPs: 172.17.0.80
103+
> metallb.universe.tf/loadBalancerIPs: <172.17.0.80>
103104
> spec:
104105
> type: LoadBalancer
105106
> customServiceConfig: |
@@ -124,10 +125,10 @@ $ cat celltemplates >> oscp-patch.yaml
124125
$ oc patch openstackcontrolplane openstack --type=merge --patch-file=oscp-patch.yaml
125126
----
126127
+
127-
<1> In the source cloud, cells are always configured with the main Nova API database upcall access. You can disable upcall access to the API by setting `hasAPIAccess` to `false`. However, do not make changes to the API during adoption.
128-
<2> The database instance that is used by the cell. The database instance names must match the names that are defined in the `OpenStackControlPlane` CR that you created in when you deployed the back-end services as described in xref:deploying-backend-services__migrating-databases[Deploying back-end services].
129-
<3> The message bus instance that is used by the cell. The message bus instance names must match the names that are defined in the `OpenStackControlPlane` CR.
130-
<4> 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`.
128+
* `${CELL}.hasAPIAccess` specifies upcall access to the API. In the source cloud, cells are always configured with the main Nova API database upcall access. You can disable upcall access to the API by setting `hasAPIAccess` to `false`. However, do not make changes to the API during adoption.
129+
* `${CELL}.cellDatabaseInstance` specifies the database instance that is used by the cell. The database instance names must match the names that are defined in the `OpenStackControlPlane` CR that you created in when you deployed the back-end services as described in xref:deploying-backend-services__migrating-databases[Deploying back-end services].
130+
* `${CELL}.cellMessageBusInstance` specifies the message bus instance that is used by the cell. The message bus instance names must match the names that are defined in the `OpenStackControlPlane` CR.
131+
* `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`.
131132

132133
. If you are adopting the {compute_service} with the {bare_metal_first_ref}, append the `novaComputeTemplates` field with the following content in each cell in the {compute_service} CR patch. For example:
133134
+

‎docs_user/modules/proc_adopting-the-identity-service.adoc‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ EOF
2929

3030
. Patch the `OpenStackControlPlane` CR to deploy the {identity_service}:
3131
+
32+
[subs="+quotes"]
3233
----
3334
$ oc patch openstackcontrolplane openstack --type=merge --patch '
3435
spec:
@@ -44,15 +45,18 @@ spec:
4445
annotations:
4546
metallb.universe.tf/address-pool: internalapi
4647
metallb.universe.tf/allow-shared-ip: internalapi
47-
metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <1>
48+
metallb.universe.tf/loadBalancerIPs: *<172.17.0.80>*
4849
spec:
4950
type: LoadBalancer
5051
databaseInstance: openstack
5152
secret: osp-secret
5253
'
5354
----
5455
+
55-
<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`.
56+
where:
57+
58+
<172.17.0.80>::
59+
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`.
5660

5761
. Create an alias to use the `openstack` command in the {rhos_long} deployment:
5862
+

‎docs_user/modules/proc_adopting-the-loadbalancer-service.adoc‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ parameter_defaults:
5353

5454
. To isolate the management network, add the network interface for the VLAN base interface:
5555
+
56+
[subs="+quotes"]
5657
----
5758
$ oc get --no-headers nncp | cut -f 1 -d ' ' | grep -v nncp-dns | while read; do
5859
@@ -69,7 +70,7 @@ interfaces=$(oc get nncp $REPLY -o jsonpath="{.spec.desiredState.interfaces[*].n
6970
"state": "up",
7071
"type": "vlan",
7172
"vlan": {
72-
"base-iface": "<enp6s0>", <1>
73+
"base-iface": "<enp6s0>",
7374
"id": 24
7475
}
7576
}
@@ -79,7 +80,7 @@ interfaces=$(oc get nncp $REPLY -o jsonpath="{.spec.desiredState.interfaces[*].n
7980
"path": "/spec/desiredState/interfaces/-",
8081
"value": {
8182
"description": "Octavia Bridge",
82-
"mtu": <mtu>, <2>
83+
"mtu": <mtu>,
8384
"state": "up",
8485
"type": "linux-bridge",
8586
"name": "octbr",
@@ -93,8 +94,12 @@ interfaces=$(oc get nncp $REPLY -o jsonpath="{.spec.desiredState.interfaces[*].n
9394
done
9495
----
9596
+
96-
<1> Replace `<enp6s0>` with the name of the network interface in your {OpenShiftShort} setup.
97-
<2> Replace `<mtu>` with the `mtu` value in your environment.
97+
where:
98+
99+
<enp6s0>::
100+
Specifies the name of the network interface in your {OpenShiftShort} setup.
101+
<mtu>::
102+
Specifies the `mtu` value in your environment.
98103

99104
. To connect pods that manage load balancer virtual machines (amphorae) and the OpenvSwitch pods that are managed by the OVN operator, configure the {loadbalancer_service} network attachment definition:
100105
+

‎docs_user/modules/proc_adopting-the-networking-service.adoc‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ endif::[]
2727

2828
* Patch the `OpenStackControlPlane` CR to deploy the {networking_service}:
2929
+
30-
[source,shell]
30+
[subs="+quotes"]
3131
----
3232
$ oc patch openstackcontrolplane openstack --type=merge --patch '
3333
spec:
@@ -43,7 +43,7 @@ spec:
4343
annotations:
4444
metallb.universe.tf/address-pool: internalapi
4545
metallb.universe.tf/allow-shared-ip: internalapi
46-
metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <1>
46+
metallb.universe.tf/loadBalancerIPs: *<172.17.0.80>*
4747
spec:
4848
type: LoadBalancer
4949
databaseInstance: openstack
@@ -54,7 +54,10 @@ spec:
5454
'
5555
----
5656
+
57-
<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`.
57+
where:
58+
59+
<172.17.0.80>::
60+
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`.
5861
+
5962
[NOTE]
6063
====

‎docs_user/modules/proc_adopting-the-object-storage-service.adoc‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ EOF
4545

4646
. Patch the `OpenStackControlPlane` custom resource to deploy the {object_storage}:
4747
+
48+
[subs="+quotes"]
4849
----
4950
$ oc patch openstackcontrolplane openstack --type=merge --patch '
5051
spec:
@@ -58,7 +59,7 @@ spec:
5859
replicas: 0
5960
networkAttachments:
6061
- storage
61-
storageClass: local-storage <1>
62+
*storageClass: local-storage*
6263
storageRequest: 10Gi
6364
swiftProxy:
6465
secret: osp-secret
@@ -73,17 +74,17 @@ spec:
7374
annotations:
7475
metallb.universe.tf/address-pool: internalapi
7576
metallb.universe.tf/allow-shared-ip: internalapi
76-
metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <2>
77+
metallb.universe.tf/loadBalancerIPs: *<172.17.0.80>*
7778
spec:
7879
type: LoadBalancer
79-
networkAttachments: <3>
80+
*networkAttachments:*
8081
- storage
8182
'
8283
----
8384
+
84-
<1> Must match the {rhos_acro} deployment storage class.
85-
<2> 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`.
86-
<3> Must match the network attachment for the previous {object_storage} configuration from the {OpenStackShort} deployment.
85+
* `spec.swift.swiftStorage.storageClass` must match the {rhos_acro} deployment storage class.
86+
* `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`.
87+
* `spec.swift.swiftProxy.networkAttachments` must match the network attachment for the previous {object_storage} configuration from the {OpenStackShort} deployment.
8788

8889
.Verification
8990

0 commit comments

Comments
 (0)