From 2764b938b1c2793de30f5cfb6706af33435d4df5 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Mon, 1 Oct 2018 16:38:43 +0100 Subject: [PATCH] doc: Add minimal documentation for MKS consoles I did know this was a thing but only barely. As with RDP, the documentation is very minimal but it should contain enough pointers for anyone playing with this stuff. Change-Id: I0b62d42eae7c325566ee065dcdc0f73b7223d471 --- doc/source/admin/remote-console-access.rst | 29 ++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/doc/source/admin/remote-console-access.rst b/doc/source/admin/remote-console-access.rst index 6ff52bef48af..f8bb448ab256 100644 --- a/doc/source/admin/remote-console-access.rst +++ b/doc/source/admin/remote-console-access.rst @@ -571,6 +571,35 @@ address of the controller or the VIP. __ https://cloudbase.it/freerdp-html5-proxy-windows/ +MKS +--- + +MKS is the protocol used for accessing the console of a virtual machine running +on VMware vSphere. It is very similar to VNC. Due to the architecture of the +VMware vSphere hypervisor, it is not necessary to run a console proxy service. + +Configuration +~~~~~~~~~~~~~ + +To enable the MKS console service, only the :program:`nova-compute` service +must be configured. All options are defined in the :oslo.config:group:`mks` +group. + +The :program:`nova-compute` service requires the following options to configure +MKS console support. + +- :oslo.config:option:`mks.enabled` +- :oslo.config:option:`mks.mksproxy_base_url` + +For example, to configure this via a ``nova.conf`` file: + +.. code-block:: console + + [mks] + enabled = True + mksproxy_base_url = https://127.0.0.1:6090/ + + Frequently Asked Questions --------------------------