x/nova-mksproxy
Code Issues Proposed changes

Update README file

Browse Source 
Update README to encourage using the devstack plugin instead of manual
installation and configuration.

Change-Id: I08bb5c551ed8a4a7dac21f400349f3a44846a8ca
This commit is contained in:
Radoslav Gerganov 2016-08-25 11:37:24 +03:00
parent e5ea0ca806
commit e90cadf5a4
1 changed files with 7 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -4,22 +4,14 @@ nova-mksproxy
This is Nova console proxy for instances running on VMware.
It requires Nova to support microversion 2.31 to work.
Usage
-----
1. Start the proxy with OpenStack admin credentials::
Usage with Devstack
-------------------
There is a devstack plugin for ``nova-mksproxy``, so simply add this to your ``local.conf``::
$ source openrc admin admin
$ nova-mksproxy --web /opt/share/noVNC
[[local|localrc]]
enable_plugin nova-mksproxy https://github.com/openstack/nova-mksproxy
by default it binds to ``0.0.0.0:6090``
The plugin will enable MKS consoles in Nova and will start the proxy on port 6090. Use nova CLI to get a console URL::
2. Configure Nova to enable MKS consoles::
[mks]
enabled = True
mksproxy_base_url = http://<host>:<port>/vnc_auto.html
3. Use nova CLI to get a console URL::
$ nova get-mks-console cirros
$ nova get-mks-console <instance_name>