docs/doc/source/_includes/ironic.rest
Ron Stone f98eb51fb4 Simplify install dirs
Simplify install doc dir structure
- Remove r6 directory
- Rename r7 directory to be non release-specific
- Delete unused files
- Delete obsolete include files
- Delete obsolete commented sections in install topics
- Remove redundent version menu entry

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I59634826d4b3af41410e9d26cc182f6b4aed8ade
2023-01-04 07:30:40 -05:00

64 lines
2.0 KiB
ReStructuredText

--------
Overview
--------
Ironic is an OpenStack project that provisions bare metal machines. For
information about the Ironic project, see
`Ironic Documentation <https://docs.openstack.org/ironic>`__.
End user applications can be deployed on bare metal servers (instead of
virtual machines) by configuring OpenStack Ironic and deploying a pool of 1 or
more bare metal servers.
.. note::
If you are behind a corporate firewall or proxy, you need to set proxy
settings. Refer to :ref:`docker_proxy_config` for
details.
.. figure:: /deploy_install_guides/release/figures/starlingx-deployment-options-ironic.png
:scale: 50%
:alt: Standard with Ironic deployment configuration
*Figure 1: Standard with Ironic deployment configuration*
Bare metal servers must be connected to:
* IPMI for OpenStack Ironic control
* ironic-provisioning-net tenant network via their untagged physical interface,
which supports PXE booting
As part of configuring OpenStack Ironic in StarlingX:
* An ironic-provisioning-net tenant network must be identified as the boot
network for bare metal nodes.
* An additional untagged physical interface must be configured on controller
nodes and connected to the ironic-provisioning-net tenant network. The
OpenStack Ironic tftpboot server will PXE boot the bare metal servers over
this interface.
.. note::
Bare metal servers are NOT:
* Running any OpenStack / StarlingX software; they are running end user
applications (for example, Glance Images).
* To be connected to the internal management network.
------------
Installation
------------
StarlingX currently supports only a bare metal installation of Ironic with a
standard configuration, either:
* :doc:`controller_storage_install_kubernetes`
* :doc:`dedicated_storage_install_kubernetes`
This guide assumes that you have a standard deployment installed and configured
with 2x controllers and at least 1x compute-labeled worker node, with the
StarlingX OpenStack application (|prefix|-openstack) applied.