From 6b5fcf8f4f7db8c2f1f0f30577566c1d8660202e Mon Sep 17 00:00:00 2001 From: Arne Wiebalck <Arne.Wiebalck@cern.ch> Date: Fri, 7 Jan 2022 10:33:57 +0100 Subject: [PATCH] [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 --- doc/source/admin/console.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/source/admin/console.rst b/doc/source/admin/console.rst index b3fcd91f7f..618bb56dbe 100644 --- a/doc/source/admin/console.rst +++ b/doc/source/admin/console.rst @@ -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