From f08c4d53c03efe3e6564198466a677aff8a6c57e Mon Sep 17 00:00:00 2001 From: Julia Kreger Date: Thu, 9 Feb 2023 09:49:13 -0800 Subject: [PATCH] Enumerate retired specs We've been keeping a backlog of specs which are entirely outdated and will never be implemented. And we should also indicate when a specification document is no longer applicable at all. As such this change adds a retired folder, enumeration, and moves four documents to the retired folder to indcate they are no longer applicable to Ironic so end users have appropriate context should they discover the documents in the future. Change-Id: I1ab7d6726dc45283ca72df1df1d3c18e8ae8ea94 --- doc/source/index.rst | 18 ++++++++++++++++++ specs/approved/cisco-ucs-hw-inspection.rst | 5 +++++ .../cisco-ucs-oob-raid-configuration.rst | 7 +++++++ .../cisco-ucs-hw-inspection.rst | 0 .../cisco-ucs-oob-raid-configuration.rst | 0 specs/{backlog => retired}/openbmc-driver.rst | 7 ++++++- .../petitboot-boot-driver.rst | 5 +++++ 7 files changed, 41 insertions(+), 1 deletion(-) rename specs/{backlog => retired}/cisco-ucs-hw-inspection.rst (100%) rename specs/{backlog => retired}/cisco-ucs-oob-raid-configuration.rst (100%) rename specs/{backlog => retired}/openbmc-driver.rst (93%) rename specs/{backlog => retired}/petitboot-boot-driver.rst (97%) diff --git a/doc/source/index.rst b/doc/source/index.rst index 1a1216a3..97decbd4 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -422,6 +422,24 @@ Juno specs/approved/* + +Retired +======= + +These specifications are ideas and features which are no longer applicable. +They were either not implemented, no longer exist, and have generally been +superceeded either through the evolution of the project's capabilities or +the state in the marketplace. Each document listed below has been updated +to indicate the context as to why it was moved to this list. + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/retired/* + + + ================== Indices and tables ================== diff --git a/specs/approved/cisco-ucs-hw-inspection.rst b/specs/approved/cisco-ucs-hw-inspection.rst index 4cdf54c9..05d80565 100644 --- a/specs/approved/cisco-ucs-hw-inspection.rst +++ b/specs/approved/cisco-ucs-hw-inspection.rst @@ -14,6 +14,11 @@ This proposal adds the ability to inspect/update hardware properties and auto-create ports for Cisco UCS B/C/M-servers managed by Cisco UCS Manager. It uses out-of-band H/W inspection utility provided by UcsSdk. +.. NOTE:: + This specification has been retired as the vendor specific UCS driers are + no longer available in Ironic. This was a result of the Open Source + UcsSdk library no longer being maintained. + Problem description =================== diff --git a/specs/approved/cisco-ucs-oob-raid-configuration.rst b/specs/approved/cisco-ucs-oob-raid-configuration.rst index cb1267e8..4d048a53 100644 --- a/specs/approved/cisco-ucs-oob-raid-configuration.rst +++ b/specs/approved/cisco-ucs-oob-raid-configuration.rst @@ -14,6 +14,13 @@ This blueprint proposes to implement out-of-band RAID configuration interface for Cisco UCS drivers. This implementation supports configuration of Cisco UCS Manager (UCSM) managed B/C/M-series servers. +.. NOTE:: + This specification has been retired as the vendor specific UCS driers are + no longer available in Ironic. This was a result of the Open Source + UcsSdk library no longer being maintained. Users may wish to explore use + of the ``redfish`` driver, but it is unknown to the community if the UCS + Redfish support has been extended to RAID support. + Problem description =================== diff --git a/specs/backlog/cisco-ucs-hw-inspection.rst b/specs/retired/cisco-ucs-hw-inspection.rst similarity index 100% rename from specs/backlog/cisco-ucs-hw-inspection.rst rename to specs/retired/cisco-ucs-hw-inspection.rst diff --git a/specs/backlog/cisco-ucs-oob-raid-configuration.rst b/specs/retired/cisco-ucs-oob-raid-configuration.rst similarity index 100% rename from specs/backlog/cisco-ucs-oob-raid-configuration.rst rename to specs/retired/cisco-ucs-oob-raid-configuration.rst diff --git a/specs/backlog/openbmc-driver.rst b/specs/retired/openbmc-driver.rst similarity index 93% rename from specs/backlog/openbmc-driver.rst rename to specs/retired/openbmc-driver.rst index 34e22d40..acb96500 100644 --- a/specs/backlog/openbmc-driver.rst +++ b/specs/retired/openbmc-driver.rst @@ -13,6 +13,12 @@ https://bugs.launchpad.net/ironic/+bug/1634635 This proposal covers the addition of power and management interfaces for OpenBMC and the addition of driver to the IPA and PXE driver classes. +.. NOTE:: + This specification is no longer viewed as applicable as OpenBMC has support + for the Redfish API interface, and as such this is considered a superior + standards based interface for use. When this specificaiton was proposed, + These the Redfish API had not yet been implemented in OpenBMC. + Problem description =================== @@ -45,7 +51,6 @@ OpenBMCPower in it's 'supported_power_interfaces' list. This hardware type will also have OpenBMCManagement in it's 'supported_management_interfaces' list. - Alternatives ------------ diff --git a/specs/backlog/petitboot-boot-driver.rst b/specs/retired/petitboot-boot-driver.rst similarity index 97% rename from specs/backlog/petitboot-boot-driver.rst rename to specs/retired/petitboot-boot-driver.rst index 65b3fc58..7e610b04 100644 --- a/specs/backlog/petitboot-boot-driver.rst +++ b/specs/retired/petitboot-boot-driver.rst @@ -14,6 +14,11 @@ This adds petitboot boot driver for OpenPOWER servers. The OpenPOWER Foundation is a collaboration around Power Architecture products initiated by IBM. +.. NOTE:: + This specification has been retired as the IBM firmware maintainers + added support for the classical PXELinux file format. As such, this + specification is no longer needed. + Problem description ===================