Skip to content

Commit

Permalink
docs: Remove references to nova-consoleauth
Browse files Browse the repository at this point in the history 
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 <sfinucan@redhat.com>
  • Loading branch information
@stephenfin
stephenfin committed Jun 17, 2019
1 parent c27809d commit 009fd0f
Show file tree
Hide file tree
Showing 18 changed files with 50 additions and 209 deletions.
4 changes: 0 additions & 4 deletions api-guide/source/general_info.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
1 change: 0 additions & 1 deletion doc/source/_extra/.htaccess
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 0 additions & 3 deletions doc/source/admin/configuration/logs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
5 changes: 2 additions & 3 deletions doc/source/admin/live-migration-usage.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
37 changes: 5 additions & 32 deletions doc/source/admin/remote-console-access.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <about-nova-consoleauth>` for more information.

.. todo::

The below diagram references :program:`nova-consoleauth` and needs to be
Expand Down Expand Up @@ -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
Expand All @@ -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?**
Expand Down
46 changes: 14 additions & 32 deletions doc/source/admin/services.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:

Expand Down
9 changes: 0 additions & 9 deletions doc/source/admin/system-admin.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion doc/source/cli/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,5 @@ deployments, but are documented for existing ones.

nova-dhcpbridge
nova-network
nova-consoleauth
nova-console
nova-xvpvncproxy
54 changes: 0 additions & 54 deletions doc/source/cli/nova-consoleauth.rst
View file

This file was deleted.

2 changes: 2 additions & 0 deletions doc/source/cli/nova-status.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
========
Expand Down
1 change: 0 additions & 1 deletion doc/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@
('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'),
Expand Down
34 changes: 16 additions & 18 deletions doc/source/install/controller-install-obs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
23 changes: 10 additions & 13 deletions doc/source/install/controller-install-rdo.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
13 changes: 1 addition & 12 deletions doc/source/install/controller-install-ubuntu.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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.
13 changes: 0 additions & 13 deletions doc/source/install/get-started-compute.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading

0 comments on commit 009fd0f

Please sign in to comment.