summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDmitry Tantsur <dtantsur@protonmail.com>2022-01-25 15:37:13 +0100
committerDmitry Tantsur <dtantsur@protonmail.com>2022-01-25 15:37:13 +0100
commita7cd4d55787353ae6e9ed818d12c853f45c8bd35 (patch)
tree7aa81d0a8dc09bd38fba6f94d04eea581af37061 /doc
parent16dc23c3c5c113a1ef0442a45d33488d5d0f9160 (diff)
downloadironic-a7cd4d55787353ae6e9ed818d12c853f45c8bd35.tar.gz
Recommend various installers in the install guide
Arguably, installing ironic from packages manually should not be the first option to resort to. Link to some installers. Change-Id: Ia5d90263f73bae5f94d5239e71a7ae81262b5117
Diffstat (limited to 'doc')
-rw-r--r--doc/source/install/install.rst29
1 files changed, 25 insertions, 4 deletions
diff --git a/doc/source/install/install.rst b/doc/source/install/install.rst
index 75a9b8f39..b2c9e1da8 100644
--- a/doc/source/install/install.rst
+++ b/doc/source/install/install.rst
@@ -1,12 +1,33 @@
-.. _install:
-
Install and configure the Bare Metal service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This section describes how to install and configure the
-Bare Metal service, code-named ironic.
+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.
-Note that installation and configuration vary by distribution.
+Contents
+--------
.. toctree::
:maxdepth: 2