Merge "Migrates docs from wiki"

4 files changed, 125 insertions, 3 deletions

diff --git a/releasenotes/source/icehouse.rst b/releasenotes/source/icehouse.rst
new file mode 100644
index 000000000..94ba1f6ae
--- /dev/null
+++ b/releasenotes/source/icehouse.rst
@@ -0,0 +1,33 @@
+===============================
+Icehouse (2014.1) Release Notes
+===============================
+
+Icehouse is the first release of the Ironic project that should be considered "a stable beta." Since there are no prior releases, this highlights the most significant difference between Ironic and nova-baremetal, and lists the major known issues at the time of the Icehouse release.
+
+Features
+========
+
+* Nodes are distributed using a consistent hash ring. Conductors automatically register/de-register on startup/shutdown. Operations are distributed automatically across the set of available conductors, with shared locking to prevent multiple conductors working on the same node at once. The hash ring rebalances automatically when conductors join/leave the cluster.
+* Heterogeneous hardware support. Multiple ironic-conductor services can be run in the same cluster. Each conductor loads drivers via python entrypoints, and does not necessarily need to load the same drivers as any other conductor service. Requests to manage hardware nodes will be routed to the appropriate conductor according to the node's "driver" property.
+  * Note: this does not refer to running nova-compute with multiple compute_drivers in a single AZ.
+* API exposes list of available drivers. The API exposes a list of supported drivers and the names of conductor hosts which provide service for them.
+* Maintenance mode allows an operator to take a node out of service (hide it from Nova) temporarily, eg. while performing some necessary maintenance task on it.
+* Hardware power state is periodically sync'd. By default, a periodic task will check the power state of all nodes, and force unprovisioned nodes' power status to OFF. Nodes whose state can not be checked / synced will be put in maintenance mode after a configurable number of retries.
+
+Known Issues
+============
+
+* The Nova "ironic" driver is not present in the Nova code base. Ironic must be installed (but not necessarily run) on the nova-compute hosts to provide the necessary libraries.
+* Serial-over-LAN console is not supported.None of the drivers in the Icehouse release support serial console, and the REST API is likely to change during Juno.
+* IPMI passwords are visible to users with cloud admin privileges, via Ironic's API.
+* Conductor services log an exception trace at startup if the python-seamicroclient library is not present. This can be safely ignored if you are not using the seamicro driver.
+* Nova does not pass ephemeral partition specifications to Ironic, even though the Ironic PXE driver supports ephemeral partitioning.
+* nova rebuild is not supported by the nova.virt.ironic driver.
+* API requests are not translated based on Accept-Language header.
+
+Upgrade Notes
+=============
+
+No tools are provided for a migration from nova-baremetal to Ironic at this time.
+
+As there was no prior release of Ironic, no version upgrade is possible.
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index ba00a8de0..c50338b66 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -19,6 +19,6 @@
    newton
    mitaka
    liberty
-   Kilo (2015.1) <https://wiki.openstack.org/wiki/Ironic/ReleaseNotes/Kilo>
-   Juno (2014.2) <https://wiki.openstack.org/wiki/Ironic/ReleaseNotes/Juno>
-   Icehouse (2014.1) <https://wiki.openstack.org/wiki/Ironic/ReleaseNotes/Icehouse>
+   kilo
+   juno
+   icehouse
diff --git a/releasenotes/source/juno.rst b/releasenotes/source/juno.rst
new file mode 100644
index 000000000..f7851a106
--- /dev/null
+++ b/releasenotes/source/juno.rst
@@ -0,0 +1,25 @@
+=============================================
+Juno Series (2014.2 - 2014.2.1) Release Notes
+=============================================
+
+Key Features
+============
+* The Nova "ironic" driver is in the Nova code base. In Icehouse, the Nova "ironic" driver was not in the Nova code base. Now that it is in the Nova code base, it is no longer necessary to install Ironic on the nova-compute hosts.
+  * nova rebuild is supported by the nova.virt.ironic driver
+  * however, the optional --preserve-ephemeral flag is not supported by "agent"-based deploy drivers.
+* IPMI sensor data can be emitted (eg to Ceilometer)
+* New hardware drivers: DRAC power & management driver, iLO power & virtual-media deploy driver, SNMP power driver, iBoot PDU power driver
+* New "agent" family of deploy drivers
+* Neutron dependency has been removed.
+  * It is possible to use an external static DHCP configuration with agent-based drivers (eg, agent_ipmitool) or no DHCP at all with iLO-based drivers (eg, agent_ilo and iscsi_ilo)
+* UEFI and iPXE boot support is available in some drivers
+* Serial-over-LAN console is supported. The IPMItool and NativeIPMI drivers support serial console.
+
+Known Issues
+============
+
+* IPMI passwords are visible to users with cloud admin privileges, via Ironic's API.
+* Running more than one nova-compute process is not officially supported. While Ironic does include a ClusteredComputeManager, which allows running more than one nova-compute process with Ironic, it should be considered experimental and has many known problems.
+* Drivers using the "agent" deploy mechanism differ in their functionality from those using the "pxe" deploy mechanism in the following ways:
+  * agent requires a whole-disk image, and does not support "rebuild --preserve-ephemeral"; "pxe" requires a partition image, and supports "rebuild --preserve-ephemeral"
+  * nodes deployed by the "agent" drivers will boot from the local disk; nodes deployed by the "pxe" drivers can not boot from local disk, and will always require a net boot (whether via pxe, ipxe, or virtual-media)
diff --git a/releasenotes/source/kilo.rst b/releasenotes/source/kilo.rst
new file mode 100644
index 000000000..92ecc15d0
--- /dev/null
+++ b/releasenotes/source/kilo.rst
@@ -0,0 +1,64 @@
+===============================================
+Kilo Series (2015.1.0 - 2015.1.4) Release Notes
+===============================================
+
+Features
+========
+
+State Machine
+-------------
+
+* Ironic now uses a formal model for the logical state of each node it manages (New Ironic State Machine). This has enabled the addition of two new processes: cleaning and inspection.
+* Automatic disk erasure between tenants is now enabled by default. This may be extended to perform additional cleaning steps, such as re-applying firmware, resetting BIOS settings, etc (Node Cleaning).
+* Both in-band and out-of-band methods are available to inspect hardware. These methods may be used to update Node properties automatically (Hardware Inspection).
+
+Version Headers
+---------------
+
+The Ironic REST API expects a new X-OpenStack-Ironic-API-Version header be passed with each HTTP[S] request. This header allows client and server to negotiate a mutually supported interface (REST API "micro" versions). In the absence of this header, the REST service will default to a compatibility mode and yield responses compatible with Juno clients. This mode, however, prevents access to most features introduced in Kilo.
+
+Hardware Driver Changes
+=======================
+The following new drivers were added:
+
+* AMT
+* iRMC
+* VirtualBox (testing driver only)
+
+The following enhancements were made to existing drivers:
+
+* Configdrives may be used with the "agent" drivers in lieu of a metadata service, if desired.
+* SeaMicro driver supports serial console
+* iLO driver supports UEFI secure boot
+* iLO driver supports out-of-band node inspection
+* iLO driver supports resetting ilo and bios during cleaning
+
+Support for third-party and out-of-tree drivers is enhanced by the following two changes:
+
+* Drivers may store their own "internal" information about Nodes.
+* Drivers may register their own periodic tasks to be run by the Conductor.
+* vendor_passthru methods now support additional HTTP methods (eg, PUT and POST).
+* vendor_passthru methods are now discoverable in the REST API. See node vendor passthru and driver vendor passthru
+
+Other Changes
+-------------
+
+* Logical names may be used to address Nodes, in addition to their canonical UUID.
+* For servers with varied local disks, hints may be supplied that affect which disk device the OS is provisioned to.
+* Support for fetching kernel, ramdisk, and instance images from HTTP[S] sources directly has been added to remove the dependency on Glance. Using ironic as a standalone service
+* Nodes may be placed into maintenance mode via REST API calls. An optional maintenance reason may be specified when doing so.
+
+Known Issues
+============
+
+* Running more than one nova-compute process is not officially supported.
+* While Ironic does include a ClusteredComputeManager, which allows running more than one nova-compute process with Ironic, it should be considered experimental and has many known problems.
+* Drivers using the "agent" deploy mechanism do not support "rebuild --preserve-ephemeral"
+
+Upgrade Notes
+=============
+
+* IPMI Passwords are now obfuscated in REST API responses. This may be disabled by changing API policy settings.
+* The "agent" class of drivers now support both whole-disk and partition based images.
+* The driver_info parameters of "pxe_deploy_kernel" and "pxe_deploy_ramdisk" are deprecated in favour of "deploy_kernel" and "deploy_ramdisk".
+* Drivers implementing their own version of the vendor_passthru() method has been deprecated in favour of the new @passthru decorator.