From e90cadf5a421c3dd72df88890607aec46a61f134 Mon Sep 17 00:00:00 2001 From: Radoslav Gerganov Date: Thu, 25 Aug 2016 11:37:24 +0300 Subject: [PATCH] Update README file Update README to encourage using the devstack plugin instead of manual installation and configuration. Change-Id: I08bb5c551ed8a4a7dac21f400349f3a44846a8ca --- README.rst | 22 +++++++--------------- 1 file changed, 7 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 357edd4..e185c64 100644 --- a/README.rst +++ b/README.rst @@ -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://:/vnc_auto.html - -3. Use nova CLI to get a console URL:: - - $ nova get-mks-console cirros + $ nova get-mks-console