openstack/ironic
Code Issues Proposed changes

Stop splitting installation docs per distros

Browse Source 
The versions only differ in the first paragraph, and the supposedly
common parts actually have different code paths for different distros.

Also be realistic about which distros we support.

Change-Id: Ifcc19a20d42f384300cadf442951739be8682047
This commit is contained in:
Dmitry Tantsur 2023-07-14 11:37:22 +02:00
parent 54da324900
commit f4be664a86
7 changed files with 53 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/install/include/configure-ironic-api.inc
View File

@ -120,10 +120,10 @@ Configuring ironic-api service
#. Restart the ironic-api service: #. Restart the ironic-api service:
Fedora/RHEL8/CentOS8/SUSE:: RHEL/CentOS/SUSE::
sudo systemctl restart openstack-ironic-api sudo systemctl restart openstack-ironic-api
Ubuntu:: Ubuntu/Debian::
sudo service ironic-api restart sudo service ironic-api restart

4
doc/source/install/include/configure-ironic-conductor.inc
View File

@ -212,11 +212,11 @@ Configuring ironic-conductor service
#. Restart the ironic-conductor service: #. Restart the ironic-conductor service:
Fedora/RHEL7/CentOS7/SUSE:: RHEL/CentOS/SUSE::
sudo systemctl restart openstack-ironic-conductor sudo systemctl restart openstack-ironic-conductor
Ubuntu:: Ubuntu/Debian::
sudo service ironic-conductor restart sudo service ironic-conductor restart

8
doc/source/install/include/configure-ironic-singleprocess.inc
View File

@ -27,22 +27,22 @@ resources and low number of nodes to handle.
#. Stop existing services if they are already started: #. Stop existing services if they are already started:
Fedora/RHEL/CentOS/SUSE:: RHEL/CentOS/SUSE::
sudo systemctl stop openstack-ironic-api sudo systemctl stop openstack-ironic-api
sudo systemctl stop openstack-ironic-conductor sudo systemctl stop openstack-ironic-conductor
Ubuntu:: Ubuntu/Debian::
sudo service ironic-api stop sudo service ironic-api stop
sudo service ironic-conductor stop sudo service ironic-conductor stop
#. Start or restart the ironic service: #. Start or restart the ironic service:
Fedora/RHEL8/CentOS8/SUSE:: RHEL/CentOS/SUSE::
sudo systemctl restart openstack-ironic sudo systemctl restart openstack-ironic
Ubuntu:: Ubuntu/Debian::
sudo service ironic restart sudo service ironic restart

38
doc/source/install/install-obs.rst
View File

@ -1,41 +1,5 @@
.. _install-obs:
============================================================ ============================================================
Install and configure for openSUSE and SUSE Linux Enterprise Install and configure for openSUSE and SUSE Linux Enterprise
============================================================ ============================================================
This section describes how to install and configure the Bare Metal service The contents has been migrated to the common location - see :doc:`install`.
for openSUSE Leap 42.2 and SUSE Linux Enterprise Server 12 SP2.
.. note::
Installation of the Bare Metal service on openSUSE and SUSE Linux Enterprise
Server is not officially supported. Nevertheless, installation should be
possible.
.. include:: include/common-prerequisites.inc
Install and configure components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Install from packages
.. code-block:: console
# zypper install openstack-ironic-api openstack-ironic-conductor python3-ironicclient
#. Enable services
.. code-block:: console
# systemctl enable openstack-ironic-api openstack-ironic-conductor
# systemctl start openstack-ironic-api openstack-ironic-conductor
.. 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-singleprocess.inc

34
doc/source/install/install-rdo.rst
View File

@ -1,37 +1,5 @@
.. _install-rdo:
============================================================= =============================================================
Install and configure for Red Hat Enterprise Linux and CentOS Install and configure for Red Hat Enterprise Linux and CentOS
============================================================= =============================================================
The contents has been migrated to the common location - see :doc:`install`.
This section describes how to install and configure the Bare Metal service
for Red Hat Enterprise Linux 8 and CentOS 8.
.. include:: include/common-prerequisites.inc
Install and configure components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Install from packages (using dnf)
.. code-block:: console
# dnf install openstack-ironic-api openstack-ironic-conductor python3-ironicclient
#. Enable services
.. code-block:: console
# systemctl enable openstack-ironic-api openstack-ironic-conductor
# systemctl start openstack-ironic-api openstack-ironic-conductor
.. 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-singleprocess.inc

30
doc/source/install/install-ubuntu.rst
View File

@ -1,33 +1,5 @@
.. _install-ubuntu:
================================ ================================
Install and configure for Ubuntu Install and configure for Ubuntu
================================ ================================
This section describes how to install and configure the Bare Metal The contents has been migrated to the common location - see :doc:`install`.
service for Ubuntu 14.04 (LTS).
.. include:: include/common-prerequisites.inc
Install and configure components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Install from packages (using apt-get)
.. code-block:: console
# apt-get install ironic-api ironic-conductor python3-ironicclient
#. Enable services
Services are enabled by default on Ubuntu.
.. 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-singleprocess.inc

46
doc/source/install/install.rst
View File

@ -1,3 +1,4 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install and configure the Bare Metal service Install and configure the Bare Metal service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -26,12 +27,49 @@ More installation projects are developed by other OpenStack teams:
**Ironic guide**, not to the generic page. If a separate Ironic guide does **Ironic guide**, not to the generic page. If a separate Ironic guide does
not exist yet, create it first. not exist yet, create it first.
Contents
--------
.. toctree:: .. toctree::
:maxdepth: 2 :hidden:
install-rdo.rst install-rdo.rst
install-ubuntu.rst install-ubuntu.rst
install-obs.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 python3-ironicclient
.. _rdo: https://www.rdoproject.org/
On Ubuntu_/Debian:
.. code-block:: console
# apt-get install ironic-api ironic-conductor 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 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-singleprocess.inc