[doc] Add note about shellinabox console enable error

Enabling the console after configuring shellinabox may fail if
previous shellinabox daemons are blocking the configured port.
Add a note about this potential issue.

Change-Id: I7439952643bd78b59e829b198a1dd2338865c323
This commit is contained in:
Arne Wiebalck 2022-01-07 10:33:57 +01:00
parent d3ccd4d3a9
commit 6b5fcf8f4f
1 changed files with 11 additions and 0 deletions

View File

@ -151,6 +151,17 @@ The web console can be configured in Bare Metal service in the following way:
``false``, ``console_info`` is ``None``, web console is disabled. If you want to launch web
console, see the ``Configure node web console`` part.
.. note::
An error message you may encounter when enabling the console can read
``Console subprocess failed to start. Timeout or error while waiting for
console subprocess to start for node`` along with
``[server] Failed to find any available port!``. This error is coming from
shellinabox itself, not from the communication with the BMC. One potential
cause for this issue is that there are already shellinabox daemons running
which block the configured port (remove them if appropriate and retry to
enable the console).
.. _`shellinabox page`: https://code.google.com/archive/p/shellinabox/
.. _`openssl page`: https://www.openssl.org/
.. _`FedoraProject page`: https://fedoraproject.org/wiki/Infrastructure/Mirroring