summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2018-08-02 14:26:22 +0000
committerGerrit Code Review <review@openstack.org>2018-08-02 14:26:22 +0000
commitc93b3406b971b418ac5616912c19d2dbbc0cbc5f (patch)
tree3d48a0be69abaa2cd6ce3de9b5efea86a73c419c
parentdef2fc08aa0511a556c8b30a19dd31ad9cac2c07 (diff)
parentb0084cb872f786fd1c0e9dd2779574068339e46d (diff)
downloadironic-c93b3406b971b418ac5616912c19d2dbbc0cbc5f.tar.gz
Merge "Improve doc of Node serial console"
-rw-r--r--doc/source/admin/console.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/source/admin/console.rst b/doc/source/admin/console.rst
index ad30e5409..28cc1d6c1 100644
--- a/doc/source/admin/console.rst
+++ b/doc/source/admin/console.rst
@@ -222,4 +222,47 @@ If ``console_enabled`` is ``false`` or ``console_info`` is ``None`` then
the serial console is disabled. If you want to launch serial console, see the
``Configure node console``.
+Node serial console of the Bare Metal service is compatible with the
+serial console of the Compute service. Hence, serial consoles to
+Bare Metal nodes can be seen and interacted with via the Dashboard service.
+In order to achieve that, you need to follow the documentation for
+`Serial Console`_ from the Compute service.
+
+Configuring HA
+~~~~~~~~~~~~~~
+
+When using Bare Metal serial console under High Availability (HA)
+configuration, you may consider some settings below.
+
+* If you use HAProxy, you may need to set the timeout for both client
+ and server sides with appropriate values. Here is an example of the
+ configuration for the timeout parameter.
+
+ ::
+
+ frontend nova_serial_console
+ bind 192.168.20.30:6083
+ timeout client 10m # This parameter is necessary
+ use_backend nova_serial_console if <...>
+
+ backend nova_serial_console
+ balance source
+ timeout server 10m # This parameter is necessary
+ option tcpka
+ option tcplog
+ server controller01 192.168.30.11:6083 check inter 2000 rise 2 fall 5
+ server controller02 192.168.30.12:6083 check inter 2000 rise 2 fall 5
+
+* The Compute service's caching feature may need to be enabled in order
+ to make the Bare Metal serial console work under a HA configuration.
+ Here is an example of caching configuration in ``nova.conf``.
+
+ .. code-block:: ini
+
+ [cache]
+ enabled = true
+ backend = dogpile.cache.memcached
+ memcache_servers = memcache01:11211,memcache02:11211,memcache03:11211
+
.. _`socat`: http://www.dest-unreach.org/socat
+.. _`Serial Console`: https://docs.openstack.org/nova/latest/admin/remote-console-access.html#serial-console