Add subsections to the standalone documentation

Change-Id: I51da88d32e5e42c0c4e0e489c888d38b31517b59
This commit is contained in:
Dmitry Tantsur 2020-07-24 12:17:51 +02:00
parent 3e92fd054b
commit 946087020a
1 changed files with 45 additions and 29 deletions

View File

@ -2,6 +2,9 @@
Using Bare Metal service as a standalone service Using Bare Metal service as a standalone service
================================================ ================================================
Service settings
----------------
It is possible to use the Bare Metal service without other OpenStack services. It is possible to use the Bare Metal service without other OpenStack services.
You should make the following changes to ``/etc/ironic/ironic.conf``: You should make the following changes to ``/etc/ironic/ironic.conf``:
@ -73,6 +76,9 @@ You should make the following changes to ``/etc/ironic/ironic.conf``:
http_basic_username=myName http_basic_username=myName
http_basic_password=myPassword http_basic_password=myPassword
Preparing images
----------------
If you don't use Image service, it's possible to provide images to Bare Metal If you don't use Image service, it's possible to provide images to Bare Metal
service via a URL. service via a URL.
@ -93,25 +99,37 @@ There are however some limitations for different hardware interfaces:
* :ref:`direct-deploy` requires the instance image be accessible through a * :ref:`direct-deploy` requires the instance image be accessible through a
HTTP(s) URL. HTTP(s) URL.
Steps to start a deployment are pretty similar to those when using Compute: .. note::
The Bare Metal service tracks content changes for non-Glance images by
checking their modification date and time. For example, for HTTP image,
if 'Last-Modified' header value from response to a HEAD request to
"http://my.server.net/images/deploy.ramdisk" is greater than cached image
modification time, Ironic will re-download the content. For "file://"
images, the file system modification time is used.
#. To use the Using CLI
:python-ironicclient-doc:`openstack baremetal CLI <cli/osc_plugin_cli.html>`, ---------
set up these environment variables. If the ``noauth`` authentication strategy is
being used, the value ``none`` must be set for OS_AUTH_TYPE. OS_ENDPOINT is
the URL of the ironic-api process.
For example::
export OS_AUTH_TYPE=none To use the
export OS_ENDPOINT=http://localhost:6385/ :python-ironicclient-doc:`openstack baremetal CLI <cli/osc_plugin_cli.html>`,
set up these environment variables. If the ``noauth`` authentication strategy is
being used, the value ``none`` must be set for OS_AUTH_TYPE. OS_ENDPOINT is
the URL of the ironic-api process.
For example::
If the ``http_basic`` authentication strategy is being used, the value export OS_AUTH_TYPE=none
``http_basic`` must be set for OS_AUTH_TYPE. For example:: export OS_ENDPOINT=http://localhost:6385/
export OS_AUTH_TYPE=http_basic If the ``http_basic`` authentication strategy is being used, the value
export OS_ENDPOINT=http://localhost:6385/ ``http_basic`` must be set for OS_AUTH_TYPE. For example::
export OS_USERNAME=myUser
export OS_PASSWORD=myPassword export OS_AUTH_TYPE=http_basic
export OS_ENDPOINT=http://localhost:6385/
export OS_USERNAME=myUser
export OS_PASSWORD=myPassword
Enrolling nodes
---------------
#. Create a node in Bare Metal service. At minimum, you must specify the driver #. Create a node in Bare Metal service. At minimum, you must specify the driver
name (for example, ``ipmi``). You can also specify all the required name (for example, ``ipmi``). You can also specify all the required
@ -153,6 +171,9 @@ Steps to start a deployment are pretty similar to those when using Compute:
openstack baremetal port create $MAC_ADDRESS --node $NODE_UUID openstack baremetal port create $MAC_ADDRESS --node $NODE_UUID
Populating instance_info
------------------------
#. You also need to specify image information in the node's ``instance_info`` #. You also need to specify image information in the node's ``instance_info``
(see :doc:`creating-images`): (see :doc:`creating-images`):
@ -233,6 +254,15 @@ Steps to start a deployment are pretty similar to those when using Compute:
This setting overrides any previous setting in ``properties`` and will be This setting overrides any previous setting in ``properties`` and will be
removed on undeployment. removed on undeployment.
#. For iLO drivers, fields that should be provided are:
* ``ilo_deploy_iso`` under ``driver_info``;
* ``ilo_boot_iso``, ``image_source``, ``root_gb`` under ``instance_info``.
Deployment
----------
#. Validate that all parameters are correct:: #. Validate that all parameters are correct::
openstack baremetal node validate $NODE_UUID openstack baremetal node validate $NODE_UUID
@ -255,20 +285,6 @@ Steps to start a deployment are pretty similar to those when using Compute:
openstack baremetal node deploy $NODE_UUID openstack baremetal node deploy $NODE_UUID
For iLO drivers, fields that should be provided are:
* ``ilo_deploy_iso`` under ``driver_info``;
* ``ilo_boot_iso``, ``image_source``, ``root_gb`` under ``instance_info``.
.. note::
The Bare Metal service tracks content changes for non-Glance images by
checking their modification date and time. For example, for HTTP image,
if 'Last-Modified' header value from response to a HEAD request to
"http://my.server.net/images/deploy.ramdisk" is greater than cached image
modification time, Ironic will re-download the content. For "file://"
images, the file system modification time is used.
Ramdisk booting Ramdisk booting
--------------- ---------------