diff options
| author | daz <dazzachan@yahoo.com.au> | 2016-08-15 14:07:52 +1000 |
|---|---|---|
| committer | daz <dazzachan@yahoo.com.au> | 2016-08-17 09:11:58 +1000 |
| commit | 4e573f972d8b059bacfcf8a538424dfe70af3970 (patch) | |
| tree | cdfdb795ce9eaf304ce93471d9e2bd57568add50 /README.rst | |
| parent | 5987c6f9c8a53e98d5a2850cdb8937cff231b103 (diff) | |
| download | ironic-4e573f972d8b059bacfcf8a538424dfe70af3970.tar.gz | |
Update readme file
Minor edits to the readme file
Change-Id: I5ac6d78950a142ba3bac2b0b9595f1f3425f3b22
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 37 |
1 files changed, 18 insertions, 19 deletions
diff --git a/README.rst b/README.rst index 8371aa354..2b31fb0f8 100644 --- a/README.rst +++ b/README.rst @@ -1,30 +1,29 @@ +====== Ironic ====== -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 together to provision and turn on/off machines, -but Ironic also supports vendor-specific plugins which may implement -additional functionality. +Ironic consists of an API and plug-ins for managing and provisioning +physical machines in a security-aware and fault-tolerant manner. It can be +used with nova as a hypervisor driver, or standalone service using bifrost. +By default, it will use PXE and IPMI to interact with bare metal machines. +Ironic also supports vendor-specific plug-ins which may implement additional +functionality. + +Ironic is distributed under the terms of the Apache License, Version 2.0. The +full terms and conditions of this license are detailed in the LICENSE file. ------------------ -Project Resources ------------------ +Project resources +~~~~~~~~~~~~~~~~~ -* Free software: Apache license * Documentation: http://docs.openstack.org/developer/ironic * Source: http://git.openstack.org/cgit/openstack/ironic * Bugs: http://bugs.launchpad.net/ironic * Wiki: https://wiki.openstack.org/wiki/Ironic +* APIs: http://developer.openstack.org/api-ref/baremetal/index.html -Project status, bugs and RFEs (requests for feature enhancements) -are tracked on Launchpad: - - http://launchpad.net/ironic - -Anyone wishing to contribute to an OpenStack project should -find a good reference here: +Project status, bugs, and requests for feature enhancements (RFEs) are tracked +on Launchpad: +http://launchpad.net/ironic - http://docs.openstack.org/infra/manual/developers.html +For information on how to contribute to ironic, see +http://docs.openstack.org/infra/manual/developers.html |