ironic/doc/source/install/install.rst
Steve Baker beaaf405d3 Add ironic-novncproxy service
This is a forklift of the nova novncproxy service to act as the noVNC
front-end to graphical consoles.

The service does the following:
- serves noVNC web assets for the browser based VNC client
- creates a websocket to proxy VNC traffic to an actual VNC server
- decouples authentication traffic so that the source server can have
  a different authentication method than the browser client

The forklifted code has been adapted to Ironic conventions, including:
- [vnc] config options following Ironic conventions and using existing
  config options where appropriate
- Removing the unnecessary authentication method VeNCrypt, leaving only
  the None auth method.
- Adapting the ironic-novncproxy command to use Ironic's service launch
  approach, allowing it to be started as part of the all-in-one ironic
- Replace Nova's approach of looking up the instance via the token.
  Instead the node UUID is included in the websocket querystring
  alongside the token
- Removing cookie fallback when token is missing from querystring
- Removing expected protocol validation in the websocket handshake
- Removing internal access path support
- Removing enforce_session_timeout as this will be done at the
  container level

Related-Bug: 2086715
Change-Id: I575a8671e2262408ba1d690cfceabe992c2d4fef
2025-02-19 20:17:57 +00:00

78 lines
2.5 KiB
ReStructuredText

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install and configure the Bare Metal service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This section describes how to install and configure the
Bare Metal service, code-named ironic, manually from packages on one of the
three popular families of Linux distributions.
Alternatively, you can use one of the numerous projects that install ironic.
One of them is provided by the bare metal team:
* `Bifrost <https://docs.openstack.org/bifrost/latest/>`_ installs ironic in
the standalone mode (without the rest of OpenStack).
More installation projects are developed by other OpenStack teams:
* `Kolla
<https://docs.openstack.org/kolla-ansible/latest/reference/bare-metal/ironic-guide.html>`_
can install ironic in containers as part of OpenStack.
* OpenStack-Ansible has a `role to install ironic
<https://docs.openstack.org/openstack-ansible-os_ironic/latest/>`_.
* TripleO uses ironic for provisioning bare metal nodes and can also be used
`to install ironic
<https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/features/baremetal_overcloud.html>`_.
.. NOTE(dtantsur): add your favourite installation tool, but please link to the
**Ironic guide**, not to the generic page. If a separate Ironic guide does
not exist yet, create it first.
.. toctree::
:hidden:
install-rdo.rst
install-ubuntu.rst
install-obs.rst
.. include:: include/common-prerequisites.inc
Install and configure components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Using DNF on RHEL/CentOS Stream and RDO_ packages:
.. code-block:: console
# dnf install openstack-ironic-api openstack-ironic-conductor openstack-ironic-novncproxy python3-ironicclient
.. _rdo: https://www.rdoproject.org/
On Ubuntu_/Debian:
.. code-block:: console
# apt-get install ironic-api ironic-conductor ironic-novncproxy python3-ironicclient
.. _ubuntu: https://docs.openstack.org/install-guide/environment-packages-ubuntu.html
On openSUSE/SLES:
.. code-block:: console
# zypper install openstack-ironic-api openstack-ironic-conductor ironic-novncproxy python3-ironicclient
.. warning::
Support for SUSE systems is best effort, it is not tested in the CI.
.. include:: include/common-configure.inc
.. include:: include/configure-ironic-api.inc
.. include:: include/configure-ironic-api-mod_wsgi.inc
.. include:: include/configure-ironic-conductor.inc
.. include:: include/configure-ironic-novncproxy.inc
.. include:: include/configure-ironic-singleprocess.inc