ironic-inspector/README.rst
Dmitry Tantsur e96ee4b5ff
Deprecate the project
The time has come. After nearly 10 years of existence, ironic-inspector
enters maintenance mode. New deployments are discouraged, existing ones
should consider migration.

Change-Id: I2cf90d973acd988896071a23c6d6533324368632
2024-07-05 15:48:39 +02:00

45 lines
1.8 KiB
ReStructuredText

===============================================
Hardware introspection for OpenStack Bare Metal
===============================================
.. warning::
This project is now in the maintenance mode and new deployments of it are
discouraged. Please use `built-in in-band inspection in ironic
<https://docs.openstack.org/ironic/latest/admin/inspection/index.html>`_
instead. For existing deployments, see the `migration guide
<https://docs.openstack.org/ironic/latest/admin/inspection/migration.html>`_.
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 its power management credentials
(e.g. IPMI address, user name and password).
* Free software: Apache license
* Source: https://opendev.org/openstack/ironic-inspector/
* Bugs: https://bugs.launchpad.net/ironic-inspector
* Downloads: https://tarballs.openstack.org/ironic-inspector/
* Documentation: https://docs.openstack.org/ironic-inspector/latest/
* Python client library and CLI tool: `python-ironic-inspector-client
<https://pypi.org/project/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/