Merge "Move console documentation to separate file"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
77875d6aca
135
doc/source/deploy/console.rst
Normal file
135
doc/source/deploy/console.rst
Normal file
@ -0,0 +1,135 @@
|
||||
.. _console:
|
||||
|
||||
Configure node web console
|
||||
--------------------------
|
||||
|
||||
The web console can be configured in Bare Metal service in the following way:
|
||||
|
||||
* Install shellinabox in ironic conductor node. For RHEL/CentOS, shellinabox package
|
||||
is not present in base repositories, user must enable EPEL repository, you can find
|
||||
more from `FedoraProject page`_.
|
||||
|
||||
Installation example::
|
||||
|
||||
Ubuntu:
|
||||
sudo apt-get install shellinabox
|
||||
|
||||
Fedora 21/RHEL7/CentOS7:
|
||||
sudo yum install shellinabox
|
||||
|
||||
Fedora 22 or higher:
|
||||
sudo dnf install shellinabox
|
||||
|
||||
You can find more about shellinabox on the `shellinabox page`_.
|
||||
|
||||
You can optionally use the SSL certificate in shellinabox. If you want to use the SSL
|
||||
certificate in shellinabox, you should install openssl and generate the SSL certificate.
|
||||
|
||||
1. Install openssl, for example::
|
||||
|
||||
Ubuntu:
|
||||
sudo apt-get install openssl
|
||||
|
||||
Fedora 21/RHEL7/CentOS7:
|
||||
sudo yum install openssl
|
||||
|
||||
Fedora 22 or higher:
|
||||
sudo dnf install openssl
|
||||
|
||||
2. Generate the SSL certificate, here is an example, you can find more about openssl on
|
||||
the `openssl page`_::
|
||||
|
||||
cd /tmp/ca
|
||||
openssl genrsa -des3 -out my.key 1024
|
||||
openssl req -new -key my.key -out my.csr
|
||||
cp my.key my.key.org
|
||||
openssl rsa -in my.key.org -out my.key
|
||||
openssl x509 -req -days 3650 -in my.csr -signkey my.key -out my.crt
|
||||
cat my.crt my.key > certificate.pem
|
||||
|
||||
* Customize the console section in the Bare Metal service configuration
|
||||
file (/etc/ironic/ironic.conf), if you want to use SSL certificate in
|
||||
shellinabox, you should specify ``terminal_cert_dir``.
|
||||
for example::
|
||||
|
||||
[console]
|
||||
|
||||
#
|
||||
# Options defined in ironic.drivers.modules.console_utils
|
||||
#
|
||||
|
||||
# Path to serial console terminal program (string value)
|
||||
#terminal=shellinaboxd
|
||||
|
||||
# Directory containing the terminal SSL cert(PEM) for serial
|
||||
# console access (string value)
|
||||
terminal_cert_dir=/tmp/ca
|
||||
|
||||
# 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
|
||||
|
||||
* 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
|
||||
|
||||
* Configure node web console.
|
||||
|
||||
Enable the web console, for example::
|
||||
|
||||
ironic node-update <node-uuid> add driver_info/<terminal_port>=<customized_port>
|
||||
ironic node-set-console-mode <node-uuid> true
|
||||
|
||||
Check whether the console is enabled, for example::
|
||||
|
||||
ironic node-validate <node-uuid>
|
||||
|
||||
Disable the web console, for example::
|
||||
|
||||
ironic node-set-console-mode <node-uuid> false
|
||||
ironic node-update <node-uuid> remove driver_info/<terminal_port>
|
||||
|
||||
The ``<terminal_port>`` is driver dependent. The actual name of this field can be
|
||||
checked in driver properties, for example::
|
||||
|
||||
ironic driver-properties <driver>
|
||||
|
||||
For ``*_ipmitool`` and ``*_ipminative`` drivers, this option is ``ipmi_terminal_port``.
|
||||
For ``seamicro`` driver, this option is ``seamicro_terminal_port``. Give a customized port
|
||||
number to ``<customized_port>``, for example ``8023``, this customized port is used in
|
||||
web console url.
|
||||
|
||||
* Get web console information::
|
||||
|
||||
ironic node-get-console <node-uuid>
|
||||
+-----------------+----------------------------------------------------------------------+
|
||||
| Property | Value |
|
||||
+-----------------+----------------------------------------------------------------------+
|
||||
| console_enabled | True |
|
||||
| console_info | {u'url': u'http://<url>:<customized_port>', u'type': u'shellinabox'} |
|
||||
+-----------------+----------------------------------------------------------------------+
|
||||
|
||||
You can open web console using above ``url`` through web browser. If ``console_enabled`` is
|
||||
``false``, ``console_info`` is ``None``, web console is disabled. If you want to launch web
|
||||
console, refer to ``Enable web console`` part.
|
||||
|
||||
.. _`shellinabox page`: https://code.google.com/p/shellinabox/
|
||||
.. _`openssl page`: https://www.openssl.org/
|
||||
.. _`FedoraProject page`: https://fedoraproject.org/wiki/Infrastructure/Mirroring
|
||||
@ -1218,136 +1218,7 @@ Telemetry, they are:
|
||||
Configure node web console
|
||||
--------------------------
|
||||
|
||||
The web console can be configured in Bare Metal service in the following way:
|
||||
|
||||
* Install shellinabox in ironic conductor node. For RHEL/CentOS, shellinabox package
|
||||
is not present in base repositories, user must enable EPEL repository, you can find
|
||||
more from `FedoraProject page`_.
|
||||
|
||||
Installation example::
|
||||
|
||||
Ubuntu:
|
||||
sudo apt-get install shellinabox
|
||||
|
||||
Fedora 21/RHEL7/CentOS7:
|
||||
sudo yum install shellinabox
|
||||
|
||||
Fedora 22 or higher:
|
||||
sudo dnf install shellinabox
|
||||
|
||||
You can find more about shellinabox on the `shellinabox page`_.
|
||||
|
||||
You can optionally use the SSL certificate in shellinabox. If you want to use the SSL
|
||||
certificate in shellinabox, you should install openssl and generate the SSL certificate.
|
||||
|
||||
1. Install openssl, for example::
|
||||
|
||||
Ubuntu:
|
||||
sudo apt-get install openssl
|
||||
|
||||
Fedora 21/RHEL7/CentOS7:
|
||||
sudo yum install openssl
|
||||
|
||||
Fedora 22 or higher:
|
||||
sudo dnf install openssl
|
||||
|
||||
2. Generate the SSL certificate, here is an example, you can find more about openssl on
|
||||
the `openssl page`_::
|
||||
|
||||
cd /tmp/ca
|
||||
openssl genrsa -des3 -out my.key 1024
|
||||
openssl req -new -key my.key -out my.csr
|
||||
cp my.key my.key.org
|
||||
openssl rsa -in my.key.org -out my.key
|
||||
openssl x509 -req -days 3650 -in my.csr -signkey my.key -out my.crt
|
||||
cat my.crt my.key > certificate.pem
|
||||
|
||||
* Customize the console section in the Bare Metal service configuration
|
||||
file (/etc/ironic/ironic.conf), if you want to use SSL certificate in
|
||||
shellinabox, you should specify ``terminal_cert_dir``.
|
||||
for example::
|
||||
|
||||
[console]
|
||||
|
||||
#
|
||||
# Options defined in ironic.drivers.modules.console_utils
|
||||
#
|
||||
|
||||
# Path to serial console terminal program (string value)
|
||||
#terminal=shellinaboxd
|
||||
|
||||
# Directory containing the terminal SSL cert(PEM) for serial
|
||||
# console access (string value)
|
||||
terminal_cert_dir=/tmp/ca
|
||||
|
||||
# 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
|
||||
|
||||
* 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
|
||||
|
||||
* Configure node web console.
|
||||
|
||||
Enable the web console, for example::
|
||||
|
||||
ironic node-update <node-uuid> add driver_info/<terminal_port>=<customized_port>
|
||||
ironic node-set-console-mode <node-uuid> true
|
||||
|
||||
Check whether the console is enabled, for example::
|
||||
|
||||
ironic node-validate <node-uuid>
|
||||
|
||||
Disable the web console, for example::
|
||||
|
||||
ironic node-set-console-mode <node-uuid> false
|
||||
ironic node-update <node-uuid> remove driver_info/<terminal_port>
|
||||
|
||||
The ``<terminal_port>`` is driver dependent. The actual name of this field can be
|
||||
checked in driver properties, for example::
|
||||
|
||||
ironic driver-properties <driver>
|
||||
|
||||
For ``*_ipmitool`` and ``*_ipminative`` drivers, this option is ``ipmi_terminal_port``.
|
||||
For ``seamicro`` driver, this option is ``seamicro_terminal_port``. Give a customized port
|
||||
number to ``<customized_port>``, for example ``8023``, this customized port is used in
|
||||
web console url.
|
||||
|
||||
* Get web console information::
|
||||
|
||||
ironic node-get-console <node-uuid>
|
||||
+-----------------+----------------------------------------------------------------------+
|
||||
| Property | Value |
|
||||
+-----------------+----------------------------------------------------------------------+
|
||||
| console_enabled | True |
|
||||
| console_info | {u'url': u'http://<url>:<customized_port>', u'type': u'shellinabox'} |
|
||||
+-----------------+----------------------------------------------------------------------+
|
||||
|
||||
You can open web console using above ``url`` through web browser. If ``console_enabled`` is
|
||||
``false``, ``console_info`` is ``None``, web console is disabled. If you want to launch web
|
||||
console, refer to ``Enable web console`` part.
|
||||
|
||||
.. _`shellinabox page`: https://code.google.com/p/shellinabox/
|
||||
.. _`openssl page`: https://www.openssl.org/
|
||||
.. _`FedoraProject page`: https://fedoraproject.org/wiki/Infrastructure/Mirroring
|
||||
See :ref:`console`.
|
||||
|
||||
.. _boot_mode_support:
|
||||
|
||||
|
||||
@ -41,6 +41,7 @@ Administrator's Guide
|
||||
deploy/multitenancy
|
||||
deploy/raid
|
||||
deploy/inspection
|
||||
deploy/console
|
||||
deploy/security
|
||||
deploy/adoption
|
||||
deploy/api-audit-support
|
||||
|
||||
Loading…
Reference in New Issue
Block a user