Skip to content

Commit 7414dee

Browse files
openshift-merge-bot[bot]openshift-merge-bot[bot]
authored
Merge pull request #1110 from klgill/docs-copybuttonfixes
attempting copy button fixes
2 parents 522b94d + 3d64b95 commit 7414dee

15 files changed

+158
-167
lines changed

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

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -184,13 +184,13 @@ endif::[]
184184
+
185185
----
186186
$ cd "$(mktemp -d)"
187-
ssh-keygen -f ./id -t ecdsa-sha2-nistp521 -N ''
188-
oc get secret nova-migration-ssh-key || oc create secret generic nova-migration-ssh-key \
187+
$ ssh-keygen -f ./id -t ecdsa-sha2-nistp521 -N ''
188+
$ oc get secret nova-migration-ssh-key || oc create secret generic nova-migration-ssh-key \
189189
--from-file=ssh-privatekey=id \
190190
--from-file=ssh-publickey=id.pub \
191191
--type kubernetes.io/ssh-auth
192-
rm -f id*
193-
cd -
192+
$ rm -f id*
193+
$ cd -
194194
----
195195

196196
. If TLS Everywhere is enabled, set `LIBVIRT_PASSWORD` to match the existing {OpenStackShort} deployment password:
@@ -268,29 +268,29 @@ For {Ceph} environments with multi-cell configurations, you must name configurat
268268
. Create the data plane services for {compute_service} cells to enable pre-upgrade workarounds, and to configure the Compute services for your chosen storage back end:
269269
+
270270
----
271-
for CELL in $(echo $RENAMED_CELLS); do
272-
$ oc apply -f - <<EOF
273-
---
274-
apiVersion: dataplane.openstack.org/v1beta1
275-
kind: OpenStackDataPlaneService
276-
metadata:
277-
name: nova-$CELL
278-
spec:
279-
dataSources: <1>
280-
- secretRef:
281-
name: nova-$CELL-compute-config <2>
282-
- secretRef:
283-
name: nova-migration-ssh-key <3>
284-
- configMapRef:
285-
name: nova-cells-global-config
286-
playbook: osp.edpm.nova
287-
caCerts: combined-ca-bundle
288-
edpmServiceType: nova
289-
containerImageFields:
290-
- NovaComputeImage
291-
- EdpmIscsidImage
292-
EOF
293-
done
271+
$ for CELL in $(echo $RENAMED_CELLS); do
272+
> oc apply -f - <<EOF
273+
> ---
274+
> apiVersion: dataplane.openstack.org/v1beta1
275+
> kind: OpenStackDataPlaneService
276+
> metadata:
277+
> name: nova-$CELL
278+
> spec:
279+
> dataSources: <1>
280+
> - secretRef:
281+
> name: nova-$CELL-compute-config <2>
282+
> - secretRef:
283+
> name: nova-migration-ssh-key <3>
284+
> - configMapRef:
285+
> name: nova-cells-global-config
286+
> playbook: osp.edpm.nova
287+
> caCerts: combined-ca-bundle
288+
> edpmServiceType: nova
289+
> containerImageFields:
290+
> - NovaComputeImage
291+
> - EdpmIscsidImage
292+
>EOF
293+
> done
294294
----
295295
+
296296
* If TLS Everywhere is enabled, append the following content to the `OpenStackDataPlaneService` CR:
@@ -589,9 +589,9 @@ external_ids : {hostname=standalone.localdomain, ovn-bridge=br-int, ovn-b
589589
+
590590
----
591591
$ for CELL in $(echo $RENAMED_CELLS); do
592-
test -f nodeset-${CELL}.yaml || continue
593-
$ oc apply -f nodeset-${CELL}.yaml
594-
done
592+
> test -f nodeset-${CELL}.yaml || continue
593+
> oc apply -f nodeset-${CELL}.yaml
594+
> done
595595
----
596596

597597
. If you use a {Ceph} back end for {block_storage_first_ref}, prepare the adopted data plane workloads:
@@ -821,8 +821,8 @@ $ oc logs -l app=openstackansibleee -f --max-log-requests 20
821821
+
822822
----
823823
$ for CELL in $(echo $RENAMED_CELLS); do
824-
$ oc wait --for condition=Ready osdpns/openstack-$CELL --timeout=30m
825-
done
824+
> oc wait --for condition=Ready osdpns/openstack-$CELL --timeout=30m
825+
> done
826826
----
827827

828828
. Verify that the {networking_first_ref} agents are running:

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

Lines changed: 87 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -38,89 +38,88 @@ 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-
[source, shell]
4241
----
4342
$ rm -f celltemplates
44-
for CELL in $(echo $RENAMED_CELLS); do
43+
$ for CELL in $(echo $RENAMED_CELLS); do
4544
$ cat >> celltemplates << EOF
46-
${CELL}:
47-
hasAPIAccess: true <1>
48-
cellDatabaseAccount: nova-$CELL
49-
cellDatabaseInstance: openstack-$CELL <2>
50-
cellMessageBusInstance: rabbitmq-$CELL <3>
51-
metadataServiceTemplate:
52-
enabled: false
53-
override:
54-
service:
55-
metadata:
56-
annotations:
57-
metallb.universe.tf/address-pool: internalapi
58-
metallb.universe.tf/allow-shared-ip: internalapi
59-
metallb.universe.tf/loadBalancerIPs: 172.17.0.$(( 79 + ${CELL##*cell} ))
60-
spec:
61-
type: LoadBalancer
62-
customServiceConfig: |
63-
[workarounds]
64-
disable_compute_service_check_for_ffu=true
65-
conductorServiceTemplate:
66-
customServiceConfig: |
67-
[workarounds]
68-
disable_compute_service_check_for_ffu=true
69-
EOF
70-
done
45+
> ${CELL}:
46+
> hasAPIAccess: true <1>
47+
> cellDatabaseAccount: nova-$CELL
48+
> cellDatabaseInstance: openstack-$CELL <2>
49+
> cellMessageBusInstance: rabbitmq-$CELL <3>
50+
> metadataServiceTemplate:
51+
> enabled: false
52+
> override:
53+
> service:
54+
> metadata:
55+
> annotations:
56+
> metallb.universe.tf/address-pool: internalapi
57+
> metallb.universe.tf/allow-shared-ip: internalapi
58+
> metallb.universe.tf/loadBalancerIPs: 172.17.0.$(( 79 + ${CELL##*cell} ))
59+
> spec:
60+
> type: LoadBalancer
61+
> customServiceConfig: |
62+
> [workarounds]
63+
> disable_compute_service_check_for_ffu=true
64+
> conductorServiceTemplate:
65+
> customServiceConfig: |
66+
> [workarounds]
67+
> disable_compute_service_check_for_ffu=true
68+
>EOF
69+
>done
7170
7271
$ cat > oscp-patch.yaml << EOF
73-
spec:
74-
nova:
75-
enabled: true
76-
apiOverride:
77-
route: {}
78-
template:
79-
secret: osp-secret
80-
apiDatabaseAccount: nova-api
81-
apiServiceTemplate:
82-
override:
83-
service:
84-
internal:
85-
metadata:
86-
annotations:
87-
metallb.universe.tf/address-pool: internalapi
88-
metallb.universe.tf/allow-shared-ip: internalapi
89-
metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <4>
90-
spec:
91-
type: LoadBalancer
92-
customServiceConfig: |
93-
[workarounds]
94-
disable_compute_service_check_for_ffu=true
95-
metadataServiceTemplate:
96-
enabled: true
97-
override:
98-
service:
99-
metadata:
100-
annotations:
101-
metallb.universe.tf/address-pool: internalapi
102-
metallb.universe.tf/allow-shared-ip: internalapi
103-
metallb.universe.tf/loadBalancerIPs: 172.17.0.80
104-
spec:
105-
type: LoadBalancer
106-
customServiceConfig: |
107-
[workarounds]
108-
disable_compute_service_check_for_ffu=true
109-
schedulerServiceTemplate:
110-
customServiceConfig: |
111-
[workarounds]
112-
disable_compute_service_check_for_ffu=true
113-
cellTemplates:
114-
cell0:
115-
hasAPIAccess: true
116-
cellDatabaseAccount: nova-cell0
117-
cellDatabaseInstance: openstack
118-
cellMessageBusInstance: rabbitmq
119-
conductorServiceTemplate:
120-
customServiceConfig: |
121-
[workarounds]
122-
disable_compute_service_check_for_ffu=true
123-
EOF
72+
>spec:
73+
> nova:
74+
> enabled: true
75+
> apiOverride:
76+
> route: {}
77+
> template:
78+
> secret: osp-secret
79+
> apiDatabaseAccount: nova-api
80+
> apiServiceTemplate:
81+
> override:
82+
> service:
83+
> internal:
84+
> metadata:
85+
> annotations:
86+
> metallb.universe.tf/address-pool: internalapi
87+
> metallb.universe.tf/allow-shared-ip: internalapi
88+
> metallb.universe.tf/loadBalancerIPs: 172.17.0.80 <4>
89+
> spec:
90+
> type: LoadBalancer
91+
> customServiceConfig: |
92+
> [workarounds]
93+
> disable_compute_service_check_for_ffu=true
94+
> metadataServiceTemplate:
95+
> enabled: true
96+
> override:
97+
> service:
98+
> metadata:
99+
> annotations:
100+
> metallb.universe.tf/address-pool: internalapi
101+
> metallb.universe.tf/allow-shared-ip: internalapi
102+
> metallb.universe.tf/loadBalancerIPs: 172.17.0.80
103+
> spec:
104+
> type: LoadBalancer
105+
> customServiceConfig: |
106+
> [workarounds]
107+
> disable_compute_service_check_for_ffu=true
108+
> schedulerServiceTemplate:
109+
> customServiceConfig: |
110+
> [workarounds]
111+
> disable_compute_service_check_for_ffu=true
112+
> cellTemplates:
113+
> cell0:
114+
> hasAPIAccess: true
115+
> cellDatabaseAccount: nova-cell0
116+
> cellDatabaseInstance: openstack
117+
> cellMessageBusInstance: rabbitmq
118+
> conductorServiceTemplate:
119+
> customServiceConfig: |
120+
> [workarounds]
121+
> disable_compute_service_check_for_ffu=true
122+
>EOF
124123
$ cat celltemplates >> oscp-patch.yaml
125124
$ oc patch openstackcontrolplane openstack --type=merge --patch-file=oscp-patch.yaml
126125
----
@@ -174,16 +173,16 @@ $ openstack server list
174173
+
175174
----
176175
$ for CELL in $(echo $CELLS); do
177-
set +u
178-
. ~/.source_cloud_exported_variables_$CELL
179-
set -u
180-
RCELL=$CELL
181-
[ "$CELL" = "default" ] && RCELL=$DEFAULT_CELL_NAME
182-
183-
echo "comparing $CELL to $RCELL"
184-
echo $PULL_OPENSTACK_CONFIGURATION_NOVAMANAGE_CELL_MAPPINGS | grep -F "| $CELL |"
185-
$ oc rsh nova-cell0-conductor-0 nova-manage cell_v2 list_cells | grep -F "| $RCELL |"
186-
done
176+
> set +u
177+
> . ~/.source_cloud_exported_variables_$CELL
178+
> set -u
179+
> RCELL=$CELL
180+
> [ "$CELL" = "default" ] && RCELL=$DEFAULT_CELL_NAME
181+
>
182+
> echo "comparing $CELL to $RCELL"
183+
> echo $PULL_OPENSTACK_CONFIGURATION_NOVAMANAGE_CELL_MAPPINGS | grep -F "| $CELL |"
184+
> oc rsh nova-cell0-conductor-0 nova-manage cell_v2 list_cells | grep -F "| $RCELL |"
185+
> done
187186
----
188187
+
189188
The following changes are expected for each cell:

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,9 @@ control plane, excluding the {identity_service} and its endpoints:
6565
+
6666
----
6767
$ openstack endpoint list | grep keystone | awk '/admin/{ print $2; }' | xargs ${BASH_ALIASES[openstack]} endpoint delete || true
68-
69-
for service in aodh heat heat-cfn barbican cinderv3 glance gnocchi manila manilav2 neutron nova placement swift ironic-inspector ironic octavia; do
70-
openstack service list | awk "/ $service /{ print \$2; }" | xargs -r ${BASH_ALIASES[openstack]} service delete || true
71-
done
68+
> for service in aodh heat heat-cfn barbican cinderv3 glance gnocchi manila manilav2 neutron nova placement swift ironic-inspector ironic octavia; do
69+
> openstack service list | awk "/ $service /{ print \$2; }" | xargs -r ${BASH_ALIASES[openstack]} service delete || true
70+
> done
7271
----
7372

7473
.Verification

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ $ openstack endpoint list | grep placement
5353
5454
5555
# Without OpenStack CLI placement plugin installed:
56-
PLACEMENT_PUBLIC_URL=$(openstack endpoint list -c 'Service Name' -c 'Service Type' -c URL | grep placement | grep public | awk '{ print $6; }')
57-
oc exec -t openstackclient -- curl "$PLACEMENT_PUBLIC_URL"
56+
$ PLACEMENT_PUBLIC_URL=$(openstack endpoint list -c 'Service Name' -c 'Service Type' -c URL | grep placement | grep public | awk '{ print $6; }')
57+
$ oc exec -t openstackclient -- curl "$PLACEMENT_PUBLIC_URL"
5858
5959
# With OpenStack CLI placement plugin installed:
60-
openstack resource class list
60+
$ openstack resource class list
6161
----

‎docs_user/modules/proc_completing-prerequisites-for-migrating-ceph-rbd.adoc‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ $ openstack overcloud node provision \
4949
----
5050
.. Verify that the storage network is configured on the target nodes:
5151
+
52-
[source,yaml]
5352
----
5453
(undercloud) [stack@undercloud ~]$ ssh [email protected] ip -o -4 a
5554
1: lo inet 127.0.0.1/8 scope host lo\ valid_lft forever preferred_lft forever

‎docs_user/modules/proc_configuring-a-ceph-backend.adoc‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@ stringData:
7979

8080
. In your `OpenStackControlPlane` CR, inject `ceph.conf` and `ceph.client.openstack.keyring` to the {OpenStackShort} services that are defined in the propagation list. For example:
8181
+
82-
[source,yaml]
8382
----
8483
$ oc patch openstackcontrolplane openstack --type=merge --patch '
8584
spec:

‎docs_user/modules/proc_migrating-ceph-mds.adoc‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,9 @@ dumped fsmap epoch 8
9191
+
9292
----
9393
$ sudo cephadm shell -- ceph osd blocklist ls
94-
..
95-
..
96-
for item in $(sudo cephadm shell -- ceph osd blocklist ls | awk '{print $1}'); do
97-
sudo cephadm shell -- ceph osd blocklist rm $item;
98-
done
94+
$ for item in $(sudo cephadm shell -- ceph osd blocklist ls | awk '{print $1}'); do
95+
> sudo cephadm shell -- ceph osd blocklist rm $item;
96+
> done
9997
----
10098
+
10199
[NOTE]

‎docs_user/modules/proc_migrating-mgr-from-controller-nodes.adoc‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ $ sudo cephadm shell -- ceph orch host label add <target_node> mgr
7575

7676
. Get the Ceph Manager spec:
7777
+
78-
[source,yaml]
7978
----
8079
8180
$ SPEC_DIR=${SPEC_DIR:-"$PWD/ceph_specs"}

0 commit comments

Comments
 (0)