openstack
/
ironic-inspector
Code Issues Proposed changes

Updated README

This commit is contained in:
Dmitry Tantsur 2014-10-08 11:46:46 +02:00
parent 9237f1b906
commit d7dbad5ea6
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.rst
View File

@ -4,6 +4,17 @@ Hardware properties discovery for OpenStack Ironic
.. image:: https://travis-ci.org/Divius/ironic-discoverd.svg?branch=master
:target: https://travis-ci.org/Divius/ironic-discoverd
This is an auxiliary service for discovering basic hardware properties for a
node managed by OpenStack Ironic. It fulfills the following tasks:
* Initiating discovery for given nodes.
* Managing iptables settings to allow/deny access to PXE boot server (usually
dnsmasq) for nodes under discovery.
* Receiving and processing data from discovery ramdisk booted on a node.
Starting dnsmasq and configuring PXE boot environment is not part of this
package and should be done separately.
Running
-------
@ -35,8 +46,8 @@ HTTP API consist of 2 endpoints:
Right now this endpoint is not authenticated. It will switch to
OpenStack authentication in the near future.
* ``/v1/continue`` intertnal endpoint for the discovery ramdisk to post back
discovered data. Should not be used fofr anything other than implementing
* ``/v1/continue`` internal endpoint for the discovery ramdisk to post back
discovered data. Should not be used for anything other than implementing
the ramdisk. Request body: JSON dictionary with keys:
* ``cpus`` number of CPU