From 983e6ea5518dee956d8054cd67dddbe98eab9f78 Mon Sep 17 00:00:00 2001 From: melanie witt Date: Tue, 25 Sep 2018 17:12:16 +0000 Subject: [PATCH] Restore nova-consoleauth to install docs The installation of the nova-consoleauth service was erroneously removed from the docs prematurely. The nova-consoleauth service is still being used in Rocky, with the removal being possible in Stein. This should have been fixed as part of change Ibbdc7c50c312da2acc59dfe64de95a519f87f123 but was missed. This is also related to the release note update in Rocky under change Ie637b4871df8b870193b5bc07eece15c03860c06. Co-Authored-By: Matt Riedemann Closes-Bug: #1793255 Related-Bug: #1798188 Change-Id: Ied268da9e70bd2807c2dfe7a479181fbec52979d --- doc/source/admin/remote-console-access.rst | 3 ++- doc/source/admin/system-admin.rst | 3 ++- doc/source/cli/nova-consoleauth.rst | 3 ++- doc/source/install/controller-install-obs.rst | 21 +++++++++++++------ doc/source/install/controller-install-rdo.rst | 15 +++++++++---- .../install/controller-install-ubuntu.rst | 14 +++++++++++-- doc/source/install/get-started-compute.rst | 3 ++- 7 files changed, 46 insertions(+), 16 deletions(-) diff --git a/doc/source/admin/remote-console-access.rst b/doc/source/admin/remote-console-access.rst index f8bb448ab256..d0f242fe5643 100644 --- a/doc/source/admin/remote-console-access.rst +++ b/doc/source/admin/remote-console-access.rst @@ -89,7 +89,8 @@ configuration. .. deprecated:: 18.0.0 ``nova-consoleauth`` is deprecated since 18.0.0 (Rocky) and will be removed - in an upcoming release. + in an upcoming release. See + :oslo.config:option:`workarounds.enable_consoleauth` for details. noVNC-based VNC console diff --git a/doc/source/admin/system-admin.rst b/doc/source/admin/system-admin.rst index 9dee99296ddb..51c6598a88b0 100644 --- a/doc/source/admin/system-admin.rst +++ b/doc/source/admin/system-admin.rst @@ -54,7 +54,8 @@ responsibilities of services and drivers are: .. deprecated:: 18.0.0 ``nova-consoleauth`` is deprecated since 18.0.0 (Rocky) and will be removed - in an upcoming release. + in an upcoming release. See + :oslo.config:option:`workarounds.enable_consoleauth` for details. ``nova-objectstore`` A simple file-based storage system for images that replicates most of the S3 diff --git a/doc/source/cli/nova-consoleauth.rst b/doc/source/cli/nova-consoleauth.rst index 32e037ae59a1..fa2a849a703f 100644 --- a/doc/source/cli/nova-consoleauth.rst +++ b/doc/source/cli/nova-consoleauth.rst @@ -27,7 +27,8 @@ Auth service, which provides authentication for Nova consoles. .. deprecated:: 18.0.0 `nova-consoleauth` is deprecated since 18.0.0 (Rocky) and will be removed in - an upcoming release. + an upcoming release. See + :oslo.config:option:`workarounds.enable_consoleauth` for details. Options ======= diff --git a/doc/source/install/controller-install-obs.rst b/doc/source/install/controller-install-obs.rst index f65942a81ea6..9104530c30d6 100644 --- a/doc/source/install/controller-install-obs.rst +++ b/doc/source/install/controller-install-obs.rst @@ -282,11 +282,18 @@ Install and configure components #. Install the packages: + .. note:: ``nova-consoleauth`` is deprecated since 18.0.0 (Rocky) and will + be removed in an upcoming release. Console proxies should be + deployed per cell. If performing a fresh install (not an upgrade), + then you likely do not need to install the ``nova-consoleauth`` + service. See + :oslo.config:option:`workarounds.enable_consoleauth` for details. + .. code-block:: console # zypper install openstack-nova-api openstack-nova-scheduler \ - openstack-nova-conductor openstack-nova-novncproxy \ - openstack-nova-placement-api iptables + openstack-nova-conductor openstack-nova-consoleauth \ + openstack-nova-novncproxy openstack-nova-placement-api iptables #. Edit the ``/etc/nova/nova.conf`` file and complete the following actions: @@ -502,8 +509,10 @@ Finalize installation .. code-block:: console # systemctl enable openstack-nova-api.service \ - openstack-nova-scheduler.service openstack-nova-conductor.service \ - openstack-nova-novncproxy.service + openstack-nova-consoleauth.service openstack-nova-scheduler.service \ + openstack-nova-conductor.service openstack-nova-novncproxy.service # systemctl start openstack-nova-api.service \ - openstack-nova-scheduler.service openstack-nova-conductor.service \ - openstack-nova-novncproxy.service + openstack-nova-consoleauth openstack-nova-scheduler.service \ + openstack-nova-conductor.service openstack-nova-novncproxy.service + + Note again that the ``nova-consoleauth`` service may not be necessary here. diff --git a/doc/source/install/controller-install-rdo.rst b/doc/source/install/controller-install-rdo.rst index 20fd0e60ee59..0c818dec700e 100644 --- a/doc/source/install/controller-install-rdo.rst +++ b/doc/source/install/controller-install-rdo.rst @@ -504,11 +504,18 @@ Finalize installation * Start the Compute services and configure them to start when the system boots: + .. note:: ``nova-consoleauth`` is deprecated since 18.0.0 (Rocky) and will + be removed in an upcoming release. Console proxies should be + deployed per cell. If performing a fresh install (not an upgrade), + then you likely do not need to install the ``nova-consoleauth`` + service. See + :oslo.config:option:`workarounds.enable_consoleauth` for details. + .. code-block:: console # systemctl enable openstack-nova-api.service \ - openstack-nova-scheduler.service openstack-nova-conductor.service \ - openstack-nova-novncproxy.service + openstack-nova-consoleauth openstack-nova-scheduler.service \ + openstack-nova-conductor.service openstack-nova-novncproxy.service # systemctl start openstack-nova-api.service \ - openstack-nova-scheduler.service openstack-nova-conductor.service \ - openstack-nova-novncproxy.service + openstack-nova-consoleauth openstack-nova-scheduler.service \ + openstack-nova-conductor.service openstack-nova-novncproxy.service diff --git a/doc/source/install/controller-install-ubuntu.rst b/doc/source/install/controller-install-ubuntu.rst index be479ed1e407..001292c5bf43 100644 --- a/doc/source/install/controller-install-ubuntu.rst +++ b/doc/source/install/controller-install-ubuntu.rst @@ -274,10 +274,17 @@ Install and configure components #. Install the packages: + .. note:: ``nova-consoleauth`` is deprecated since 18.0.0 (Rocky) and will + be removed in an upcoming release. Console proxies should be + deployed per cell. If performing a fresh install (not an upgrade), + then you likely do not need to install the ``nova-consoleauth`` + service. See + :oslo.config:option:`workarounds.enable_consoleauth` for details. + .. code-block:: console - # apt install nova-api nova-conductor nova-novncproxy nova-scheduler \ - nova-placement-api + # apt install nova-api nova-conductor nova-consoleauth \ + nova-novncproxy nova-scheduler nova-placement-api #. Edit the ``/etc/nova/nova.conf`` file and complete the following actions: @@ -478,6 +485,9 @@ Finalize installation .. code-block:: console # service nova-api restart + # service nova-consoleauth restart # service nova-scheduler restart # service nova-conductor restart # service nova-novncproxy restart + + Note again that the ``nova-consoleauth`` service may not be necessary here. diff --git a/doc/source/install/get-started-compute.rst b/doc/source/install/get-started-compute.rst index 2a332367362b..79c4327dc7e0 100644 --- a/doc/source/install/get-started-compute.rst +++ b/doc/source/install/get-started-compute.rst @@ -68,7 +68,8 @@ OpenStack Compute consists of the following areas and their components: .. deprecated:: 18.0.0 ``nova-consoleauth`` is deprecated since 18.0.0 (Rocky) and will be removed - in an upcoming release. + in an upcoming release. See + :oslo.config:option:`workarounds.enable_consoleauth` for details. ``nova-novncproxy`` daemon Provides a proxy for accessing running instances through a VNC connection.