blob: 0d98f4abad623f0a42124a1feb97922bc8d508a1 [file] [log] [blame]
Tony Breedsa339efc2014-12-04 16:52:58 +11001=================
2Nova and devstack
3=================
4
5This is a rough guide to various configuration parameters for nova
6running with devstack.
7
8
9nova-serialproxy
10================
11
12In Juno nova implemented a `spec
13<http://specs.openstack.org/openstack/nova-specs/specs/juno/implemented/serial-ports.html>`_
14to allow read/write access to the serial console of an instance via
15`nova-serialproxy
16<http://docs.openstack.org/developer/nova/man/nova-serialproxy.html>`_.
17
18The service can be enabled by adding ``n-sproxy`` to
19``ENABLED_SERVICES``. Further options can be enabled via
20``local.conf``, e.g.
21
22::
23
24 [[post-config|$NOVA_CONF]]
25 [serial_console]
26 #
27 # Options defined in nova.cmd.serialproxy
28 #
29
30 # Host on which to listen for incoming requests (string value)
31 #serialproxy_host=0.0.0.0
32
33 # Port on which to listen for incoming requests (integer
34 # value)
35 #serialproxy_port=6083
36
37
38 #
39 # Options defined in nova.console.serial
40 #
41
42 # Enable serial console related features (boolean value)
43 #enabled=false
44 # Do not set this manually. Instead enable the service as
45 # outlined above.
46
47 # Range of TCP ports to use for serial ports on compute hosts
48 # (string value)
49 #port_range=10000:20000
50
51 # Location of serial console proxy. (string value)
52 #base_url=ws://127.0.0.1:6083/
53
54 # IP address on which instance serial console should listen
55 # (string value)
56 #listen=127.0.0.1
57
58 # The address to which proxy clients (like nova-serialproxy)
59 # should connect (string value)
60 #proxyclient_address=127.0.0.1
61
62
63Enabling the service is enough to be functional for a single machine devstack.
64
65These config options are defined in `nova.console.serial
66<https://github.com/openstack/nova/blob/master/nova/console/serial.py#L33-L52>`_
67and `nova.cmd.serialproxy
68<https://github.com/openstack/nova/blob/master/nova/cmd/serialproxy.py#L26-L33>`_.
69
70For more information on OpenStack configuration see the `OpenStack
71Configuration Reference
72<http://docs.openstack.org/trunk/config-reference/content/list-of-compute-config-options.html>`_