ironic-inspector/README.rst
shangxiaobj d0edef14f1 Replace http with https for doc links
Use https instead of http for docs links in ironic-inspector

Change-Id: Ibc6700af5114ef64d3fe9803a4433d19b1223456
2018-01-02 06:25:34 +00:00

38 lines
1.5 KiB
ReStructuredText

===============================================
Hardware introspection for OpenStack Bare Metal
===============================================
Introduction
============
.. image:: https://governance.openstack.org/tc/badges/ironic-inspector.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
This is an auxiliary service for discovering hardware properties for a
node managed by `Ironic`_. Hardware introspection or hardware
properties discovery is a process of getting hardware parameters required for
scheduling from a bare metal node, given it's power management credentials
(e.g. IPMI address, user name and password).
* Free software: Apache license
* Source: https://git.openstack.org/cgit/openstack/ironic-inspector
* Bugs: https://bugs.launchpad.net/ironic-inspector
* Downloads: https://pypi.python.org/pypi/ironic-inspector
* Documentation: https://docs.openstack.org/ironic-inspector/latest/
* Python client library and CLI tool: `python-ironic-inspector-client
<https://pypi.python.org/pypi/python-ironic-inspector-client>`_
(`documentation
<https://docs.openstack.org/python-ironic-inspector-client/latest/>`_).
.. _Ironic: https://wiki.openstack.org/wiki/Ironic
.. note::
**ironic-inspector** was called *ironic-discoverd* before version 2.0.0.
Release Notes
=============
For information on any current or prior version, see `the release notes`_.
.. _the release notes: https://docs.openstack.org/releasenotes/ironic-inspector/