74 lines
3.6 KiB
XML
74 lines
3.6 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="using-vnc-console">
|
|
<title>Use the VNC console</title>
|
|
<para>To interact through the VNC console, you can use a VNC client
|
|
directly, a special Java client, or a web browser. For information
|
|
about how to configure the console, see <xref
|
|
linkend="installing-openstack-dashboard"/>.</para>
|
|
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
|
xml:id="getting-an-access-url">
|
|
<title>Get an access URL</title>
|
|
<para>The Compute service enables you to create access_urls
|
|
through the os-consoles extension. Support for accessing this
|
|
URL is provided by the nova client:</para>
|
|
<screen><prompt>$</prompt> <userinput>nova get-vnc-console <replaceable>[server_id]</replaceable> <replaceable>[novnc|xvpvnc]</replaceable></userinput></screen>
|
|
<para>Specify '<literal>novnc</literal>' to get a URL suitable for
|
|
pasting into a web browser.</para>
|
|
<para>Specify '<literal>xvpvnc</literal>' for a URL suitable for
|
|
pasting into the Java client.</para>
|
|
<para>To request a web browser URL:</para>
|
|
<screen><prompt>$</prompt> <userinput>nova get-vnc-console <replaceable>[server_id]</replaceable> novnc</userinput></screen>
|
|
</section>
|
|
<section xml:id="accessing-vnc-consoles-with-a-java-client">
|
|
<title>Access a VNC console with a Java client</title>
|
|
<para>To enable support for the OpenStack Java VNC client in
|
|
compute, run the <literal>nova-xvpvncproxy</literal>
|
|
service.</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para><literal>xvpvncproxy_port</literal>=<replaceable>[port]</replaceable>
|
|
- port to bind (defaults to 6081)</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><literal>xvpvncproxy_host</literal>=<replaceable>[host]</replaceable>
|
|
- host to bind (defaults to 0.0.0.0)</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>As a client, you need a special Java client, which is a
|
|
slightly modified version of TightVNC that supports our token
|
|
auth:</para>
|
|
<screen><prompt>$</prompt> <userinput>git clone https://github.com/cloudbuilders/nova-xvpvncviewer</userinput>
|
|
<prompt>$</prompt> <userinput>cd nova-xvpvncviewer/viewer</userinput>
|
|
<prompt>$</prompt> <userinput>make</userinput></screen>
|
|
<para>To create a session, request an access URL by using
|
|
<command>python-novaclient</command>. Then, run the client as
|
|
follows.</para>
|
|
<para>To get an access URL:</para>
|
|
<screen><prompt>$</prompt> <userinput>nova get-vnc-console <replaceable>[server_id]</replaceable> xvpvnc</userinput></screen>
|
|
<para>To run the client:</para>
|
|
<screen><prompt>$</prompt> <userinput>java -jar VncViewer.jar <replaceable>[access_url]</replaceable></userinput></screen>
|
|
</section>
|
|
|
|
<section xml:id="accessing-a-vnc-console-through-a-web-browser">
|
|
<info>
|
|
<title>Access a VNC console with a web browser</title>
|
|
</info>
|
|
<para>Retrieving an access_url for a web browser is similar to the
|
|
flow for the Java client.</para>
|
|
<para>To get the access URL, run the following command:</para>
|
|
|
|
<screen><prompt>$</prompt> <userinput>nova get-vnc-console <replaceable>[server_id]</replaceable> novnc</userinput></screen>
|
|
<para>Paste the URL into your web browser.</para>
|
|
|
|
<para>Additionally, you can use the OpenStack dashboard, known as
|
|
horizon, to access browser-based VNC consoles for
|
|
instances.</para>
|
|
</section>
|
|
</section>
|