Skip to content

Commit 869fb57

Browse files
committed
Remove command prefixes
1 parent 8f001c4 commit 869fb57

File tree

5 files changed

+49
-51
lines changed

5 files changed

+49
-51
lines changed

doc/source/operations/bifrost-hardware-inventory-management.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ can be reinspected like this:
1313

1414
.. code-block:: console
1515
16-
kayobe# kayobe overcloud hardware inspect --limit <Host name>
16+
kayobe overcloud hardware inspect --limit <Host name>
1717
1818
.. _enrolling-new-hypervisors:
1919

@@ -30,26 +30,26 @@ file located at ``$KAYOBE_CONFIG_PATH/secrets.yml``.
3030

3131
.. code-block:: console
3232
33-
bifrost# ipmitool -I lanplus -U <ipmi username> -H <Hostname>-ipmi chassis bootdev pxe
33+
ipmitool -I lanplus -U <ipmi username> -H <Hostname>-ipmi chassis bootdev pxe
3434
3535
If node is are off, power them on:
3636

3737
.. code-block:: console
3838
39-
bifrost# ipmitool -I lanplus -U <ipmi username> -H <Hostname>-ipmi power on
39+
ipmitool -I lanplus -U <ipmi username> -H <Hostname>-ipmi power on
4040
4141
If nodes is on, reset them:
4242

4343
.. code-block:: console
4444
45-
bifrost# ipmitool -I lanplus -U <ipmi username> -H <Hostname>-ipmi power reset
45+
ipmitool -I lanplus -U <ipmi username> -H <Hostname>-ipmi power reset
4646
4747
Once node have booted and have completed introspection, they should be visible
4848
in Bifrost:
4949

5050
.. code-block:: console
5151
52-
bifrost# baremetal node list --provision-state enroll
52+
baremetal node list --provision-state enroll
5353
+--------------------------------------+-----------------------+---------------+-------------+--------------------+-------------+
5454
| UUID | Name | Instance UUID | Power State | Provisioning State | Maintenance |
5555
+--------------------------------------+-----------------------+---------------+-------------+--------------------+-------------+
@@ -63,15 +63,15 @@ the correct groups, import them in Kayobe's inventory with:
6363

6464
.. code-block:: console
6565
66-
kayobe# kayobe overcloud inventory discover
66+
kayobe overcloud inventory discover
6767
6868
We can then provision and configure them:
6969

7070
.. code-block:: console
7171
72-
kayobe# kayobe overcloud provision --limit <Hostname>
73-
kayobe# kayobe overcloud host configure --limit <Hostname>
74-
kayobe# kayobe overcloud service deploy --limit <Hostname> --kolla-limit <Hostname>
72+
kayobe overcloud provision --limit <Hostname>
73+
kayobe overcloud host configure --limit <Hostname>
74+
kayobe overcloud service deploy --limit <Hostname> --kolla-limit <Hostname>
7575
7676
.. note::
7777

@@ -94,7 +94,7 @@ To deprovision an existing hypervisor, run:
9494

9595
.. code-block:: console
9696
97-
kayobe# kayobe overcloud deprovision --limit <Hypervisor hostname>
97+
kayobe overcloud deprovision --limit <Hypervisor hostname>
9898
9999
.. warning::
100100

@@ -109,14 +109,14 @@ Evacuating all instances
109109

110110
.. code-block:: console
111111
112-
admin# openstack server evacuate $(openstack server list --host <Hypervisor hostname> --format value --column ID)
112+
openstack server evacuate $(openstack server list --host <Hypervisor hostname> --format value --column ID)
113113
114114
You should now check the status of all the instances that were running on that
115115
hypervisor. They should all show the status ACTIVE. This can be verified with:
116116

117117
.. code-block:: console
118118
119-
admin# openstack server show <instance uuid>
119+
openstack server show <instance uuid>
120120
121121
Troubleshooting
122122
===============
@@ -145,7 +145,7 @@ migrate as the process needs manual confirmation. You can do this with:
145145

146146
.. code-block:: console
147147
148-
openstack# openstack server resize confirm <instance-uuid>
148+
openstack server resize confirm <instance-uuid>
149149
150150
The symptom to look out for is that the server is showing a status of ``VERIFY
151151
RESIZE`` as shown in this snippet of ``openstack server show <instance-uuid>``:
@@ -161,7 +161,7 @@ Set maintenance mode on a node in Bifrost
161161

162162
.. code-block:: console
163163
164-
seed# docker exec -it bifrost_deploy /bin/bash
164+
docker exec -it bifrost_deploy /bin/bash
165165
(bifrost-deploy)[root@seed bifrost-base]# export OS_CLOUD=bifrost
166166
(bifrost-deploy)[root@seed bifrost-base]# baremetal node maintenance set <Hostname>
167167
@@ -172,7 +172,7 @@ Unset maintenance mode on a node in Bifrost
172172

173173
.. code-block:: console
174174
175-
seed# docker exec -it bifrost_deploy /bin/bash
175+
docker exec -it bifrost_deploy /bin/bash
176176
(bifrost-deploy)[root@seed bifrost-base]# export OS_CLOUD=bifrost
177177
(bifrost-deploy)[root@seed bifrost-base]# baremetal node maintenance unset <Hostname>
178178
@@ -210,7 +210,7 @@ into ``$KAYOBE_CONFIG_PATH/overcloud-introspection-data``:
210210

211211
.. code-block:: console
212212
213-
kayobe# kayobe overcloud introspection data save
213+
kayobe overcloud introspection data save
214214
215215
Using ADVise
216216
------------

doc/source/operations/control-plane-operation.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ The password can be found using:
120120

121121
.. code-block:: console
122122
123-
kayobe# ansible-vault view $KAYOBE_CONFIG_PATH/kolla/passwords.yml \
123+
ansible-vault view $KAYOBE_CONFIG_PATH/kolla/passwords.yml \
124124
--vault-password-file <Vault password file path> | grep ^database
125125
126126
Checking RabbitMQ
@@ -188,7 +188,7 @@ Shutting down the seed VM
188188

189189
.. code-block:: console
190190
191-
kayobe# virsh shutdown <Seed hostname>
191+
virsh shutdown <Seed hostname>
192192
193193
.. _full-shutdown:
194194

@@ -215,7 +215,7 @@ Example: Reboot all compute hosts apart from compute0:
215215

216216
.. code-block:: console
217217
218-
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/reboot.yml --limit 'compute:!compute0'
218+
kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/reboot.yml --limit 'compute:!compute0'
219219
220220
References
221221
----------
@@ -242,7 +242,7 @@ with the following command:
242242

243243
.. code-block:: console
244244
245-
kayobe# kayobe overcloud database recover
245+
kayobe overcloud database recover
246246
247247
Ansible Control Host
248248
--------------------
@@ -258,7 +258,7 @@ hypervisor is powered on. If it does not, it can be started with:
258258

259259
.. code-block:: console
260260
261-
kayobe# virsh start <Seed hostname>
261+
virsh start <Seed hostname>
262262
263263
Full power on
264264
-------------
@@ -275,7 +275,7 @@ Log into the monitoring host(s):
275275

276276
.. code-block:: console
277277
278-
kayobe# ssh stack@monitoring0
278+
ssh stack@monitoring0
279279
280280
Stop all Docker containers:
281281

@@ -312,22 +312,22 @@ To sync host packages:
312312

313313
.. code-block:: console
314314
315-
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-repo-sync.yml
316-
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-repo-publish.yml
315+
kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-repo-sync.yml
316+
kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-repo-publish.yml
317317
318318
If the system is production environment and want to use packages tested in test/staging
319319
environment, you can promote them by:
320320

321321
.. code-block:: console
322322
323-
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-repo-promote-production.yml
323+
kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-repo-promote-production.yml
324324
325325
To sync container images:
326326

327327
.. code-block:: console
328328
329-
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-container-sync.yml
330-
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-container-publish.yml
329+
kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-container-sync.yml
330+
kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-container-publish.yml
331331
332332
For more information about StackHPC Release Train, see :ref:`stackhpc-release-train` documentation.
333333

@@ -341,8 +341,8 @@ Host packages can be updated with:
341341

342342
.. code-block:: console
343343
344-
kayobe# kayobe overcloud host package update --limit <node> --packages '*'
345-
kayobe# kayobe seed host package update --packages '*'
344+
kayobe overcloud host package update --limit <node> --packages '*'
345+
kayobe seed host package update --packages '*'
346346
347347
See https://docs.openstack.org/kayobe/latest/administration/overcloud.html#updating-packages
348348

@@ -387,7 +387,7 @@ Reconfigure Opensearch with new values:
387387

388388
.. code-block:: console
389389
390-
kayobe# kayobe overcloud service reconfigure --kolla-tags opensearch
390+
kayobe overcloud service reconfigure --kolla-tags opensearch
391391
392392
For more information see the `upstream documentation
393393
<https://docs.openstack.org/kolla-ansible/latest/reference/logging-and-monitoring/central-logging-guide.html#applying-log-retention-policies>`__.

doc/source/operations/gpu-in-openstack.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -783,8 +783,8 @@ add extra_specs to flavor in etc/openstack-config/openstack-config.yml:
783783

784784
.. code-block:: console
785785
786-
admin# cd src/openstack-config
787-
admin# vim etc/openstack-config/openstack-config.yml
786+
cd src/openstack-config
787+
vim etc/openstack-config/openstack-config.yml
788788
789789
name: "m1.medium-gpu"
790790
ram: 4096
@@ -797,9 +797,9 @@ Invoke configuration playbooks afterwards:
797797

798798
.. code-block:: console
799799
800-
admin# source src/kayobe-config/etc/kolla/public-openrc.sh
801-
admin# source venvs/openstack/bin/activate
802-
admin# tools/openstack-config --vault-password-file <Vault password file path>
800+
source src/kayobe-config/etc/kolla/public-openrc.sh
801+
source venvs/openstack/bin/activate
802+
tools/openstack-config --vault-password-file <Vault password file path>
803803
804804
Create instance with GPU passthrough
805805
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

doc/source/operations/migrating-vm.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ To see where all virtual machines are running on the hypervisors:
66

77
.. code-block:: console
88
9-
admin# openstack server list --all-projects --long
9+
openstack server list --all-projects --long
1010
1111
To move a virtual machine with shared storage or booted from volume from one hypervisor to another, for example to
1212
hypervisor-01:
1313

1414
.. code-block:: console
1515
16-
admin# openstack server migrate --live-migration --host hypervisor-01 <VM name or uuid>
16+
openstack server migrate --live-migration --host hypervisor-01 <VM name or uuid>
1717
1818
To move a virtual machine with local disks:
1919

2020
.. code-block:: console
2121
22-
admin# openstack server migrate --live-migration --block-migration --host hypervisor-01 <VM name or uuid>
22+
openstack server migrate --live-migration --block-migration --host hypervisor-01 <VM name or uuid>

doc/source/operations/openstack-reconfiguration.rst

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Then, reconfigure Cinder services with Kayobe:
2121

2222
.. code-block:: console
2323
24-
kayobe# kayobe overcloud service reconfigure --kolla-tags cinder
24+
kayobe overcloud service reconfigure --kolla-tags cinder
2525
2626
However, the service itself, no longer in Ansible's manifest of managed state,
2727
must be manually stopped and prevented from restarting.
@@ -30,7 +30,7 @@ On each controller:
3030

3131
.. code-block:: console
3232
33-
kayobe# docker rm -f cinder_backup
33+
docker rm -f cinder_backup
3434
3535
Some services may store data in a dedicated Docker volume, which can be removed
3636
with ``docker volume rm``.
@@ -50,7 +50,7 @@ Use a command of this form:
5050

5151
.. code-block:: console
5252
53-
kayobe# ansible-vault edit $KAYOBE_CONFIG_PATH/secrets.yml --vault-password-file=<Vault password file path>
53+
ansible-vault edit $KAYOBE_CONFIG_PATH/secrets.yml --vault-password-file=<Vault password file path>
5454
5555
Concatenate the contents of the certificate and key files to create
5656
``secrets_kolla_external_tls_cert``. The certificates should be installed in
@@ -72,7 +72,7 @@ be updated in Keystone:
7272

7373
.. code-block:: console
7474
75-
kayobe# kayobe overcloud service reconfigure
75+
kayobe overcloud service reconfigure
7676
7777
Alternative Configuration
7878
-------------------------
@@ -95,7 +95,7 @@ reach the OpenStack APIs:
9595

9696
.. code-block:: console
9797
98-
openstack# openssl s_client -connect <Public endpoint FQDN>:443 2> /dev/null | openssl x509 -noout -dates
98+
openssl s_client -connect <Public endpoint FQDN>:443 2> /dev/null | openssl x509 -noout -dates
9999
100100
.. note::
101101

@@ -108,7 +108,7 @@ above. Run the following command:
108108

109109
.. code-block:: console
110110
111-
kayobe# kayobe overcloud service reconfigure --kolla-tags haproxy
111+
kayobe overcloud service reconfigure --kolla-tags haproxy
112112
113113
.. _taking-a-hypervisor-out-of-service:
114114

@@ -119,8 +119,7 @@ To take a hypervisor out of Nova scheduling:
119119

120120
.. code-block:: console
121121
122-
admin# openstack compute service set --disable \
123-
<Hypervisor name> nova-compute
122+
openstack compute service set --disable <Hypervisor name> nova-compute
124123
125124
Running instances on the hypervisor will not be affected, but new instances
126125
will not be deployed on it.
@@ -130,19 +129,18 @@ A reason for disabling a hypervisor can be documented with the
130129

131130
.. code-block:: console
132131
133-
admin# openstack compute service set --disable \
134-
--disable-reason "Broken drive" <Hypervisor name> nova-compute
132+
openstack compute service set --disable \
133+
--disable-reason "Broken drive" <Hypervisor name> nova-compute
135134
136135
Details about all hypervisors and the reasons they are disabled can be
137136
displayed with:
138137

139138
.. code-block:: console
140139
141-
admin# openstack compute service list --long
140+
openstack compute service list --long
142141
143142
And then to enable a hypervisor again:
144143

145144
.. code-block:: console
146145
147-
admin# openstack compute service set --enable \
148-
<Hypervisor name> nova-compute
146+
openstack compute service set --enable <Hypervisor name> nova-compute

0 commit comments

Comments
 (0)