From e91dad3ee93b1c0c4201e1e679a8c5b333879b5f Mon Sep 17 00:00:00 2001 From: melanie witt Date: Mon, 30 Apr 2018 23:57:38 +0000 Subject: [PATCH] Deprecate the nova-consoleauth service Part of blueprint convert-consoles-to-objects Change-Id: I9bfa89d2d8fe2b5803b4e1478377e13dc3231b1c --- api-guide/source/general_info.rst | 2 +- doc/source/admin/remote-console-access.rst | 5 +++++ doc/source/admin/system-admin.rst | 5 +++++ doc/source/cli/index.rst | 2 +- doc/source/cli/nova-consoleauth.rst | 5 +++++ doc/source/install/controller-install-obs.rst | 13 ++++++------- doc/source/install/controller-install-rdo.rst | 8 ++++---- doc/source/install/controller-install-ubuntu.rst | 5 ++--- doc/source/install/get-started-compute.rst | 5 +++++ nova/cmd/consoleauth.py | 5 +++++ ...deprecate-nova-consoleauth-ed6ccbc324a0fb10.yaml | 6 ++++++ 11 files changed, 45 insertions(+), 16 deletions(-) create mode 100644 releasenotes/notes/deprecate-nova-consoleauth-ed6ccbc324a0fb10.yaml diff --git a/api-guide/source/general_info.rst b/api-guide/source/general_info.rst index 711f3c6f7494..909b08bf541f 100644 --- a/api-guide/source/general_info.rst +++ b/api-guide/source/general_info.rst @@ -178,7 +178,7 @@ on compute hosts rather than servers. This service provides AWS EC2 API compatibility. - - **nova-consoleauth** + - **nova-consoleauth (deprecated)** This service provides authorization for compute instances consoles. diff --git a/doc/source/admin/remote-console-access.rst b/doc/source/admin/remote-console-access.rst index 584e927b2de7..f5a2f01556b5 100644 --- a/doc/source/admin/remote-console-access.rst +++ b/doc/source/admin/remote-console-access.rst @@ -20,6 +20,11 @@ Do not confuse the ``nova-consoleauth`` shared service with ``nova-console``, which is a XenAPI-specific service that most recent VNC proxy architectures do not use. +.. deprecated:: 18.0.0 + + ``nova-consoleauth`` is deprecated since 18.0.0 (Rocky) and will be removed + in an upcoming release. + SPICE console ------------- diff --git a/doc/source/admin/system-admin.rst b/doc/source/admin/system-admin.rst index eca39a625844..e8b86af5f9dc 100644 --- a/doc/source/admin/system-admin.rst +++ b/doc/source/admin/system-admin.rst @@ -54,6 +54,11 @@ responsibilities of services and drivers are: ``nova-consoleauth`` Manages console authentication. + .. deprecated:: 18.0.0 + + ``nova-consoleauth`` is deprecated since 18.0.0 (Rocky) and will be removed + in an upcoming release. + ``nova-objectstore`` A simple file-based storage system for images that replicates most of the S3 API. It can be replaced with OpenStack Image service and either a simple diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index adddfa9e4ba4..bf2d164d9be5 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -47,7 +47,6 @@ daemonize correctly after starting up. nova-compute nova-conductor nova-console - nova-consoleauth nova-novncproxy nova-scheduler nova-serialproxy @@ -91,3 +90,4 @@ deployments, but are documented for existing ones. nova-cells nova-dhcpbridge nova-network + nova-consoleauth diff --git a/doc/source/cli/nova-consoleauth.rst b/doc/source/cli/nova-consoleauth.rst index fffe8723ceb3..de31915578d7 100644 --- a/doc/source/cli/nova-consoleauth.rst +++ b/doc/source/cli/nova-consoleauth.rst @@ -24,6 +24,11 @@ Description `nova-consoleauth` is a server daemon that serves the Nova Console 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. + Options ======= diff --git a/doc/source/install/controller-install-obs.rst b/doc/source/install/controller-install-obs.rst index cd70061e0bb1..f3f82e9a9356 100644 --- a/doc/source/install/controller-install-obs.rst +++ b/doc/source/install/controller-install-obs.rst @@ -278,9 +278,8 @@ Install and configure components .. code-block:: console # zypper install openstack-nova-api openstack-nova-scheduler \ - openstack-nova-conductor openstack-nova-consoleauth \ - openstack-nova-novncproxy openstack-nova-placement-api \ - iptables + openstack-nova-conductor openstack-nova-novncproxy \ + openstack-nova-placement-api iptables #. Edit the ``/etc/nova/nova.conf`` file and complete the following actions: @@ -492,8 +491,8 @@ Finalize installation .. code-block:: console # systemctl enable openstack-nova-api.service \ - openstack-nova-consoleauth.service openstack-nova-scheduler.service \ - openstack-nova-conductor.service openstack-nova-novncproxy.service + openstack-nova-scheduler.service openstack-nova-conductor.service \ + openstack-nova-novncproxy.service # systemctl start openstack-nova-api.service \ - openstack-nova-consoleauth.service openstack-nova-scheduler.service \ - openstack-nova-conductor.service openstack-nova-novncproxy.service + openstack-nova-scheduler.service openstack-nova-conductor.service \ + openstack-nova-novncproxy.service diff --git a/doc/source/install/controller-install-rdo.rst b/doc/source/install/controller-install-rdo.rst index 92174761ae34..fb5b1b2e36e4 100644 --- a/doc/source/install/controller-install-rdo.rst +++ b/doc/source/install/controller-install-rdo.rst @@ -498,8 +498,8 @@ Finalize installation .. code-block:: console # systemctl enable openstack-nova-api.service \ - openstack-nova-consoleauth.service openstack-nova-scheduler.service \ - openstack-nova-conductor.service openstack-nova-novncproxy.service + openstack-nova-scheduler.service openstack-nova-conductor.service \ + openstack-nova-novncproxy.service # systemctl start openstack-nova-api.service \ - openstack-nova-consoleauth.service openstack-nova-scheduler.service \ - openstack-nova-conductor.service openstack-nova-novncproxy.service + 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 3d6b1b04a38b..49300a21a3eb 100644 --- a/doc/source/install/controller-install-ubuntu.rst +++ b/doc/source/install/controller-install-ubuntu.rst @@ -269,8 +269,8 @@ Install and configure components .. code-block:: console - # apt install nova-api nova-conductor nova-consoleauth \ - nova-novncproxy nova-scheduler nova-placement-api + # apt install nova-api nova-conductor nova-novncproxy nova-scheduler \ + nova-placement-api #. Edit the ``/etc/nova/nova.conf`` file and complete the following actions: @@ -467,7 +467,6 @@ 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 diff --git a/doc/source/install/get-started-compute.rst b/doc/source/install/get-started-compute.rst index 27dc733be94d..2a332367362b 100644 --- a/doc/source/install/get-started-compute.rst +++ b/doc/source/install/get-started-compute.rst @@ -65,6 +65,11 @@ OpenStack Compute consists of the following areas and their components: single nova-consoleauth service in a cluster configuration. For information, see :ref:`about-nova-consoleauth`. + .. deprecated:: 18.0.0 + + ``nova-consoleauth`` is deprecated since 18.0.0 (Rocky) and will be removed + in an upcoming release. + ``nova-novncproxy`` daemon Provides a proxy for accessing running instances through a VNC connection. Supports browser-based novnc clients. diff --git a/nova/cmd/consoleauth.py b/nova/cmd/consoleauth.py index 4f392ce31714..e28d56a10b05 100644 --- a/nova/cmd/consoleauth.py +++ b/nova/cmd/consoleauth.py @@ -29,6 +29,7 @@ from nova import service from nova import version CONF = nova.conf.CONF +LOG = logging.getLogger('nova.consoleauth') def main(): @@ -39,6 +40,10 @@ def main(): gmr.TextGuruMeditation.setup_autorun(version, conf=CONF) + LOG.warning('The nova-consoleauth service is deprecated as console token ' + 'authorization storage has moved from the nova-consoleauth ' + 'service backend to the database backend.') + server = service.Service.create(binary='nova-consoleauth', topic=rpcapi.RPC_TOPIC) service.serve(server) diff --git a/releasenotes/notes/deprecate-nova-consoleauth-ed6ccbc324a0fb10.yaml b/releasenotes/notes/deprecate-nova-consoleauth-ed6ccbc324a0fb10.yaml new file mode 100644 index 000000000000..803d2db380bf --- /dev/null +++ b/releasenotes/notes/deprecate-nova-consoleauth-ed6ccbc324a0fb10.yaml @@ -0,0 +1,6 @@ +--- +deprecations: + - | + The ``nova-consoleauth`` service is deprecated as console token + authorization storage has moved from the ``nova-consoleauth`` service + backend to the database backend.