From a464aa41ce8186617835ea527f40fc30ffe870ba Mon Sep 17 00:00:00 2001 From: Devananda van der Veen Date: Tue, 25 Aug 2015 12:02:25 -0700 Subject: [PATCH] Add release notes for 4.0.0 Add release notes for 4.0.0 to doc tree, updating the index.html page with reference to the new release notes. Include a symlink in the base dir so packagers can find RELEASE-NOTES Co-Authored-By: Ruby Loo Change-Id: I1a161b2c1d1e27268065b6b4be24c8f7a5315afb --- RELEASE-NOTES | 1 + doc/source/index.rst | 6 +++ doc/source/releasenotes/index.rst | 84 +++++++++++++++++++++++++++++++ 3 files changed, 91 insertions(+) create mode 120000 RELEASE-NOTES create mode 100644 doc/source/releasenotes/index.rst diff --git a/RELEASE-NOTES b/RELEASE-NOTES new file mode 120000 index 0000000000..9d8e8027dc --- /dev/null +++ b/RELEASE-NOTES @@ -0,0 +1 @@ +doc/source/releasenotes/index.rst \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index 72c150f6b6..8ad6c3aca3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -20,6 +20,12 @@ The developer documentation provided here is continually kept up-to-date based on the latest code, and may not represent the state of the project at any specific prior release. +For information on any current or prior version of Ironic, see `the release +notes`_ and `the wiki pages`_. + +.. _the release notes: releasenotes/index.html +.. _the wiki pages: https://wiki.openstack.org/wiki/Ironic/ReleaseNotes + Admin Guide =========== diff --git a/doc/source/releasenotes/index.rst b/doc/source/releasenotes/index.rst new file mode 100644 index 0000000000..1fa08f1a82 --- /dev/null +++ b/doc/source/releasenotes/index.rst @@ -0,0 +1,84 @@ +============= +Release Notes +============= + +4.0.0 First semver release +============================ + +This is the first semver-versioned release of Ironic, created during the +OpenStack "Liberty" development cycle. It marks a pivot in our +versioning schema from date-based versioning; the previous released +version was 2015.1. Full release details are available on Launchpad: +https://launchpad.net/ironic/liberty/4.0.0. + +* Raised API version to 1.11 + + - v1.7 exposes a new 'clean_step' property on the Node resource. + - v1.8 and v1.9 improve query and filter support + - v1.10 fixes Node logical names to support all `RFC 3986`_ unreserved + characters + - v1.11 changes the default state of newly created Nodes from AVAILABLE to + ENROLL + +* Support for the new ENROLL workflow during Node creation + + Previously, all Nodes were created in the "available" provision state - before + management credentials were validated, hardware was burned in, etc. This could + lead to workloads being scheduled to Nodes that were not yet ready for it. + + Beginning with API v1.11, newly created Nodes begin in the ENROLL state, + and must be "managed" and "provided" before they are made available for + provisioning. API clients must be updated to handle the new workflow when they + begin sending the X-OpenStack-Ironic-API-Version header with a value >= 1.11. + +* Migrations from Nova "baremetal" have been removed + + After a deprecation period, the scripts and support for migrating from + the old Nova "baremetal" driver to the new Nova "ironic" driver have + been removed from Ironic's tree. + +* Removal of deprecated vendor driver methods + + A new @passthru decorator was introduced to the driver API in a previous + release. In this release, support for vendor_passthru and + driver_vendor_passthru methods has been removed. All in-tree drivers have + been updated. Any out of tree drivers which did not update to the + @passthru decorator during the previous release will need to do so to be + compatible with this release. + +* Introduce new BootInterface to the Driver API + + Drivers may optionally add a new BootInterface. This is merely a + refactoring of the Driver API to support future improvements. + +* Several hardware drivers have been added or enhanced + + - Add OCS Driver + - Add UCS Driver + - Add Wake-On-Lan Power Driver + - ipmitool driver supports IPMI v1.5 + - Add support to SNMP driver for "APC MasterSwitchPlus" series PDU's + - pxe_ilo driver now supports UEFI Secure Boot (previous releases of the + iLO driver only supported this for agent_ilo and iscsi_ilo) + - Add Virtual Media support to iRMC Driver + - Add BIOS config to DRAC Driver + - PXE drivers now support GRUB2 + + +2015.1.0 OpenStack "Kilo" Release +==================================== + +Release notes: https://wiki.openstack.org/wiki/ReleaseNotes/Kilo#OpenStack_Bare_Metal_service_.28Ironic.29 + + +2014.2.0 OpenStack "Juno" Release +==================================== + +Release notes: https://wiki.openstack.org/wiki/Ironic/ReleaseNotes/Juno + +2014.1.0 OpenStack "Icehouse" Release +======================================== + +Release notes: https://wiki.openstack.org/wiki/Ironic/ReleaseNotes/Icehouse + +.. _`RFC 3986`: https://www.ietf.org/rfc/rfc3986.txt