openstack/nova

History

Alessandro Pilotti 630a349bc3 Adds get_console_connect_info API Implements: blueprint hyper-v-rdp-console Currently graphical console access to Nova instances is limited to clients which are part of Nova itself (novnc, xvpvnc, spice-html5). The mentioned clients verify the validity of a console access token with the following private API: nova.consoleauth.rpcapi.ConsoleAuthAPI.check_token The usage of a private API precludes the possibility of employing external graphical console clients, including FreeRDP-WebConnect, used to connect to Hyper-V instances via RDP. This change adds a public API method that wraps the aforementioned check_token private API. This allows external clients to obtain the necessary protocol connection information by providing a token previously obtained with calls to get_vnc_console, get_spice_console or get_rdp_console. Includes V2 and V3 API implementations. Change-Id: Idd1e4f57b16bd1488f3b72bb064cef51321a7c79		2014-02-28 22:05:29 +02:00
..
api_samples	Adds get_console_connect_info API	2014-02-28 22:05:29 +02:00
ext	Remove usage of locals() for formatting from nova.api.*	2013-05-18 00:04:17 +04:00
source	Replace oslo.sphinx with oslosphinx	2014-02-12 16:45:49 +00:00
v3/api_samples	Adds get_console_connect_info API	2014-02-28 22:05:29 +02:00
README.rst	Replace oslo.sphinx with oslosphinx	2014-02-12 16:45:49 +00:00

README.rst

OpenStack Nova Documentation README

Included documents:

developer reference guide(devref)
man pages

Dependencies

Building this documentation can be done in a regular Nova development environment, such as the virtualenv created by run_tests.sh or tools/install_venv.py. A leaner but sufficient environment can be created by starting with one that is suitable for running Nova (such as the one created by DevStack) and then using pip to install oslosphinx.

Building the docs

From the root nova directory:

python setup.py build_sphinx

Building just the man pages

from the root nova directory:

python setup.py build_sphinx -b man

Installing the man pages

After building the man pages, they can be found in doc/build/man/. You can install the man page onto your system by following the following steps:

Example for nova-scheduler:

mkdir /usr/local/man/man1
install -g 0 -o 0 -m 0644 doc/build/man/nova-scheduler.1  /usr/local/man/man1/nova-scheduler.1
gzip /usr/local/man/man1/nova-scheduler.1
man nova-scheduler