openstack
/
nova
Code Issues Proposed changes

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
This commit is contained in:
Stephen Finucane 2018-10-01 16:38:43 +01:00
parent c7355aa66d
commit 2764b938b1
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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
--------------------------