From 009fd0f35bcb88acc80f12e69d5fb72c0ee5391f Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Tue, 16 Apr 2019 10:49:01 +0100 Subject: [PATCH] docs: Remove references to nova-consoleauth We're going to remove all the code, but first, remove the docs. Part of blueprint remove-consoleauth Change-Id: Ie96e18ea7762b93b4116b35d7ebcfcbe53c55527 Signed-off-by: Stephen Finucane --- api-guide/source/general_info.rst | 4 -- doc/source/_extra/.htaccess | 1 - ...w-usage-statistics-for-hosts-instances.rst | 1 - doc/source/admin/configuration/logs.rst | 3 -- doc/source/admin/live-migration-usage.rst | 5 +- doc/source/admin/remote-console-access.rst | 37 ++----------- doc/source/admin/services.rst | 46 +++++----------- doc/source/admin/system-admin.rst | 9 ---- doc/source/cli/index.rst | 1 - doc/source/cli/nova-consoleauth.rst | 54 ------------------- doc/source/cli/nova-status.rst | 2 + doc/source/conf.py | 1 - doc/source/install/controller-install-obs.rst | 34 ++++++------ doc/source/install/controller-install-rdo.rst | 23 ++++---- .../install/controller-install-ubuntu.rst | 13 +---- doc/source/install/get-started-compute.rst | 13 ----- doc/source/user/cellsv2-layout.rst | 11 ---- doc/test/redirect-tests.txt | 1 - 18 files changed, 50 insertions(+), 209 deletions(-) delete mode 100644 doc/source/cli/nova-consoleauth.rst diff --git a/api-guide/source/general_info.rst b/api-guide/source/general_info.rst index 873c81cd7306..52df65aebcd6 100644 --- a/api-guide/source/general_info.rst +++ b/api-guide/source/general_info.rst @@ -176,10 +176,6 @@ on compute hosts rather than servers. This service handles networking of virtual servers. It is no longer under active development, and is being replaced by Neutron. - - **nova-consoleauth (deprecated)** - - This service provides authorization for compute instances consoles. - - **Services Actions** .. note:: diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess index baba1e3b43fc..88c2a0891b9b 100644 --- a/doc/source/_extra/.htaccess +++ b/doc/source/_extra/.htaccess @@ -39,7 +39,6 @@ redirectmatch 301 ^/nova/([^/]+)/man/nova-cells.html$ /nova/$1/cli/nova-cells.ht redirectmatch 301 ^/nova/([^/]+)/man/nova-compute.html$ /nova/$1/cli/nova-compute.html redirectmatch 301 ^/nova/([^/]+)/man/nova-conductor.html$ /nova/$1/cli/nova-conductor.html redirectmatch 301 ^/nova/([^/]+)/man/nova-console.html$ /nova/$1/cli/nova-console.html -redirectmatch 301 ^/nova/([^/]+)/man/nova-consoleauth.html$ /nova/$1/cli/nova-consoleauth.html redirectmatch 301 ^/nova/([^/]+)/man/nova-dhcpbridge.html$ /nova/$1/cli/nova-dhcpbridge.html redirectmatch 301 ^/nova/([^/]+)/man/nova-manage.html$ /nova/$1/cli/nova-manage.html redirectmatch 301 ^/nova/([^/]+)/man/nova-network.html$ /nova/$1/cli/nova-network.html diff --git a/doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst b/doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst index cab607bbdb31..90716d5347ef 100644 --- a/doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst +++ b/doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst @@ -30,7 +30,6 @@ The following examples show the host usage statistics for a host called | devstack | compute | nova | | devstack | network | internal | | devstack | scheduler | internal | - | devstack | consoleauth | internal | +-----------+-------------+----------+ * Get a summary of resource usage of all of the instances running on the host: diff --git a/doc/source/admin/configuration/logs.rst b/doc/source/admin/configuration/logs.rst index 74d3919fcc48..53ad09f7ddc9 100644 --- a/doc/source/admin/configuration/logs.rst +++ b/doc/source/admin/configuration/logs.rst @@ -22,9 +22,6 @@ The corresponding log file of each Compute service is stored in the * - ``nova-conductor.log`` - ``openstack-nova-conductor`` - ``nova-conductor`` - * - ``nova-consoleauth.log`` - - ``openstack-nova-consoleauth`` - - ``nova-consoleauth`` * - ``nova-network.log`` [#a]_ - ``openstack-nova-network`` - ``nova-network`` diff --git a/doc/source/admin/live-migration-usage.rst b/doc/source/admin/live-migration-usage.rst index e1ebdb696e45..783ab5e27c2f 100644 --- a/doc/source/admin/live-migration-usage.rst +++ b/doc/source/admin/live-migration-usage.rst @@ -67,9 +67,8 @@ Manual selection of the destination host +----+------------------+-------+----------+---------+-------+----------------------------+ | 3 | nova-conductor | HostA | internal | enabled | up | 2017-02-18T09:42:29.000000 | | 4 | nova-scheduler | HostA | internal | enabled | up | 2017-02-18T09:42:26.000000 | - | 5 | nova-consoleauth | HostA | internal | enabled | up | 2017-02-18T09:42:29.000000 | - | 6 | nova-compute | HostB | nova | enabled | up | 2017-02-18T09:42:29.000000 | - | 7 | nova-compute | HostC | nova | enabled | up | 2017-02-18T09:42:29.000000 | + | 5 | nova-compute | HostB | nova | enabled | up | 2017-02-18T09:42:29.000000 | + | 6 | nova-compute | HostC | nova | enabled | up | 2017-02-18T09:42:29.000000 | +----+------------------+-------+----------+---------+-------+----------------------------+ #. Check that ``HostC`` has enough resources for migration: diff --git a/doc/source/admin/remote-console-access.rst b/doc/source/admin/remote-console-access.rst index b44050c900c7..18e52f3a2a36 100644 --- a/doc/source/admin/remote-console-access.rst +++ b/doc/source/admin/remote-console-access.rst @@ -58,12 +58,6 @@ following components: - One or more :program:`nova-compute` services. Hosts the instances for which consoles are provided. -.. note:: - - Previously, the :program:`nova-consoleauth` application was necessary for - token authorization. This is no longer the case since nova 18.0.0 - (Rocky). See :ref:`below ` for more information. - .. todo:: The below diagram references :program:`nova-consoleauth` and needs to be @@ -595,23 +589,10 @@ address of the controller or the VIP. About ``nova-consoleauth`` -------------------------- -The deprecated :doc:`/cli/nova-consoleauth` service provides a shared service -to manage token authentication that the client proxies outlined below can -leverage. This service must be running for either proxy to work. Many proxies -of either type can be run against a single :program:`nova-consoleauth` service -in a cluster configuration. - -.. important:: - - Do not confuse the :program:`nova-consoleauth` shared service with - :doc:`/cli/nova-console` service, 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. See - :oslo.config:option:`workarounds.enable_consoleauth` for details. +The now-removed :program:`nova-consoleauth` service was previously used to +provide a shared service to manage token authentication that the client proxies +outlined below could leverage. Token authentication was moved to the database in +18.0.0 (Rocky) and the service was removed in 20.0.0 (Train). Frequently Asked Questions @@ -627,15 +608,7 @@ Frequently Asked Questions - **Q: I want VNC support in the OpenStack dashboard. What services do I need?** - A: You need ``nova-novncproxy``, ``nova-consoleauth``, and correctly - configured compute hosts. - -- **Q: When I use ``nova get-vnc-console`` or click on the VNC tab of the - OpenStack dashboard, it hangs. Why?** - - A: Make sure you are running ``nova-consoleauth`` (in addition to - ``nova-novncproxy``). The proxies rely on ``nova-consoleauth`` to validate - tokens, and waits for a reply from them until a timeout is reached. + A: You need ``nova-novncproxy`` and correctly configured compute hosts. - **Q: My VNC proxy worked fine during my all-in-one test, but now it doesn't work on multi host. Why?** diff --git a/doc/source/admin/services.rst b/doc/source/admin/services.rst index 74ee25273f10..a3f59e1fdfbf 100644 --- a/doc/source/admin/services.rst +++ b/doc/source/admin/services.rst @@ -10,22 +10,13 @@ enable the ``nova-compute`` service. .. code-block:: console $ openstack compute service list - +----+--------------+------------+----------+---------+-------+--------------+ - | ID | Binary | Host | Zone | Status | State | Updated At | - +----+--------------+------------+----------+---------+-------+--------------+ - | 4 | nova- | controller | internal | enabled | up | 2016-12-20T0 | - | | consoleauth | | | | | 0:44:48.0000 | - | | | | | | | 00 | - | 5 | nova- | controller | internal | enabled | up | 2016-12-20T0 | - | | scheduler | | | | | 0:44:48.0000 | - | | | | | | | 00 | - | 6 | nova- | controller | internal | enabled | up | 2016-12-20T0 | - | | conductor | | | | | 0:44:54.0000 | - | | | | | | | 00 | - | 9 | nova-compute | compute | nova | enabled | up | 2016-10-21T0 | - | | | | | | | 2:35:03.0000 | - | | | | | | | 00 | - +----+--------------+------------+----------+---------+-------+--------------+ + +----+----------------+------------+----------+---------+-------+----------------------------+ + | ID | Binary | Host | Zone | Status | State | Updated At | + +----+----------------+------------+----------+---------+-------+----------------------------+ + | 4 | nova-scheduler | controller | internal | enabled | up | 2016-12-20T00:44:48.000000 | + | 5 | nova-conductor | controller | internal | enabled | up | 2016-12-20T00:44:54.000000 | + | 8 | nova-compute | compute | nova | enabled | up | 2016-10-21T02:35:03.000000 | + +----+----------------+------------+----------+---------+-------+----------------------------+ #. Disable a nova service: @@ -43,22 +34,13 @@ enable the ``nova-compute`` service. .. code-block:: console $ openstack compute service list - +----+--------------+------------+----------+---------+-------+--------------+ - | ID | Binary | Host | Zone | Status | State | Updated At | - +----+--------------+------------+----------+---------+-------+--------------+ - | 4 | nova- | controller | internal | enabled | up | 2016-12-20T0 | - | | consoleauth | | | | | 0:44:48.0000 | - | | | | | | | 00 | - | 5 | nova- | controller | internal | enabled | up | 2016-12-20T0 | - | | scheduler | | | | | 0:44:48.0000 | - | | | | | | | 00 | - | 6 | nova- | controller | internal | enabled | up | 2016-12-20T0 | - | | conductor | | | | | 0:44:54.0000 | - | | | | | | | 00 | - | 9 | nova-compute | compute | nova | disabled| up | 2016-10-21T0 | - | | | | | | | 2:35:03.0000 | - | | | | | | | 00 | - +----+--------------+------------+----------+---------+-------+--------------+ + +----+----------------+------------+----------+---------+-------+----------------------------+ + | ID | Binary | Host | Zone | Status | State | Updated At | + +----+----------------+------------+----------+---------+-------+----------------------------+ + | 5 | nova-scheduler | controller | internal | enabled | up | 2016-12-20T00:44:48.000000 | + | 6 | nova-conductor | controller | internal | enabled | up | 2016-12-20T00:44:54.000000 | + | 9 | nova-compute | compute | nova | disabled| up | 2016-10-21T02:35:03.000000 | + +----+----------------+------------+----------+---------+-------+----------------------------+ #. Enable the service: diff --git a/doc/source/admin/system-admin.rst b/doc/source/admin/system-admin.rst index 51c6598a88b0..bda5e9b0bf42 100644 --- a/doc/source/admin/system-admin.rst +++ b/doc/source/admin/system-admin.rst @@ -48,15 +48,6 @@ responsibilities of services and drivers are: Provides database-access support for compute nodes (thereby reducing security risks). -``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. 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 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 40be4005dbac..7aae96aae501 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -87,6 +87,5 @@ deployments, but are documented for existing ones. nova-dhcpbridge nova-network - nova-consoleauth nova-console nova-xvpvncproxy diff --git a/doc/source/cli/nova-consoleauth.rst b/doc/source/cli/nova-consoleauth.rst deleted file mode 100644 index fa2a849a703f..000000000000 --- a/doc/source/cli/nova-consoleauth.rst +++ /dev/null @@ -1,54 +0,0 @@ -================ -nova-consoleauth -================ - ----------------------------------- -Nova Console Authentication Server ----------------------------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing - -Synopsis -======== - -:: - - nova-consoleauth [options] - -Description -=========== - -:program:`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. See - :oslo.config:option:`workarounds.enable_consoleauth` for details. - -Options -======= - -**General options** - -Files -===== - -* ``/etc/nova/nova.conf`` -* ``/etc/nova/policy.json`` -* ``/etc/nova/rootwrap.conf`` -* ``/etc/nova/rootwrap.d/`` - -See Also -======== - -* :nova-doc:`OpenStack Nova <>` - -Bugs -==== - -* Nova bugs are managed at `Launchpad `__ diff --git a/doc/source/cli/nova-status.rst b/doc/source/cli/nova-status.rst index b3c3b31b87a6..c63b5bc3b984 100644 --- a/doc/source/cli/nova-status.rst +++ b/doc/source/cli/nova-status.rst @@ -136,6 +136,8 @@ Upgrade * Checks to ensure block-storage (cinder) API version 3.44 is available in order to support multi-attach volumes. If ``[cinder]/auth_type`` is not configured this is a no-op check. + * The "**nova-consoleauth** service" upgrade check was removed since the + service was removed in Train. See Also ======== diff --git a/doc/source/conf.py b/doc/source/conf.py index cd298a1c5b24..43879c7ae064 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -86,7 +86,6 @@ _man_pages = [ ('nova-api', u'Cloud controller fabric'), ('nova-compute', u'Cloud controller fabric'), ('nova-console', u'Cloud controller fabric'), - ('nova-consoleauth', u'Cloud controller fabric'), ('nova-dhcpbridge', u'Cloud controller fabric'), ('nova-manage', u'Cloud controller fabric'), ('nova-network', u'Cloud controller fabric'), diff --git a/doc/source/install/controller-install-obs.rst b/doc/source/install/controller-install-obs.rst index 6ffe94cdefeb..8079b22805dd 100644 --- a/doc/source/install/controller-install-obs.rst +++ b/doc/source/install/controller-install-obs.rst @@ -174,18 +174,14 @@ 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-consoleauth \ - openstack-nova-novncproxy iptables + # zypper install \ + openstack-nova-api \ + openstack-nova-scheduler \ + openstack-nova-conductor \ + openstack-nova-novncproxy \ + iptables #. Edit the ``/etc/nova/nova.conf`` file and complete the following actions: @@ -390,11 +386,13 @@ 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 - # systemctl start openstack-nova-api.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. + # systemctl enable \ + openstack-nova-api.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 diff --git a/doc/source/install/controller-install-rdo.rst b/doc/source/install/controller-install-rdo.rst index 86fad133ba85..369988661949 100644 --- a/doc/source/install/controller-install-rdo.rst +++ b/doc/source/install/controller-install-rdo.rst @@ -370,18 +370,15 @@ 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-consoleauth openstack-nova-scheduler.service \ - openstack-nova-conductor.service openstack-nova-novncproxy.service - # systemctl start openstack-nova-api.service \ - openstack-nova-consoleauth openstack-nova-scheduler.service \ - openstack-nova-conductor.service openstack-nova-novncproxy.service + # systemctl enable \ + openstack-nova-api.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 diff --git a/doc/source/install/controller-install-ubuntu.rst b/doc/source/install/controller-install-ubuntu.rst index c4052dfe1861..a44295a73c54 100644 --- a/doc/source/install/controller-install-ubuntu.rst +++ b/doc/source/install/controller-install-ubuntu.rst @@ -166,17 +166,9 @@ 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-consoleauth \ - nova-novncproxy nova-scheduler + # apt install nova-api nova-conductor nova-novncproxy nova-scheduler #. Edit the ``/etc/nova/nova.conf`` file and complete the following actions: @@ -375,9 +367,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 - - 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 30dfa473c6fc..cb93ce9f4aef 100644 --- a/doc/source/install/get-started-compute.rst +++ b/doc/source/install/get-started-compute.rst @@ -55,19 +55,6 @@ OpenStack Compute consists of the following areas and their components: For more information, see the ``conductor`` section in the :doc:`/configuration/config`. -``nova-consoleauth`` daemon - Authorizes tokens for users that console proxies provide. See - ``nova-novncproxy`` and ``nova-xvpvncproxy``. This service must be running - for console proxies to work. You can run proxies of either type against a - 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. See - :oslo.config:option:`workarounds.enable_consoleauth` for details. - ``nova-novncproxy`` daemon Provides a proxy for accessing running instances through a VNC connection. Supports browser-based novnc clients. diff --git a/doc/source/user/cellsv2-layout.rst b/doc/source/user/cellsv2-layout.rst index 22a633b65794..cb32c3fc988a 100644 --- a/doc/source/user/cellsv2-layout.rst +++ b/doc/source/user/cellsv2-layout.rst @@ -319,17 +319,6 @@ case (e.g. must be run via the nova-api-metadata script). .. _Neutron metadata-agent: https://docs.openstack.org/neutron/latest/configuration/metadata-agent.html?#DEFAULT.nova_metadata_host -Consoleauth service and console proxies -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -`As of Rocky`__, the ``nova-consoleauth`` service has been deprecated and cell -databases are used for storing token authorizations. All new consoles will be -supported by the database backend and existing consoles will be reset. Console -proxies must be run per cell because the new console token authorizations are -stored in cell databases. - -.. __: https://specs.openstack.org/openstack/nova-specs/specs/rocky/approved/convert-consoles-to-objects.html - Operations Requiring upcalls ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/test/redirect-tests.txt b/doc/test/redirect-tests.txt index 780df9ffc874..7d94c7af9828 100644 --- a/doc/test/redirect-tests.txt +++ b/doc/test/redirect-tests.txt @@ -32,7 +32,6 @@ /nova/latest/man/nova-compute.html 301 /nova/latest/cli/nova-compute.html /nova/latest/man/nova-conductor.html 301 /nova/latest/cli/nova-conductor.html /nova/latest/man/nova-console.html 301 /nova/latest/cli/nova-console.html -/nova/latest/man/nova-consoleauth.html 301 /nova/latest/cli/nova-consoleauth.html /nova/latest/man/nova-dhcpbridge.html 301 /nova/latest/cli/nova-dhcpbridge.html /nova/latest/man/nova-manage.html 301 /nova/latest/cli/nova-manage.html /nova/latest/man/nova-network.html 301 /nova/latest/cli/nova-network.html