openstack
/
nova
Code Issues Proposed changes

HyperV: Remove RDP console API 

RDP console was only for HyperV driver so removing the
API. As API url stay same (because same used for other
console types API), RDP console API will return 400.

Cleaning up the related config options as well as moving its
API ref to obsolete seciton.

Keeping RPC method to avoid error when old controller is used
with new compute. It can be removed in next RPC version bump.

Change-Id: I8f5755009da4af0d12bda096d7a8e85fd41e1a8c
This commit is contained in:
Ghanshyam Mann 2024-02-05 21:45:20 -08:00
parent 3e47439a68
commit 0c1e1ccf03
29 changed files with 127 additions and 577 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api-ref/source/index.rst
View File

@ -90,3 +90,4 @@ Compute API in the past, but no longer exist.
.. include:: os-consoles.inc
.. include:: os-security-group-default-rules.inc
.. include:: os-agents.inc
.. include:: servers-action-rdp-remote-consoles.inc

6
api-ref/source/parameters.yaml
View File

@ -5956,15 +5956,15 @@ remote_console:
remote_console_protocol:
description: |
The protocol of remote console. The valid values are ``vnc``, ``spice``,
``rdp``, ``serial`` and ``mks``. The protocol ``mks`` is added since
Microversion ``2.8``.
``serial`` and ``mks``. The protocol ``mks`` is added since Microversion
``2.8``.
in: body
required: true
type: string
remote_console_type:
description: |
The type of remote console. The valid values are ``novnc``,
``rdp-html5``, ``spice-html5``, ``serial``, and ``webmks``. The type
``spice-html5``, ``serial``, and ``webmks``. The type
``webmks`` is added since Microversion ``2.8``.
in: body
required: true

53
api-ref/source/servers-action-rdp-remote-consoles.inc Normal file
View File

@ -0,0 +1,53 @@
.. -*- rst -*-
Get RDP Console (os-getRDPConsole Action)
=========================================
.. rest_method:: POST /servers/{server_id}/action
max_version: 2.5
Gets an `RDP <https://technet.microsoft.com/en-us/windowsserver/ee236407>`__ console for a server.
.. warning::
Along with HyperV driver, this action was removed in Nova 29.0.0
(caracal) release.
The only supported connect type is ``rdp-html5``. The ``type`` parameter should
be set as ``rdp-html5``.
Specify the ``os-getRDPConsole`` action in the request body.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
- os-getRDPConsole: os-getRDPConsole
- type: os-getRDPConsole-type
**Example Get RDP Console (os-getRDPConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- console: remote_console
- type: os-getRDPConsole-type
- url: os-getRDPConsole-url
**Example Get RDP Console (os-getRDPConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-resp.json
:language: javascript

53
api-ref/source/servers-action-remote-consoles.inc
View File

@ -1,58 +1,5 @@
.. -*- rst -*-
Get RDP Console (os-getRDPConsole Action) (DEPRECATED)
======================================================
.. rest_method:: POST /servers/{server_id}/action
max_version: 2.5
Gets an `RDP <https://technet.microsoft.com/en-us/windowsserver/ee236407>`__ console for a server.
.. warning::
This action is deprecated in microversion 2.5 and superseded
by the API `Server Consoles`_ in microversion 2.6.
The new API offers a unified API for different console types.
The only supported connect type is ``rdp-html5``. The ``type`` parameter should
be set as ``rdp-html5``.
Specify the ``os-getRDPConsole`` action in the request body.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
- os-getRDPConsole: os-getRDPConsole
- type: os-getRDPConsole-type
**Example Get RDP Console (os-getRDPConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- console: remote_console
- type: os-getRDPConsole-type
- url: os-getRDPConsole-url
**Example Get RDP Console (os-getRDPConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-resp.json
:language: javascript
Get Serial Console (os-getSerialConsole Action) (DEPRECATED)
============================================================

2
api-ref/source/servers-actions.inc
View File

@ -20,7 +20,7 @@ also change the password of the server and add a security group to or
remove a security group from a server. You can also trigger a crash dump
into a server since Mitaka release.
You can get an RDP, serial, SPICE, or VNC console for a server.
You can get an serial, SPICE, or VNC console for a server.
Add (Associate) Floating Ip (addFloatingIp Action) (DEPRECATED)

2
api-ref/source/servers-remote-consoles.inc
View File

@ -17,7 +17,7 @@ The API provides a unified request for creating a remote console. The user can
get a URL to connect the console from this API. The URL includes the token
which is used to get permission to access the console. Servers may support
different console protocols. To return a remote console using a specific
protocol, such as RDP, set the ``protocol`` parameter to ``rdp``.
protocol, such as VNC, set the ``protocol`` parameter to ``vnc``.
Normal response codes: 200

45
doc/source/admin/remote-console-access.rst
View File

@ -469,49 +469,6 @@ There are some things to keep in mind when configuring these options:
proxying the console interaction.
RDP
---
RDP is a graphical console primarily used with Hyper-V. Nova does not provide a
console proxy service for RDP - instead, an external proxy service, such as the
:program:`wsgate` application provided by `FreeRDP-WebConnect`__, should be
used.
__ https://github.com/FreeRDP/FreeRDP-WebConnect
Configuration
~~~~~~~~~~~~~
To enable the RDP console service, you must configure both a console proxy
service like :program:`wsgate` and the :program:`nova-compute` service. All
options for the latter service are defined in the :oslo.config:group:`rdp`
group.
Information on configuring an RDP console proxy service, such as
:program:`wsgate`, is not provided here. However, more information can be found
at `cloudbase.it`__.
The :program:`nova-compute` service requires the following options to configure
RDP console support.
- :oslo.config:option:`rdp.enabled`
- :oslo.config:option:`rdp.html5_proxy_base_url`
For example, to configure this via a ``nova.conf`` file:
.. code-block:: ini
[rdp]
enabled = True
html5_proxy_base_url = https://IP_ADDRESS:6083/
Replace ``IP_ADDRESS`` with the IP address from which the proxy is accessible
by the outside world. For example, this may be the management interface IP
address of the controller or the VIP.
__ https://cloudbase.it/freerdp-html5-proxy-windows/
MKS
---
@ -625,4 +582,4 @@ References
.. [1] https://qemu.weilnetz.de/doc/4.2/qemu-doc.html#vnc_005fsec_005fcertificate_005fverify
.. [2] https://tools.ietf.org/html/rfc3280#section-4.2.1.10
.. [3] https://wiki.libvirt.org/page/VNCTLSSetup#Changes_to_be_made_on_the_virtualisation_host_server
.. [3] https://wiki.libvirt.org/page/VNCTLSSetup#Changes_to_be_made_on_the_virtualisation_host_server

4
doc/source/contributor/api-ref-guideline.rst
View File

@ -89,8 +89,8 @@ Method titles spelling and case
The spelling and the case of method names in the title have to match
what is in the code. For instance, the title for the section on method
"Get Rdp Console" should be "Get Rdp Console (os-getRDPConsole Action)"
NOT "Get Rdp Console (Os-Getrdpconsole Action)"
"Get VNC Console" should be "Get VNC Console (os-getVNCConsole Action)"
NOT "Get VNC Console (Os-Getvncconsole Action)"
Description
-----------

30
nova/api/openstack/compute/remote_consoles.py
View File

@ -29,7 +29,6 @@ class RemoteConsolesController(wsgi.Controller):
self.compute_api = compute.API()
self.handlers = {'vnc': self.compute_api.get_vnc_console,
'spice': self.compute_api.get_spice_console,
'rdp': self.compute_api.get_rdp_console,
'serial': self.compute_api.get_serial_console,
'mks': self.compute_api.get_mks_console}
@ -95,32 +94,11 @@ class RemoteConsolesController(wsgi.Controller):
@wsgi.Controller.api_version("2.1", "2.5")
@wsgi.expected_errors((400, 404, 409, 501))
@wsgi.action('os-getRDPConsole')
@validation.schema(remote_consoles.get_rdp_console)
def get_rdp_console(self, req, id, body):
"""Get text console output."""
context = req.environ['nova.context']
context.can(rc_policies.BASE_POLICY_NAME)
# If type is not supplied or unknown, get_rdp_console below will cope
console_type = body['os-getRDPConsole'].get('type')
instance = common.get_instance(self.compute_api, context, id)
try:
# NOTE(mikal): get_rdp_console() can raise InstanceNotFound, so
# we still need to catch it here.
output = self.compute_api.get_rdp_console(context,
instance,
console_type)
except exception.ConsoleTypeUnavailable as e:
raise webob.exc.HTTPBadRequest(explanation=e.format_message())
except exception.InstanceNotFound as e:
raise webob.exc.HTTPNotFound(explanation=e.format_message())
except exception.InstanceNotReady as e:
raise webob.exc.HTTPConflict(explanation=e.format_message())
except NotImplementedError:
common.raise_feature_not_supported()
return {'console': {'type': console_type, 'url': output['url']}}
"""RDP console was available only for HyperV driver which has been
removed from Nova in 29.0.0 (Caracal) release.
"""
raise webob.exc.HTTPBadRequest()
@wsgi.Controller.api_version("2.1", "2.5")
@wsgi.expected_errors((400, 404, 409, 501))

30
nova/api/openstack/compute/schemas/remote_consoles.py
View File

@ -50,25 +50,6 @@ get_spice_console = {
'additionalProperties': False,
}
get_rdp_console = {
'type': 'object',
'properties': {
'os-getRDPConsole': {
'type': 'object',
'properties': {
'type': {
'type': 'string',
'enum': ['rdp-html5'],
},
},
'required': ['type'],
'additionalProperties': False,
},
},
'required': ['os-getRDPConsole'],
'additionalProperties': False,
}
get_serial_console = {
'type': 'object',
'properties': {
@ -96,12 +77,11 @@ create_v26 = {
'properties': {
'protocol': {
'type': 'string',
'enum': ['vnc', 'spice', 'rdp', 'serial'],
'enum': ['vnc', 'spice', 'serial'],
},
'type': {
'type': 'string',
'enum': ['novnc', 'xvpvnc', 'rdp-html5',
'spice-html5', 'serial'],
'enum': ['novnc', 'xvpvnc', 'spice-html5', 'serial'],
},
},
'required': ['protocol', 'type'],
@ -120,12 +100,12 @@ create_v28 = {
'properties': {
'protocol': {
'type': 'string',
'enum': ['vnc', 'spice', 'rdp', 'serial', 'mks'],
'enum': ['vnc', 'spice', 'serial', 'mks'],
},
'type': {
'type': 'string',
'enum': ['novnc', 'xvpvnc', 'rdp-html5',
'spice-html5', 'serial', 'webmks'],
'enum': ['novnc', 'xvpvnc', 'spice-html5', 'serial',
'webmks'],
},
},
'required': ['protocol', 'type'],

9
nova/compute/api.py
View File

@ -4854,15 +4854,6 @@ class API:
instance=instance, console_type=console_type)
return {'url': connect_info['access_url']}
@check_instance_host()
@reject_instance_state(
task_state=[task_states.DELETING, task_states.MIGRATING])
def get_rdp_console(self, context, instance, console_type):
"""Get a url to an instance Console."""
connect_info = self.compute_rpcapi.get_rdp_console(context,
instance=instance, console_type=console_type)
return {'url': connect_info['access_url']}
@check_instance_host()
@reject_instance_state(
task_state=[task_states.DELETING, task_states.MIGRATING])

41
nova/compute/manager.py
View File

@ -7337,6 +7337,9 @@ class ComputeManager(manager.Manager):
return connect_info
# TODO(gmann): HyperV virt driver has been removed in Nova 29.0.0
# but we need to keep this method to avoid RPC error in case of using
# old controller with new compute. This can be removed in RPC API 7.0
@messaging.expected_exceptions(exception.ConsoleTypeInvalid,
exception.InstanceNotReady,
exception.InstanceNotFound,
@ -7346,38 +7349,10 @@ class ComputeManager(manager.Manager):
@wrap_instance_fault
def get_rdp_console(self, context, console_type, instance):
"""Return connection information for a RDP console."""
context = context.elevated()
LOG.debug("Getting RDP console", instance=instance)
if not CONF.rdp.enabled:
raise exception.ConsoleTypeUnavailable(console_type=console_type)
if console_type != 'rdp-html5':
raise exception.ConsoleTypeInvalid(console_type=console_type)
try:
# Retrieve connect info from driver, and then decorate with our
# access info token
console = self.driver.get_rdp_console(context, instance)
console_auth = objects.ConsoleAuthToken(
context=context,
console_type=console_type,
host=console.host,
port=console.port,
internal_access_path=console.internal_access_path,
instance_uuid=instance.uuid,
access_url_base=CONF.rdp.html5_proxy_base_url,
)
console_auth.authorize(CONF.consoleauth.token_ttl)
connect_info = console.get_connection_info(
console_auth.token, console_auth.access_url)
except exception.InstanceNotFound:
if instance.vm_state != vm_states.BUILDING:
raise
raise exception.InstanceNotReady(instance_id=instance.uuid)
return connect_info
msg = ("RDP console is applicable for HyperV virt driver only which "
"has been removed in Nova 29.0.0")
raise NotImplementedError(msg)
@messaging.expected_exceptions(exception.ConsoleTypeInvalid,
exception.InstanceNotReady,
@ -7474,8 +7449,6 @@ class ComputeManager(manager.Manager):
def validate_console_port(self, ctxt, instance, port, console_type):
if console_type == "spice-html5":
console_info = self.driver.get_spice_console(ctxt, instance)
elif console_type == "rdp-html5":
console_info = self.driver.get_rdp_console(ctxt, instance)
elif console_type == "serial":
console_info = self.driver.get_serial_console(ctxt, instance)
elif console_type == "webmks":
@ -9478,7 +9451,7 @@ class ComputeManager(manager.Manager):
def _consoles_enabled(self):
"""Returns whether a console is enable."""
return (CONF.vnc.enabled or CONF.spice.enabled or
CONF.rdp.enabled or CONF.serial_console.enabled or
CONF.serial_console.enabled or
CONF.mks.enabled)
def _clean_instance_console_tokens(self, ctxt, instance):

7
nova/compute/rpcapi.py
View File

@ -837,13 +837,6 @@ class ComputeAPI(object):
return cctxt.call(ctxt, 'get_spice_console',
instance=instance, console_type=console_type)
def get_rdp_console(self, ctxt, instance, console_type):
version = self._ver(ctxt, '5.0')
cctxt = self.router.client(ctxt).prepare(
server=_compute_host(None, instance), version=version)
return cctxt.call(ctxt, 'get_rdp_console',
instance=instance, console_type=console_type)
def get_mks_console(self, ctxt, instance, console_type):
version = self._ver(ctxt, '5.0')
cctxt = self.router.client(ctxt).prepare(

2
nova/conf/__init__.py
View File

@ -49,7 +49,6 @@ from nova.conf import paths
from nova.conf import pci
from nova.conf import placement
from nova.conf import quota
from nova.conf import rdp
from nova.conf import rpc
from nova.conf import scheduler
from nova.conf import serial_console
@ -97,7 +96,6 @@ paths.register_opts(CONF)
pci.register_opts(CONF)
placement.register_opts(CONF)
quota.register_opts(CONF)
rdp.register_opts(CONF)
rpc.register_opts(CONF)
scheduler.register_opts(CONF)
serial_console.register_opts(CONF)

94
nova/conf/rdp.py
View File

@ -1,94 +0,0 @@
# Copyright 2015 OpenStack Foundation
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from oslo_config import cfg
rdp_group = cfg.OptGroup(
'rdp',
title='RDP options',
help="""
Options under this group enable and configure Remote Desktop Protocol (
RDP) related features.
This group is only relevant to Hyper-V users.
"""
)
RDP_OPTS = [
cfg.BoolOpt('enabled',
default=False,
help="""
Enable Remote Desktop Protocol (RDP) related features.
Hyper-V, unlike the majority of the hypervisors employed on Nova compute
nodes, uses RDP instead of VNC and SPICE as a desktop sharing protocol to
provide instance console access. This option enables RDP for graphical
console access for virtual machines created by Hyper-V.
**Note:** RDP should only be enabled on compute nodes that support the Hyper-V
virtualization platform.
Related options:
* ``compute_driver``: Must be hyperv.
"""),
cfg.URIOpt('html5_proxy_base_url',
schemes=['http', 'https'],
default='http://127.0.0.1:6083/',
help="""
The URL an end user would use to connect to the RDP HTML5 console proxy.
The console proxy service is called with this token-embedded URL and
establishes the connection to the proper instance.
An RDP HTML5 console proxy service will need to be configured to listen on the
address configured here. Typically the console proxy service would be run on a
controller node. The localhost address used as default would only work in a
single node environment i.e. devstack.
An RDP HTML5 proxy allows a user to access via the web the text or graphical
console of any Windows server or workstation using RDP. RDP HTML5 console
proxy services include FreeRDP, wsgate.
See https://github.com/FreeRDP/FreeRDP-WebConnect
Possible values:
* <scheme>://<ip-address>:<port-number>/
The scheme must be identical to the scheme configured for the RDP HTML5
console proxy service. It is ``http`` or ``https``.
The IP address must be identical to the address on which the RDP HTML5
console proxy service is listening.
The port must be identical to the port on which the RDP HTML5 console proxy
service is listening.
Related options:
* ``rdp.enabled``: Must be set to ``True`` for ``html5_proxy_base_url`` to be
effective.
"""),
]
def register_opts(conf):
conf.register_group(rdp_group)
conf.register_opts(RDP_OPTS, rdp_group)
def list_opts():
return {rdp_group: RDP_OPTS}

4
nova/console/type.py
View File

@ -32,10 +32,6 @@ class ConsoleVNC(Console):
pass
class ConsoleRDP(Console):
pass
class ConsoleSpice(Console):
def __init__(self, host, port, tlsPort, internal_access_path=None):
super(ConsoleSpice, self).__init__(host, port, internal_access_path)

5
nova/policies/remote_consoles.py
View File

@ -30,15 +30,10 @@ remote_consoles_policies = [
This policy is for ``POST /remote-consoles`` API and below Server actions APIs
are deprecated:
- ``os-getRDPConsole``
- ``os-getSerialConsole``
- ``os-getSPICEConsole``
- ``os-getVNCConsole``.""",
operations=[
{
'method': 'POST',
'path': '/servers/{server_id}/action (os-getRDPConsole)'
},
{
'method': 'POST',
'path': '/servers/{server_id}/action (os-getSerialConsole)'

6
nova/tests/functional/api_sample_tests/api_samples/os-remote-consoles/get-rdp-console-post-resp.json.tpl
View File

@ -1,6 +0,0 @@
{
"console": {
"type": "rdp-html5",
"url": "http://127.0.0.1:6083/?token=%(uuid)s"
}
}

6
nova/tests/functional/api_sample_tests/api_samples/os-remote-consoles/v2.6/create-rdp-console-req.json.tpl Normal file
View File

@ -0,0 +1,6 @@
{
"remote_console": {
"protocol": "rdp",
"type": "rdp-html5"
}
}

15
nova/tests/functional/api_sample_tests/test_remote_consoles.py
View File

@ -31,7 +31,6 @@ class ConsolesSampleJsonTests(test_servers.ServersSampleBase):
self.api.microversion = self.microversion
self.flags(enabled=True, group='vnc')
self.flags(enabled=True, group='spice')
self.flags(enabled=True, group='rdp')
self.flags(enabled=True, group='serial_console')
def test_get_vnc_console(self):
@ -66,13 +65,13 @@ class ConsolesSampleJsonTests(test_servers.ServersSampleBase):
self._verify_response('get-spice-console-post-resp', {'url': HTTP_RE},
response, 200)
def test_get_rdp_console(self):
def test_get_rdp_console_bad_request(self):
"""Ensure http 400 error is return from RDP console request"""
uuid = self._post_server()
response = self._do_post('servers/%s/action' % uuid,
'get-rdp-console-post-req',
{'action': 'os-getRDPConsole'})
self._verify_response('get-rdp-console-post-resp', {'url': HTTP_RE},
response, 200)
self.assertEqual(400, response.status_code)
def test_get_serial_console(self):
uuid = self._post_server()
@ -100,6 +99,14 @@ class ConsolesV26SampleJsonTests(test_servers.ServersSampleBase):
self._verify_response('create-vnc-console-resp', {'url': HTTP_RE},
response, 200)
def test_create_rdp_console_bad_request(self):
"""Ensure http 400 error is return from RDP console request"""
uuid = self._post_server()
body = {'protocol': 'rdp', 'type': 'rdp-html5'}
response = self._do_post('servers/%s/remote-consoles' % uuid,
'create-rdp-console-req', body)
self.assertEqual(400, response.status_code)
class ConsolesV28SampleJsonTests(test_servers.ServersSampleBase):
sample_dir = "os-remote-consoles"

78
nova/tests/unit/api/openstack/compute/test_remote_consoles.py
View File

@ -208,65 +208,12 @@ class ConsolesExtensionTestV21(test.NoDBTestCase):
self.validation_error,
body)
@mock.patch.object(compute_api.API, 'get_rdp_console',
return_value={'url': 'http://fake'})
def test_get_rdp_console(self, mock_get_rdp_console):
def test_get_rdp_console_bad_request(self):
body = {'os-getRDPConsole': {'type': 'rdp-html5'}}
req = fakes.HTTPRequest.blank('')
output = self.controller.get_rdp_console(req, fakes.FAKE_UUID,
body=body)
self.assertEqual(output,
{u'console': {u'url': u'http://fake', u'type': u'rdp-html5'}})
mock_get_rdp_console.assert_called_once_with(
req.environ['nova.context'], self.instance, 'rdp-html5')
def test_get_rdp_console_not_ready(self):
body = {'os-getRDPConsole': {'type': 'rdp-html5'}}
self._check_console_failure(
self.controller.get_rdp_console,
webob.exc.HTTPConflict,
body,
'get_rdp_console',
exception.InstanceNotReady(instance_id=fakes.FAKE_UUID))
def test_get_rdp_console_no_type(self):
body = {'os-getRDPConsole': {}}
self._check_console_failure(
self.controller.get_rdp_console,
self.validation_error,
body)
def test_get_rdp_console_no_instance(self):
body = {'os-getRDPConsole': {'type': 'rdp-html5'}}
self._check_console_failure(
self.controller.get_rdp_console,
webob.exc.HTTPNotFound,
body,
'get',
exception.InstanceNotFound(instance_id=fakes.FAKE_UUID))
def test_get_rdp_console_no_instance_on_console_get(self):
body = {'os-getRDPConsole': {'type': 'rdp-html5'}}
self._check_console_failure(
self.controller.get_rdp_console,
webob.exc.HTTPNotFound,
body,
'get_rdp_console',
exception.InstanceNotFound(instance_id=fakes.FAKE_UUID))
def test_get_rdp_console_invalid_type(self):
body = {'os-getRDPConsole': {'type': 'invalid'}}
self._check_console_failure(
self.controller.get_rdp_console,
self.validation_error,
body)
def test_get_rdp_console_type_unavailable(self):
body = {'os-getRDPConsole': {'type': 'unavailable'}}
self._check_console_failure(
self.controller.get_rdp_console,
self.validation_error,
body)
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.get_rdp_console,
req, fakes.FAKE_UUID, body=body)
def test_get_vnc_console_with_undefined_param(self):
body = {'os-getVNCConsole': {'type': 'novnc', 'undefined': 'foo'}}
@ -283,13 +230,6 @@ class ConsolesExtensionTestV21(test.NoDBTestCase):
self.validation_error,
body)
def test_get_rdp_console_with_undefined_param(self):
body = {'os-getRDPConsole': {'type': 'rdp-html5', 'undefined': 'foo'}}
self._check_console_failure(
self.controller.get_rdp_console,
self.validation_error,
body)
@mock.patch.object(compute_api.API, 'get_serial_console',
return_value={'url': 'ws://fake'})
def test_get_serial_console(self, mock_get_serial_console):
@ -412,18 +352,14 @@ class ConsolesExtensionTestV26(test.NoDBTestCase):
mock_handler.assert_called_once_with(self.context, self.instance,
'spice-html5')
def test_create_rdp_console(self):
def test_create_rdp_console_bad_request(self):
mock_handler = mock.MagicMock()
mock_handler.return_value = {'url': "http://fake"}
self.controller.handlers['rdp'] = mock_handler
body = {'remote_console': {'protocol': 'rdp', 'type': 'rdp-html5'}}
output = self.controller.create(self.req, fakes.FAKE_UUID, body=body)
self.assertEqual({'remote_console': {'protocol': 'rdp',
'type': 'rdp-html5',
'url': 'http://fake'}}, output)
mock_handler.assert_called_once_with(self.context, self.instance,
'rdp-html5')
self.assertRaises(exception.ValidationError, self.controller.create,
self.req, fakes.FAKE_UUID, body=body)
def test_create_serial_console(self):
mock_handler = mock.MagicMock()

139
nova/tests/unit/compute/test_compute.py
View File

@ -3996,20 +3996,6 @@ class ComputeTestCase(BaseTestCase,
context=self.context, instance=instance, port="5900",
console_type="spice-html5"))
def test_validate_console_port_rdp(self):
self.flags(enabled=True, group='rdp')
instance = self._create_fake_instance_obj()
def fake_driver_get_console(*args, **kwargs):
return ctype.ConsoleRDP(host="fake_host", port=5900)
self.stub_out("nova.virt.fake.FakeDriver.get_rdp_console",
fake_driver_get_console)
self.assertTrue(self.compute.validate_console_port(
context=self.context, instance=instance, port="5900",
console_type="rdp-html5"))
def test_validate_console_port_serial(self):
self.flags(enabled=True, group='serial_console')
instance = self._create_fake_instance_obj()
@ -4197,70 +4183,6 @@ class ComputeTestCase(BaseTestCase,
self.compute.terminate_instance(self.context, instance, [])
def test_rdphtml5_rdp_console(self):
# Make sure we can a rdp console for an instance.
self.flags(enabled=False, group='vnc')
self.flags(enabled=True, group='rdp')
instance = self._create_fake_instance_obj()
self.compute.build_and_run_instance(self.context,
instance, {}, {}, {}, [], block_device_mapping=[])
# Try with the full instance
console = self.compute.get_rdp_console(self.context, 'rdp-html5',
instance=instance)
self.assertTrue(console)
# Verify that the console auth has also been stored in the
# database backend.
auth = objects.ConsoleAuthToken.validate(self.context,
console['token'])
self.assertIsNotNone(auth)
self.compute.terminate_instance(self.context, instance, [])
def test_invalid_rdp_console_type(self):
# Raise useful error if console type is an unrecognised string
self.flags(enabled=False, group='vnc')
self.flags(enabled=True, group='rdp')
instance = self._create_fake_instance_obj()
self.compute.build_and_run_instance(self.context,
instance, {}, {}, {}, [], block_device_mapping=[])
self.assertRaises(messaging.ExpectedException,
self.compute.get_rdp_console,
self.context, 'invalid', instance=instance)
self.compute = utils.ExceptionHelper(self.compute)
self.assertRaises(exception.ConsoleTypeInvalid,
self.compute.get_rdp_console,
self.context, 'invalid', instance=instance)
self.compute.terminate_instance(self.context, instance, [])
def test_missing_rdp_console_type(self):
# Raise useful error is console type is None
self.flags(enabled=False, group='vnc')
self.flags(enabled=True, group='rdp')
instance = self._create_fake_instance_obj()
self.compute.build_and_run_instance(self.context,
instance, {}, {}, {}, [], block_device_mapping=[])
self.assertRaises(messaging.ExpectedException,
self.compute.get_rdp_console,
self.context, None, instance=instance)
self.compute = utils.ExceptionHelper(self.compute)
self.assertRaises(exception.ConsoleTypeInvalid,
self.compute.get_rdp_console,
self.context, None, instance=instance)
self.compute.terminate_instance(self.context, instance, [])
def test_vnc_console_instance_not_ready(self):
self.flags(enabled=True, group='vnc')
self.flags(enabled=False, group='spice')
@ -4297,24 +4219,6 @@ class ComputeTestCase(BaseTestCase,
self.compute.get_spice_console, self.context, 'spice-html5',
instance=instance)
def test_rdp_console_instance_not_ready(self):
self.flags(enabled=False, group='vnc')
self.flags(enabled=True, group='rdp')
instance = self._create_fake_instance_obj(
params={'vm_state': vm_states.BUILDING})
def fake_driver_get_console(*args, **kwargs):
raise exception.InstanceNotFound(instance_id=instance['uuid'])
self.stub_out("nova.virt.fake.FakeDriver.get_rdp_console",
fake_driver_get_console)
self.compute = utils.ExceptionHelper(self.compute)
self.assertRaises(exception.InstanceNotReady,
self.compute.get_rdp_console, self.context, 'rdp-html5',
instance=instance)
def test_vnc_console_disabled(self):
self.flags(enabled=False, group='vnc')
instance = self._create_fake_instance_obj(
@ -4337,17 +4241,6 @@ class ComputeTestCase(BaseTestCase,
self.compute.get_spice_console, self.context, 'spice-html5',
instance=instance)
def test_rdp_console_disabled(self):
self.flags(enabled=False, group='rdp')
instance = self._create_fake_instance_obj(
params={'vm_state': vm_states.BUILDING})
self.compute = utils.ExceptionHelper(self.compute)
self.assertRaises(exception.ConsoleTypeUnavailable,
self.compute.get_rdp_console, self.context, 'rdp-html5',
instance=instance)
def test_diagnostics(self):
# Make sure we can get diagnostics for an instance.
expected_diagnostic = {'cpu0_time': 17300000000,
@ -10282,8 +10175,6 @@ class ComputeAPITestCase(BaseTestCase):
@ddt.data(('spice', task_states.DELETING),
('spice', task_states.MIGRATING),
('rdp', task_states.DELETING),
('rdp', task_states.MIGRATING),
('vnc', task_states.DELETING),
('vnc', task_states.MIGRATING),
('mks', task_states.DELETING),
@ -10299,36 +10190,6 @@ class ComputeAPITestCase(BaseTestCase):
getattr(self.compute_api, 'get_%s_console' % console_type),
self.context, instance, console_type)
@mock.patch.object(compute_rpcapi.ComputeAPI, 'get_rdp_console')
def test_rdp_console(self, mock_rdp):
# Make sure we can a rdp console for an instance.
fake_instance = self._fake_instance({
'uuid': 'f3000000-0000-0000-0000-000000000000',
'host': 'fake_compute_host'})
fake_console_type = "rdp-html5"
fake_connect_info = {'token': 'fake_token',
'console_type': fake_console_type,
'host': 'fake_console_host',
'port': 'fake_console_port',
'internal_access_path': 'fake_access_path',
'instance_uuid': fake_instance.uuid,
'access_url': 'fake_console_url'}
mock_rdp.return_value = fake_connect_info
console = self.compute_api.get_rdp_console(self.context,
fake_instance, fake_console_type)
self.assertEqual(console, {'url': 'fake_console_url'})
mock_rdp.assert_called_once_with(self.context, instance=fake_instance,
console_type=fake_console_type)
def test_get_rdp_console_no_host(self):
instance = self._create_fake_instance_obj(params={'host': ''})
self.assertRaises(exception.InstanceNotReady,
self.compute_api.get_rdp_console,
self.context, instance, 'rdp')
def test_serial_console(self):
# Make sure we can get a serial proxy url for an instance.

18
nova/tests/unit/compute/test_compute_mgr.py
View File

@ -6034,19 +6034,18 @@ class ComputeManagerUnitTestCase(test.NoDBTestCase,
self.assertEqual(args[1], self.compute.host)
self.assertEqual(args[2], mock.sentinel.inst_uuid)
@ddt.data(('vnc', 'spice', 'rdp', 'serial_console', 'mks'),
('spice', 'vnc', 'rdp', 'serial_console', 'mks'),
('rdp', 'vnc', 'spice', 'serial_console', 'mks'),
('serial_console', 'vnc', 'spice', 'rdp', 'mks'),
('mks', 'vnc', 'spice', 'rdp', 'serial_console'))
@ddt.data(('vnc', 'spice', 'serial_console', 'mks'),
('spice', 'vnc', 'serial_console', 'mks'),
('serial_console', 'vnc', 'spice', 'mks'),
('mks', 'vnc', 'spice', 'serial_console'))
@ddt.unpack
@mock.patch('nova.objects.ConsoleAuthToken.'
'clean_console_auths_for_instance')
def test_clean_instance_console_tokens(self, g1, g2, g3, g4, g5,
def test_clean_instance_console_tokens(self, g1, g2, g3, g4,
mock_clean):
# Enable one of each of the console types and disable the rest
self.flags(enabled=True, group=g1)
for g in [g2, g3, g4, g5]:
for g in [g2, g3, g4]:
self.flags(enabled=False, group=g)
instance = objects.Instance(uuid=uuids.instance)
self.compute._clean_instance_console_tokens(self.context, instance)
@ -6056,7 +6055,7 @@ class ComputeManagerUnitTestCase(test.NoDBTestCase,
'clean_console_auths_for_instance')
def test_clean_instance_console_tokens_no_consoles_enabled(self,
mock_clean):
for g in ['vnc', 'spice', 'rdp', 'serial_console', 'mks']:
for g in ['vnc', 'spice', 'serial_console', 'mks']:
self.flags(enabled=False, group=g)
instance = objects.Instance(uuid=uuids.instance)
self.compute._clean_instance_console_tokens(self.context, instance)
@ -9843,7 +9842,6 @@ class ComputeManagerMigrationTestCase(test.NoDBTestCase,
def test_consoles_enabled(self):
self.flags(enabled=False, group='vnc')
self.flags(enabled=False, group='spice')
self.flags(enabled=False, group='rdp')
self.flags(enabled=False, group='serial_console')
self.assertFalse(self.compute._consoles_enabled())
@ -9851,7 +9849,7 @@ class ComputeManagerMigrationTestCase(test.NoDBTestCase,
self.assertTrue(self.compute._consoles_enabled())
self.flags(enabled=False, group='vnc')
for console in ['spice', 'rdp', 'serial_console']:
for console in ['spice', 'serial_console']:
self.flags(enabled=True, group=console)
self.assertTrue(self.compute._consoles_enabled())
self.flags(enabled=False, group=console)

5
nova/tests/unit/compute/test_rpcapi.py
View File

@ -355,11 +355,6 @@ class ComputeRpcAPITestCase(test.NoDBTestCase):
instance=self.fake_instance_obj, console_type='type',
version='6.0')
def test_get_rdp_console(self):
self._test_compute_api('get_rdp_console', 'call',
instance=self.fake_instance_obj, console_type='type',
version='6.0')
def test_get_serial_console(self):
self._test_compute_api('get_serial_console', 'call',
instance=self.fake_instance_obj, console_type='serial',

5
nova/tests/unit/console/test_type.py
View File

@ -42,11 +42,6 @@ class TypeTestCase(test.NoDBTestCase):
self.assertIsInstance(c, ctype.Console)
def test_console_rdp(self):
c = ctype.ConsoleRDP(host='127.0.0.1', port=8945)
self.assertIsInstance(c, ctype.Console)
def test_console_spice(self):
c = ctype.ConsoleSpice(host='127.0.0.1', port=8945, tlsPort=6547)

6
nova/tests/unit/virt/test_virt_drivers.py
View File

@ -541,12 +541,6 @@ class _VirtDriverTestCase(_FakeDriverBackendTestCase):
instance_ref)
self.assertIsInstance(spice_console, ctype.ConsoleSpice)
@catch_notimplementederror
def test_get_rdp_console(self):
instance_ref, network_info = self._get_running_instance()
rdp_console = self.connection.get_rdp_console(self.ctxt, instance_ref)
self.assertIsInstance(rdp_console, ctype.ConsoleRDP)
@catch_notimplementederror
def test_get_serial_console(self):
self.flags(enabled=True, group='serial_console')

10
nova/virt/driver.py
View File

@ -547,16 +547,6 @@ class ComputeDriver(object):
"""
raise NotImplementedError()
def get_rdp_console(self, context, instance):
"""Get connection info for a rdp console.
:param context: security context
:param instance: nova.objects.instance.Instance
:returns: an instance of console.type.ConsoleRDP
"""
raise NotImplementedError()
def get_serial_console(self, context, instance):
"""Get connection info for a serial console.

5
nova/virt/fake.py
View File

@ -467,11 +467,6 @@ class FakeDriver(driver.ComputeDriver):
port=6969,
tlsPort=6970)
def get_rdp_console(self, context, instance):
return ctype.ConsoleRDP(internal_access_path='FAKE',
host='fakerdpconsole.com',
port=6969)
def get_serial_console(self, context, instance):
return ctype.ConsoleSerial(internal_access_path='FAKE',
host='fakerdpconsole.com',

23
releasenotes/notes/remove-hyperv-94d5bfd8a539fe9f.yaml
View File

@ -6,15 +6,24 @@ upgrade:
maintainers. In addition, it has a dependency on the OpenStack Winstacker
project that also has been retired.
The RDP console was only available for the HyperV driver, therefore its
connection information via below API ``os-console-auth-tokens`` will now
return HTTP ``400 (BadRequest)`` error:
The RDP console was only available for the HyperV driver, therefore the
RDP console related APIs below will return HTTP ``400 (BadRequest)`` error:
* Show Console Connection Information:
GET /os-console-auth-tokens/{console_token}
* GET RDP console:
* Server Action Get RDP Console:
POST /servers/{server_id}/action (os-getRDPConsole Action)
* RDP protocol support from remote console API:
POST /servers/{server_id}/remote-consoles
* GET RDP console connection information:
* Show Console Connection Information:
GET /os-console-auth-tokens/{console_token}
The following config options which only apply for the ``HyperV`` virt
driver also been removed:
driver or RDP console APIs also have been removed:
* ``[hyperv] dynamic_memory_ratio``
* ``[hyperv] enable_instance_metrics_collection``
@ -34,3 +43,5 @@ upgrade:
* ``[hyperv] enable_remotefx``
* ``[hyperv] use_multipath_io``
* ``[hyperv] iscsi_initiator_list``
* ``[rdp] enabled``
* ``[rdp] html5_proxy_base_url``