openstack/ironic
Code Issues Proposed changes

Help a user to enable console redirection

Browse Source 
Updated documentation for kernel boot parameters in
install guide. Erased redundant information in deploy console part.
As these kernel parameters cannot be just force default option, let's
allow the user to do it just pointing to appropriate actions.

Change-Id: Ibd929c711d86480c5d7634ab2d5c7aed5043ee37
Related-Bug: 1417422
This commit is contained in:
Galyna Zholtkevych 2016-10-10 17:53:07 +03:00 committed by Sam Betts
parent a82d657635
commit be93eea434
2 changed files with 43 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/source/deploy/console.rst
View File

@ -91,17 +91,8 @@ The web console can be configured in Bare Metal service in the following way:
#subprocess_timeout=10
* Append console parameters for bare metal PXE boot in the Bare Metal service
configuration file (/etc/ironic/ironic.conf), including right serial port
terminal and serial speed, serial speed should be same serial configuration
with BIOS settings, so that os boot process can be seen in web console,
for example::
pxe_* driver:
[pxe]
#Additional append parameters for bare metal PXE boot. (string value)
pxe_append_params = nofb nomodeset vga=normal console=tty0 console=ttyS0,115200n8
configuration file (/etc/ironic/ironic.conf). See the reference for
configuration in `console kernel parameters`_.
* Configure node web console.
@ -174,21 +165,9 @@ Serial consoles can be configured in the Bare Metal service as follows:
Fedora 22 or higher:
sudo dnf install socat
* Append ``console`` parameters for bare metal PXE boot in the Bare Metal
service configuration file
(``[pxe]`` section in ``/etc/ironic/ironic.conf``),
including the serial port terminal and serial speed. Serial speed must be
the same as the serial configuration in the BIOS settings, so that the
operating system boot process can be seen in the serial console.
In the following example, the console parameter 'console=ttyS0,115200n8'
uses ttyS0 for console output at 115200bps, 8bit, non-parity::
pxe_* driver:
[pxe]
#Additional append parameters for bare metal PXE boot. (string value)
pxe_append_params = nofb nomodeset vga=normal console=ttyS0,115200n8
* Append console parameters for bare metal PXE boot in the Bare Metal
service configuration file. See the reference on how to configure them in
`console kernel parameters`_.
* Configure node console.
@ -222,3 +201,4 @@ the serial console is disabled. If you want to launch serial console, see the
``Configure node console``.
.. _`socat`: http://www.dest-unreach.org/socat
.. _`console kernel parameters`: https://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#appending-kernel-parameters-to-boot-instances

37
install-guide/source/include/kernel-boot-parameters.rst
View File

@ -67,3 +67,40 @@ to fit their use case:
os.remove(old_grub_file)
os.system('update-grub')
os.system('reboot')
Console
=======
In order to change default console configuration in the Bare Metal
service configuration file (``[pxe]`` section in ``/etc/ironic/ironic.conf``),
include the serial port terminal and serial speed. Serial speed must be
the same as the serial configuration in the BIOS settings, so that the
operating system boot process can be seen in the serial console or web console.
Following examples represent possible parameters for serial and web console
respectively.
* Node serial console. The console parameter ``console=ttyS0,115200n8``
uses ``ttyS0`` for console output at ``115200bps, 8bit, non-parity``, e.g.::
[pxe]
# Additional append parameters for baremetal PXE boot.
pxe_append_params = nofb nomodeset vga=normal console=ttyS0,115200n8
* For node web console configuration is similar with the addition of ``ttyX``
parameter, see example::
[pxe]
# Additional append parameters for baremetal PXE boot.
pxe_append_params = nofb nomodeset vga=normal console=tty0 console=ttyS0,115200n8
For detailed information on how to add consoles see the reference documents
`kernel params`_ and `serial console`_.
In case of local boot the Bare Metal service is not able to control kernel boot
parameters. To configure console locally, follow 'Local boot' section above.
.. _`kernel params`: https://www.kernel.org/doc/Documentation/kernel-parameters.txt
.. _`serial console`: https://www.kernel.org/doc/Documentation/serial-console.txt