openstack
/
ironic-specs
Code Issues Proposed changes

Fix Nova-compatible Serial Console's Other deployer impact 

This is a follow-up patch of 75290c72f7
adds explanation about config option [console]terminal
and remove detail config file part.

Change-Id: I295ddd245e6bf4e7d132d3772f5b0465dec80227
Related-Bug: #1553083
This commit is contained in:
Yuiko Takada Mori 2016-06-29 17:39:59 +09:00 committed by Yuiko Takada Mori
parent 107403abc4
commit 0457a87dc6
1 changed files with 12 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
specs/approved/nova-compatible-serial-console.rst
View File

@ -164,40 +164,20 @@ To use socat serial console, deployer needs to specify new driver.
For example, to use PXE + IPMItool + socat, specify ``pxe_ipmitool_socat``.
To use IPA + IPMItool + socat, specify ``agent_ipmitool_socat``.
To use existing shellinabox console, deployer doesn't need to change anything.
We will implement new driver ``IPMISocatConsole`` initially, so that just
``pxe_ipmitool_socat`` and ``agent_ipmitool_socat`` drivers will support socat
console. After ``Driver composition reform`` [#]_ is implemented, this feature
will be available for a lot more drivers (or hardware types).
About configuration options, existing options ``terminal``,
``terminal_pid_dir``, ``subprocess_checking_interval``, ``subprocess_timeout``
are available for socat in the same way as shellinabox.
The new console interface ``IPMISocatConsole`` will be supported by two
new drivers: ``pxe_ipmitool_socat`` and ``agent_ipmitool_socat``.
After ``Driver composition reform`` [#]_ is implemented, this
feature will be available for a lot more drivers (or hardware types).
About configuration options, existing options ``terminal_pid_dir``,
``subprocess_checking_interval``, ``subprocess_timeout`` are available for
socat in the same way as shellinabox.
``terminal_cert_dir`` is not used in the case of socat because SSL is not
supported.
To use socat, .conf file will be::
[console]
# Path to serial console terminal program. "shellinaboxd"
# provides stand-alone web console. "socat" provides
# Nova-compatible serial console. Notes that only
# a few drivers support "socat". (string value)
terminal = shellinaboxd
# Directory containing the terminal SSL cert(PEM) for serial
# console access. Notes that only Shellinabox console uses
# this value. (string value)
terminal_cert_dir = <None>
# Directory for holding terminal pid files. If not specified,
# the temporary directory will be used. (string value)
terminal_pid_dir = <None>
# Time interval (in seconds) for checking the status of
# console subprocess. (integer value)
subprocess_checking_interval = 1
# Time (in seconds) to wait for the console subprocess to
# start. (integer value)
subprocess_timeout = 10
``terminal`` is not used in the case of socat because hard-coded ``socat`` is
used in the code, and absolute path is not needed because it's distro specific,
in Ubuntu for example it's ``/usr/bin/socat``, but it might be different in
other distros.
Developer impact
----------------