From 4e6cffe45e3e132066822129dd540b15ecdef667 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Fri, 12 Oct 2018 15:54:17 +0100 Subject: [PATCH] Deprecate the nova-xvpvncproxy service This is a relic that has long since been replaced by the noVNC proxy service. Start preparing for its removal. Change-Id: Icb225dec3ad291b751e475bd3703ce0eb30b44db --- doc/source/admin/remote-console-access.rst | 5 +++++ doc/source/cli/index.rst | 2 +- doc/source/cli/nova-xvpvncproxy.rst | 5 +++++ doc/source/install/get-started-compute.rst | 5 +++++ nova/conf/vnc.py | 20 ++++++++++++++++++- nova/vnc/xvp_proxy.py | 4 ++++ ...ate-nova-xvpvncproxy-16b56634cd07dbd9.yaml | 5 +++++ 7 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 releasenotes/notes/deprecate-nova-xvpvncproxy-16b56634cd07dbd9.yaml diff --git a/doc/source/admin/remote-console-access.rst b/doc/source/admin/remote-console-access.rst index f8bb448ab2..8c1c5a3a96 100644 --- a/doc/source/admin/remote-console-access.rst +++ b/doc/source/admin/remote-console-access.rst @@ -315,6 +315,11 @@ XVP-based VNC console VNC is a graphical console with wide support among many hypervisors and clients. Xen VNC Proxy (XVP) provides VNC support via a simple Java client. +.. deprecated:: 19.0.0 + + :program:`nova-xvpvnxproxy` is deprecated since 19.0.0 (Stein) and will be + removed in an upcoming release. + Configuration ~~~~~~~~~~~~~ diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 68c12497a0..7f29b7b971 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -50,7 +50,6 @@ daemonize correctly after starting up. nova-scheduler nova-serialproxy nova-spicehtml5proxy - nova-xvpvncproxy WSGI Services ------------- @@ -91,3 +90,4 @@ deployments, but are documented for existing ones. nova-network nova-consoleauth nova-console + nova-xvpvncproxy diff --git a/doc/source/cli/nova-xvpvncproxy.rst b/doc/source/cli/nova-xvpvncproxy.rst index 5b02e314c5..50d87976ac 100644 --- a/doc/source/cli/nova-xvpvncproxy.rst +++ b/doc/source/cli/nova-xvpvncproxy.rst @@ -25,6 +25,11 @@ Description Console Proxy service, which provides an XVP-based VNC Console Proxy for use with the Xen hypervisor. +.. deprecated:: 19.0.0 + + :program:`nova-xvpvnxproxy` is deprecated since 19.0.0 (Stein) and will be + removed in an upcoming release. + Options ======= diff --git a/doc/source/install/get-started-compute.rst b/doc/source/install/get-started-compute.rst index 2a33236736..b315567282 100644 --- a/doc/source/install/get-started-compute.rst +++ b/doc/source/install/get-started-compute.rst @@ -82,6 +82,11 @@ OpenStack Compute consists of the following areas and their components: Provides a proxy for accessing running instances through a VNC connection. Supports an OpenStack-specific Java client. + .. deprecated:: 19.0.0 + + :program:`nova-xvpvnxproxy` is deprecated since 19.0.0 (Stein) and will be + removed in an upcoming release. + The queue A central hub for passing messages between daemons. Usually implemented with `RabbitMQ `__, also can be implemented with diff --git a/nova/conf/vnc.py b/nova/conf/vnc.py index f06b066ddd..4fc7674476 100644 --- a/nova/conf/vnc.py +++ b/nova/conf/vnc.py @@ -88,7 +88,7 @@ The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. This option sets the private address to which proxy clients, such as -``nova-xvpvncproxy``, should connect to. +``nova-novncproxy``, should connect to. """), cfg.URIOpt( @@ -119,6 +119,12 @@ Related options: 'xvpvncproxy_host', default='0.0.0.0', deprecated_group='DEFAULT', + deprecated_for_removal=True, + deprecated_since='19.0.0', + deprecated_reason=""" +The ``nova-xvpvnxproxy`` service is deprecated and will be removed in an +upcoming release. +""", help=""" IP address or hostname that the XVP VNC console proxy should bind to. @@ -141,6 +147,12 @@ Related options: 'xvpvncproxy_port', default=6081, deprecated_group='DEFAULT', + deprecated_for_removal=True, + deprecated_since='19.0.0', + deprecated_reason=""" +The ``nova-xvpvnxproxy`` service is deprecated and will be removed in an +upcoming release. +""", help=""" Port that the XVP VNC console proxy should bind to. @@ -163,6 +175,12 @@ Related options: 'xvpvncproxy_base_url', default='http://127.0.0.1:6081/console', deprecated_group='DEFAULT', + deprecated_for_removal=True, + deprecated_since='19.0.0', + deprecated_reason=""" +The ``nova-xvpvnxproxy`` service is deprecated and will be removed in an +upcoming release. +""", help=""" Public URL address of XVP VNC console proxy. diff --git a/nova/vnc/xvp_proxy.py b/nova/vnc/xvp_proxy.py index 06929d8fa1..d03c563854 100644 --- a/nova/vnc/xvp_proxy.py +++ b/nova/vnc/xvp_proxy.py @@ -165,6 +165,10 @@ def get_wsgi_server(): LOG.info(_LI("Starting nova-xvpvncproxy node (version %s)"), version.version_string_with_package()) + LOG.warning('The nova-xvpvncproxy service is deprecated as it is Xen ' + 'specific and has effectively been replaced by noVNC ' + 'and the nova-novncproxy service.') + return wsgi.Server("XCP VNC Proxy", XCPVNCProxy(), protocol=SafeHttpProtocol, diff --git a/releasenotes/notes/deprecate-nova-xvpvncproxy-16b56634cd07dbd9.yaml b/releasenotes/notes/deprecate-nova-xvpvncproxy-16b56634cd07dbd9.yaml new file mode 100644 index 0000000000..a2257b761d --- /dev/null +++ b/releasenotes/notes/deprecate-nova-xvpvncproxy-16b56634cd07dbd9.yaml @@ -0,0 +1,5 @@ +--- +deprecations: + - | + The nova-xvpvncproxy service is deprecated as it is Xen specific and has + effectively been replaced by noVNC and the nova-novncproxy service.