d710027627
This a continuation to the efforts to ensure that the documentation is free from typos and grammatical mistakes so that the reader is not confused. Includes fixes for some of the documentation in doc/source/admin/* Change-Id: Idc29be9815fb53def3482ac0b290a237a0a1b3da
141 lines
4.9 KiB
ReStructuredText
141 lines
4.9 KiB
ReStructuredText
Layer 3 or DHCP-less ramdisk booting
|
|
====================================
|
|
|
|
Booting nodes via PXE, while universally supported, suffers from one
|
|
disadvantage: it requires a direct L2 connectivity between the node and the
|
|
control plane for DHCP. Using virtual media it is possible to avoid not only
|
|
the unreliable TFTP protocol but DHCP altogether.
|
|
|
|
When network data is provided for a node as explained below, the generated
|
|
virtual media ISO will also serve as a configdrive_, and the network data will
|
|
be stored in the standard OpenStack location.
|
|
|
|
The simple-init_ element needs to be used when creating the deployment ramdisk.
|
|
The Glean_ tool will look for a media labeled as ``config-2``. If found, the
|
|
network information from it will be read, and the node's networking stack will
|
|
be configured accordingly.
|
|
|
|
.. code-block:: console
|
|
|
|
ironic-python-agent-builder -o /output/ramdisk \
|
|
debian-minimal -e simple-init
|
|
|
|
.. warning::
|
|
Ramdisks based on distributions with NetworkManager require Glean_ 1.19.0
|
|
or newer to work.
|
|
|
|
.. note::
|
|
If desired, some interfaces can still be configured to use DHCP.
|
|
|
|
Hardware type support
|
|
---------------------
|
|
|
|
This feature is known to work with the following hardware types:
|
|
|
|
* :doc:`Redfish </admin/drivers/redfish>` with ``redfish-virtual-media`` boot
|
|
* :doc:`iLO </admin/drivers/ilo>` with ``ilo-virtual-media`` boot
|
|
|
|
Configuring network data
|
|
------------------------
|
|
|
|
When the Bare Metal service is running within OpenStack, no additional
|
|
configuration is required - the network configuration will be fetched from the
|
|
Network service.
|
|
|
|
Alternatively, the user can build and pass network configuration in the form
|
|
of a network_data_ JSON to a node via the ``network_data`` field. Node-based
|
|
configuration takes precedence over the configuration generated by the
|
|
Network service and also works in standalone mode.
|
|
|
|
.. code-block:: bash
|
|
|
|
baremetal node set --network-data ~/network_data.json <node>
|
|
|
|
An example network data:
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"links": [
|
|
{
|
|
"id": "port-92750f6c-60a9-4897-9cd1-090c5f361e18",
|
|
"type": "phy",
|
|
"ethernet_mac_address": "52:54:00:d3:6a:71"
|
|
}
|
|
],
|
|
"networks": [
|
|
{
|
|
"id": "network0",
|
|
"type": "ipv4",
|
|
"link": "port-92750f6c-60a9-4897-9cd1-090c5f361e18",
|
|
"ip_address": "192.168.122.42",
|
|
"netmask": "255.255.255.0",
|
|
"network_id": "network0",
|
|
"routes": []
|
|
}
|
|
],
|
|
"services": []
|
|
}
|
|
|
|
.. note::
|
|
Some fields are redundant with the port information. We're looking into
|
|
simplifying the format, but currently, all these fields are mandatory.
|
|
|
|
You'll need the deployed image to support network data, e.g. by pre-installing
|
|
cloud-init_ or Glean_ on it (most cloud images have the former). Then you can
|
|
provide the network data when deploying, for example:
|
|
|
|
.. code-block:: bash
|
|
|
|
baremetal node deploy <node> \
|
|
--config-drive "{\"network_data\": $(cat ~/network_data.json)}"
|
|
|
|
Some first-boot services, such as Ignition_, don't support network data. You
|
|
can provide their configuration as part of user data instead:
|
|
|
|
.. code-block:: bash
|
|
|
|
baremetal node deploy <node> \
|
|
--config-drive "{\"user_data\": \"... ignition config ...\"}"
|
|
|
|
.. _configdrive: https://docs.openstack.org/nova/queens/user/config-drive.html
|
|
.. _Glean: https://docs.openstack.org/infra/glean/
|
|
.. _simple-init: https://docs.openstack.org/diskimage-builder/latest/elements/simple-init/README.html
|
|
.. _network_data: https://specs.openstack.org/openstack/nova-specs/specs/liberty/implemented/metadata-service-network-info.html
|
|
.. _cloud-init: https://cloudinit.readthedocs.io/en/latest/
|
|
.. _Ignition: https://coreos.github.io/ignition/
|
|
|
|
.. _l3-external-ip:
|
|
|
|
Deploying outside of the provisioning network
|
|
---------------------------------------------
|
|
|
|
If you need to combine traditional deployments using a provisioning network
|
|
with virtual media deployments over L3, you may need to provide an alternative
|
|
IP address for the remote nodes to connect to:
|
|
|
|
.. code-block:: ini
|
|
|
|
[deploy]
|
|
http_url = <HTTP server URL internal to the provisioning network>
|
|
external_http_url = <HTTP server URL with a routable IP address>
|
|
|
|
You may also need to override the callback URL, which is normally fetched from
|
|
the service catalog or configured in the ``[service_catalog]`` section:
|
|
|
|
.. code-block:: ini
|
|
|
|
[deploy]
|
|
external_callback_url = <Bare Metal API URL with a routable IP address>
|
|
|
|
|
|
In case you need specific URLs for each node, you can use the
|
|
``driver_info[external_http_url]`` node property. When used it overrides the
|
|
:oslo.config:option:`deploy.http_url` and :oslo.config:option:`deploy.external_http_url` settings in the
|
|
configuration file.
|
|
|
|
.. code-block:: bash
|
|
|
|
baremetal node set node-0 \
|
|
--driver-info external_http_url="<your_node_external_url>"
|