deprecate shellinabox

Shellinabox hasn't received an update in 7 years.
Debian recently asked for maintainership to be handed over due to
open issue counts and lack of responses.

All sorts of open issues exist. It appears branches were deleted
in late 2024, forks still have them though.

Basically, looks like shellinabox is abandoned, and we should
treat it as such and abandon support in Ironic.

Change-Id: I5704e1a6a6a816e1cca3b5d0c791eed030cfc563
This commit is contained in:
Julia Kreger 2025-02-18 08:18:39 -08:00
parent 676b8c69ac
commit 449bc1a825
3 changed files with 23 additions and 5 deletions

View File

@ -20,12 +20,14 @@ The web console can be configured in Bare Metal service in the following way:
is not present in base repositories, the user must enable EPEL repository, you can
find more from `FedoraProject page`_.
.. note::
.. warning::
shellinabox is no longer maintained by the authorized author.
`This <https://github.com/shellinabox/shellinabox>`_ is a fork of the
project on GitHub that aims to continue with the maintenance of the
shellinabox project.
Shell In A Box is considered abandoned by the Ironic community. The
original maintainer stopped maintaining the project and the project
was thus forked. The resulting
`fork <https://github.com/shellinabox/shellinabox>`_ has not received
updates in a number of years and is considered abandoned.
As such, shellinabox support has been deprecated by the Ironic community.
Installation example:

View File

@ -1606,6 +1606,14 @@ class IPMIConsole(base.ConsoleInterface):
class IPMIShellinaboxConsole(IPMIConsole):
"""A ConsoleInterface that uses ipmitool and shellinabox."""
# TODO(TheJulia): This interface is deprecated due to the shellinabox
# project being abandoned. It should be removed after the release of
# 2025.2 in advance of 2026.1's release.
# https://github.com/shellinabox/shellinabox
# https://github.com/shellinabox/shellinabox/issues/531
supported = False
def _get_ipmi_cmd(self, driver_info, pw_file):
"""Get ipmi command for ipmitool usage.

View File

@ -0,0 +1,8 @@
---
deprecations:
- |
Use of the console driver ``ipmitool-shellinabox`` has been deprecated and
will be removed in a future release of Ironic. This decision was reached
with the reality that the fork of shellinabox appears abandoned with no
changes in 7 years and open issues to call for the project to hand over
`maintainership <https://github.com/shellinabox/shellinabox/issues/531>`_.