openstack/bifrost
Code Issues Proposed changes

Documentation: minor fixes in the user guide

Browse Source 
Change-Id: If60bef72c87fc15fc12b209a09d10b91a530ae20
This commit is contained in:
Dmitry Tantsur 2020-06-04 10:47:42 +02:00
parent 508899cc6b
commit 4b2913ab61
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/user/howto.rst
View File

@ -2,10 +2,10 @@
How-To How-To
====== ======
Use the OpenStack CLI Use the baremetal CLI
===================== =====================
If you wish to utilize the OpenStack CLI in no-auth mode, there are two options If you wish to utilize the baremetal CLI in no-auth mode, there are two options
for configuring the authentication parameters. for configuring the authentication parameters.
clouds.yaml clouds.yaml
@ -43,6 +43,13 @@ example::
This should display a table of nodes, or nothing if there are no nodes This should display a table of nodes, or nothing if there are no nodes
registered in Ironic. registered in Ironic.
Installing OpenStack CLI
------------------------
Starting with the Victoria release, the ``openstack`` command is only installed
when Keystone is enabled. Install the ``python-openstackclient`` Python package
to get this command.
Enroll Hardware Enroll Hardware
=============== ===============
@ -250,9 +257,7 @@ By default, Bifrost deploys a configuration drive which includes the user SSH
public key, hostname, and the network configuration in the form of public key, hostname, and the network configuration in the form of
network_data.json that can be read/parsed by the network_data.json that can be read/parsed by the
`glean <https://opendev.org/opendev/glean>`_ utility. This allows for `glean <https://opendev.org/opendev/glean>`_ utility. This allows for
the deployment of Ubuntu, CentOS, or Fedora "tenants" on baremetal. This file the deployment of Ubuntu, CentOS, or Fedora "tenants" on baremetal.
format is not yet supported by Cloud-Init, however it is on track for
inclusion in cloud-init 2.0.
By default, Bifrost utilizes a utility called simple-init which leverages By default, Bifrost utilizes a utility called simple-init which leverages
the previously noted glean utility to apply network configuration. This the previously noted glean utility to apply network configuration. This

5
doc/source/user/keystone.rst
View File

@ -1,10 +1,5 @@
.. _keystone: .. _keystone:
.. NOTE:: Use of keystone with bifrost is a very new feature and should
be considered an advanced topic. Please feel free to reach out to the
bifrost contributors and the ironic community as a whole in the project's
`IRC`_ channel.
.. _`IRC`: https://wiki.openstack.org/wiki/Ironic#IRC .. _`IRC`: https://wiki.openstack.org/wiki/Ironic#IRC
Bifrost execution with Keystone Bifrost execution with Keystone

2
doc/source/user/troubleshooting.rst
View File

@ -13,7 +13,7 @@ are being booted can connect to the following ports::
67/UDP for DHCP requests to be serviced 67/UDP for DHCP requests to be serviced
69/UDP for TFTP file transfers (Initial iPXE binary) 69/UDP for TFTP file transfers (Initial iPXE binary)
6301/TCP for the ironic API 6385/TCP for the ironic API
8080/TCP for HTTP File Downloads (iPXE, Ironic-Python-Agent) 8080/TCP for HTTP File Downloads (iPXE, Ironic-Python-Agent)
If you encounter any additional issues, use of ``tcpdump`` is highly If you encounter any additional issues, use of ``tcpdump`` is highly