diff --git a/README.rst b/README.rst index b2462c008b..8c5f2effc8 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,13 @@ Ironic ====== -Ironic is an Incubated OpenStack project which aims to provision -bare metal machines instead of virtual machines, forked from the -Nova Baremetal driver. It is best thought of as a bare metal -hypervisor **API** and a set of plugins which interact with -the bare metal hypervisors. By default, it will use PXE and IPMI -in concert to provision and turn on/off machines, but Ironic -also supports vendor-specific plugins which may implement additional -functionality. +Ironic is an integrated OpenStack project which aims to provision bare +metal machines instead of virtual machines, forked from the Nova Baremetal +driver. It is best thought of as a bare metal hypervisor **API** and a set +of plugins which interact with the bare metal hypervisors. By default, it +will use PXE and IPMI in concert to provision and turn on/off machines, +but Ironic also supports vendor-specific plugins which may implement +additional functionality. ----------------- Project Resources diff --git a/doc/source/deploy/install-guide.rst b/doc/source/deploy/install-guide.rst index 08d3bc4756..c4451a578d 100644 --- a/doc/source/deploy/install-guide.rst +++ b/doc/source/deploy/install-guide.rst @@ -4,6 +4,10 @@ Bare Metal Service Installation Guide ===================================== +This document pertains to the Juno (2014.2) release of OpenStack. Users of +earlier releases may encounter some differences in configuration of services. + + Service Overview ================ diff --git a/doc/source/index.rst b/doc/source/index.rst index 38a1698fb8..4f5b700dcb 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,10 +5,10 @@ Welcome to Ironic's developer documentation! Introduction ============ -Ironic is an Incubated OpenStack project which aims to provision bare -metal (as opposed to virtual) machines by leveraging common technologies such -as PXE boot and IPMI to cover a wide range of hardware, while supporting -pluggable drivers to allow vendor-specific functionality to be added. +Ironic is an OpenStack project which provisions bare metal (as opposed to +virtual) machines by leveraging common technologies such as PXE boot and IPMI +to cover a wide range of hardware, while supporting pluggable drivers to allow +vendor-specific functionality to be added. If one thinks of traditional hypervisor functionality (eg, creating a VM, enumerating virtual devices, managing the power state, loading an OS onto the @@ -16,14 +16,9 @@ VM, and so on), then Ironic may be thought of as a *hypervisor API* gluing together multiple drivers, each of which implement some portion of that functionality with respect to physical hardware. -Ironic should be considered Beta quality as of the Icehouse release, and will -make the best effort to maintain backwards compatibility from this point -forward. Release notes are available here: -https://wiki.openstack.org/wiki/Ironic/ReleaseNotes/Icehouse - The developer documentation provided here is continually kept up-to-date based -on the latest code, and may not represent the state of our APIs at any given -release. +on the latest code, and may not represent the state of the project at any +specific prior release. Developer Guide ===============