Skip to content

Commit 5df0350

Browse files
authored
Merge pull request openstack-k8s-operators#963 from klgill/docs-fix-callouts
test callouts
2 parents 6281bd4 + 274f5c2 commit 5df0350

File tree

1 file changed

+256
-55
lines changed

1 file changed

+256
-55
lines changed

docs_user/modules/proc_deploying-backend-services.adoc

Lines changed: 256 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,8 @@ $ oc set data secret/osp-secret "OctaviaPassword=$OCTAVIA_PASSWORD"
126126
$ oc set data secret/osp-secret "PlacementPassword=$PLACEMENT_PASSWORD"
127127
$ oc set data secret/osp-secret "SwiftPassword=$SWIFT_PASSWORD"
128128
----
129+
130+
ifeval::["{build_variant}" != "ospdo"]
129131
. Deploy the `OpenStackControlPlane` CR. Ensure that you only enable the DNS, Galera, Memcached, and RabbitMQ services. All other services must
130132
be disabled:
131133
+
@@ -138,12 +140,7 @@ metadata:
138140
name: openstack
139141
spec:
140142
secret: osp-secret
141-
ifeval::["{build_variant}" != "ospdo"]
142-
storageClass: local-storage
143-
endif::[]
144-
ifeval::["{build_variant}" == "ospdo"]
145-
storageClass: <storage_class>
146-
endif::[]
143+
storageClass: <storage_class> <1>
147144
148145
barbican:
149146
enabled: false
@@ -166,16 +163,10 @@ endif::[]
166163
service:
167164
metadata:
168165
annotations:
169-
ifeval::["{build_variant}" != "ospdo"]
170166
metallb.universe.tf/address-pool: ctlplane
171167
metallb.universe.tf/allow-shared-ip: ctlplane
172-
metallb.universe.tf/loadBalancerIPs: 192.168.122.80
173-
endif::[]
174-
ifeval::["{build_variant}" == "ospdo"]
175-
metallb.universe.tf/address-pool: <address_pool>
176-
metallb.universe.tf/allow-shared-ip: <address_pool>
177-
metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP>
178-
endif::[]
168+
metallb.universe.tf/loadBalancerIPs: 192.168.122.80 <2>
169+
179170
spec:
180171
type: LoadBalancer
181172
options:
@@ -220,7 +211,7 @@ endif::[]
220211
secret: osp-secret
221212
replicas: 3
222213
storageRequest: 5G
223-
openstack-cell1:
214+
openstack-cell1: <3>
224215
secret: osp-secret
225216
replicas: 3
226217
storageRequest: 5G
@@ -249,7 +240,6 @@ endif::[]
249240
ovn:
250241
enabled: false
251242
template:
252-
ifeval::["{build_variant}" != "ospdo"]
253243
ovnController:
254244
networkAttachment: tenant
255245
nodeSelector:
@@ -265,8 +255,231 @@ ifeval::["{build_variant}" != "ospdo"]
265255
replicas: 3
266256
dbType: SB
267257
networkAttachment: internalapi
258+
259+
placement:
260+
enabled: false
261+
template: {}
262+
263+
rabbitmq:
264+
templates:
265+
rabbitmq:
266+
override:
267+
service:
268+
metadata:
269+
annotations:
270+
metallb.universe.tf/address-pool: internalapi
271+
metallb.universe.tf/loadBalancerIPs: 172.17.0.85
272+
spec:
273+
type: LoadBalancer
274+
rabbitmq-cell1:
275+
persistence:
276+
storage: 1G
277+
override:
278+
service:
279+
metadata:
280+
annotations:
281+
metallb.universe.tf/address-pool: internalapi
282+
metallb.universe.tf/loadBalancerIPs: 172.17.0.86
283+
284+
spec:
285+
type: LoadBalancer
286+
rabbitmq-cell2:
287+
persistence:
288+
storage: 1G
289+
override:
290+
service:
291+
metadata:
292+
annotations:
293+
metallb.universe.tf/address-pool: internalapi
294+
metallb.universe.tf/loadBalancerIPs: 172.17.0.87
295+
spec:
296+
type: LoadBalancer
297+
rabbitmq-cell3:
298+
persistence:
299+
storage: 1G
300+
override:
301+
service:
302+
metadata:
303+
annotations:
304+
metallb.universe.tf/address-pool: internalapi
305+
metallb.universe.tf/loadBalancerIPs: 172.17.0.88
306+
spec:
307+
type: LoadBalancer
308+
telemetry:
309+
enabled: false
310+
tls: <4>
311+
podLevel:
312+
enabled: false
313+
ingress:
314+
enabled: false
315+
swift:
316+
enabled: false
317+
template:
318+
swiftRing:
319+
ringReplicas: 1
320+
swiftStorage:
321+
replicas: 0
322+
swiftProxy:
323+
replicas: 1
324+
EOF
325+
----
326+
+
327+
<1> Select an existing `<storage_class>` in your {OpenShiftShort} cluster.
328+
<2> Replace `<loadBalancer_IP>` with the LoadBalancer IP address.
329+
<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.
330+
<4> If you enabled TLS-e in your {OpenStackShort} environment, in the `spec:tls` section set `tls` to the following:
331+
+
332+
----
333+
spec:
334+
...
335+
tls:
336+
podLevel:
337+
enabled: true
338+
internal:
339+
ca:
340+
customIssuer: rootca-internal
341+
libvirt:
342+
ca:
343+
customIssuer: rootca-internal
344+
ovn:
345+
ca:
346+
customIssuer: rootca-internal
347+
ingress:
348+
ca:
349+
customIssuer: rootca-internal
350+
enabled: true
351+
----
352+
353+
[NOTE]
354+
====
355+
If you use IPv6, change the load balancer IPs to the IPs in your environment, for example:
356+
----
357+
...
358+
metallb.universe.tf/allow-shared-ip: ctlplane
359+
metallb.universe.tf/loadBalancerIPs: fd00:aaaa::80
360+
...
361+
metallb.universe.tf/address-pool: internalapi
362+
metallb.universe.tf/loadBalancerIPs: fd00:bbbb::85
363+
...
364+
metallb.universe.tf/address-pool: internalapi
365+
metallb.universe.tf/loadBalancerIPs: fd00:bbbb::86
366+
----
367+
====
268368
endif::[]
369+
269370
ifeval::["{build_variant}" == "ospdo"]
371+
. Deploy the `OpenStackControlPlane` CR. Ensure that you only enable the DNS, Galera, Memcached, and RabbitMQ services. All other services must
372+
be disabled:
373+
+
374+
[source,shell]
375+
----
376+
$ oc apply -f - <<EOF
377+
apiVersion: core.openstack.org/v1beta1
378+
kind: OpenStackControlPlane
379+
metadata:
380+
name: openstack
381+
spec:
382+
secret: osp-secret
383+
storageClass: <storage_class> <1>
384+
385+
386+
barbican:
387+
enabled: false
388+
template:
389+
barbicanAPI: {}
390+
barbicanWorker: {}
391+
barbicanKeystoneListener: {}
392+
393+
cinder:
394+
enabled: false
395+
template:
396+
cinderAPI: {}
397+
cinderScheduler: {}
398+
cinderBackup: {}
399+
cinderVolumes: {}
400+
401+
dns:
402+
template:
403+
override:
404+
service:
405+
metadata:
406+
annotations:
407+
metallb.universe.tf/address-pool: <address_pool> <2>
408+
metallb.universe.tf/allow-shared-ip: <address_pool>
409+
metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP> <3>
410+
spec:
411+
type: LoadBalancer
412+
options:
413+
- key: server
414+
values:
415+
- 192.168.122.1
416+
replicas: 1
417+
418+
glance:
419+
enabled: false
420+
template:
421+
glanceAPIs: {}
422+
423+
heat:
424+
enabled: false
425+
template: {}
426+
427+
horizon:
428+
enabled: false
429+
template: {}
430+
431+
ironic:
432+
enabled: false
433+
template:
434+
ironicConductors: []
435+
436+
keystone:
437+
enabled: false
438+
template: {}
439+
440+
manila:
441+
enabled: false
442+
template:
443+
manilaAPI: {}
444+
manilaScheduler: {}
445+
manilaShares: {}
446+
447+
galera:
448+
enabled: true
449+
templates:
450+
openstack:
451+
secret: osp-secret
452+
replicas: 3
453+
storageRequest: 5G
454+
openstack-cell1: <4>
455+
secret: osp-secret
456+
replicas: 3
457+
storageRequest: 5G
458+
openstack-cell2:
459+
secret: osp-secret
460+
replicas: 1
461+
storageRequest: 5G
462+
openstack-cell3:
463+
secret: osp-secret
464+
replicas: 1
465+
storageRequest: 5G
466+
memcached:
467+
enabled: true
468+
templates:
469+
memcached:
470+
replicas: 3
471+
472+
neutron:
473+
enabled: false
474+
template: {}
475+
476+
nova:
477+
enabled: false
478+
template: {}
479+
480+
ovn:
481+
enabled: false
482+
template:
270483
ovnController:
271484
networkAttachment: tenant
272485
nodeSelector:
@@ -277,12 +490,12 @@ ifeval::["{build_variant}" == "ospdo"]
277490
ovndbcluster-nb:
278491
replicas: 3
279492
dbType: NB
280-
networkAttachment: <networkAttachment_name>
493+
networkAttachment: <networkAttachment_name> <5>
281494
ovndbcluster-sb:
282495
replicas: 3
283496
dbType: SB
284497
networkAttachment: <networkAttachment_name>
285-
endif::[]
498+
286499
placement:
287500
enabled: false
288501
template: {}
@@ -305,14 +518,8 @@ endif::[]
305518
service:
306519
metadata:
307520
annotations:
308-
ifeval::["{build_variant}" != "ospdo"]
309-
metallb.universe.tf/address-pool: internalapi
310-
metallb.universe.tf/loadBalancerIPs: 172.17.0.86
311-
endif::[]
312-
ifeval::["{build_variant}" == "ospdo"]
313521
metallb.universe.tf/address-pool: <networkAttachment_name>
314522
metallb.universe.tf/loadBalancerIPs: <loadBalancer_IP>
315-
endif::[]
316523
spec:
317524
type: LoadBalancer
318525
rabbitmq-cell2:
@@ -340,7 +547,7 @@ endif::[]
340547
telemetry:
341548
enabled: false
342549
343-
tls:
550+
tls: <6>
344551
podLevel:
345552
enabled: false
346553
ingress:
@@ -358,37 +565,13 @@ endif::[]
358565
EOF
359566
----
360567
+
361-
* Select an existing `<storage_class>` in your {OpenShiftShort} cluster.
362-
ifeval::["{build_variant}" == "ospdo"]
363-
+
364-
* Select an existing `<storage_class>` in your {OpenShiftShort} cluster.
365-
* Replace `<address_pool>` with the name of your network definition.
366-
* Replace `<loadBalancer_IP>` with the LoadBalancer IP address.
367-
* Replace `<networkAttachment_name>` with the name of your network.
368-
369-
endif::[]
568+
<1> Select an existing `<storage_class>` in your {OpenShiftShort} cluster.
569+
<2> Replace `<address_pool>` with the name of your network definition.
570+
<3> Replace `<loadBalancer_IP>` with the LoadBalancer IP address.
571+
<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.
572+
<5> Replace `<networkAttachment_name>` with the name of your network.
573+
<6> If you enabled TLS-e in your {OpenStackShort} environment, in the `spec:tls` section set `tls` to the following:
370574
+
371-
* 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.
372-
373-
[NOTE]
374-
====
375-
If you use IPv6, change the load balancer IPs to the IPs in your environment:
376-
----
377-
...
378-
metallb.universe.tf/allow-shared-ip: ctlplane
379-
metallb.universe.tf/loadBalancerIPs: fd00:aaaa::80
380-
...
381-
metallb.universe.tf/address-pool: internalapi
382-
metallb.universe.tf/loadBalancerIPs: fd00:bbbb::85
383-
...
384-
metallb.universe.tf/address-pool: internalapi
385-
metallb.universe.tf/loadBalancerIPs: fd00:bbbb::86
386-
----
387-
====
388-
389-
[NOTE]
390-
====
391-
If you enabled TLS-e in your {OpenStackShort} environment, in the `spec:tls` section set `tls` to the following:
392575
----
393576
spec:
394577
...
@@ -409,7 +592,25 @@ spec:
409592
customIssuer: rootca-internal
410593
enabled: true
411594
----
595+
596+
[NOTE]
412597
====
598+
If you use IPv6, change the load balancer IPs to the IPs in your environment, for example:
599+
----
600+
...
601+
metallb.universe.tf/allow-shared-ip: ctlplane
602+
metallb.universe.tf/loadBalancerIPs: fd00:aaaa::80
603+
...
604+
metallb.universe.tf/address-pool: internalapi
605+
metallb.universe.tf/loadBalancerIPs: fd00:bbbb::85
606+
...
607+
metallb.universe.tf/address-pool: internalapi
608+
metallb.universe.tf/loadBalancerIPs: fd00:bbbb::86
609+
----
610+
====
611+
endif::[]
612+
613+
413614

414615
.Verification
415616

0 commit comments

Comments
 (0)