A service for managing and provisioning Bare Metal servers.
Find a file
Julia Kreger 66ade9b9bd doc: trivial: Quick revision of README
I took a quick look and felt like it wasn't clearly demonstrating
current state, so decided to revise the text. It should be more
clear now as to the state of reality.

Change-Id: I1b3c808f6d75e1e7fa532d18df82418a4747071a
Signed-off-by: Julia Kreger <juliaashleykreger@gmail.com>
2025-11-20 07:33:02 -08:00
api-ref Add node.instance_name 2025-11-12 13:34:51 +01:00
devstack Fixes for console containers functional testing 2025-10-16 14:28:10 +13:00
doc Merge "Nit: Fix typo in Migrating from ironic-inspector" 2025-11-19 09:38:03 +00:00
etc/ironic Drop wsgi script, docs around mod_wsgi 2025-08-26 21:10:01 +00:00
ironic Merge "Add node.instance_name" 2025-11-18 23:27:20 +00:00
playbooks Run metal3 integration job using UEFI boot (default) 2025-10-24 10:45:41 +02:00
redfish-interop-profiles Update the redfish interoperability profile 2024-06-27 16:24:24 +02:00
releasenotes Merge "Add node.instance_name" 2025-11-18 23:27:20 +00:00
tools Replace Chrome/Selenium console with Firefox extension 2025-11-05 11:07:07 +13:00
zuul.d Merge "Fixes for console containers functional testing" 2025-11-04 11:28:41 +00:00
.coveragerc Use .coveragerc file 2024-02-02 23:17:12 +09:00
.gitignore Render the redfish interop profile in the docs 2024-06-27 16:32:28 +02:00
.gitreview OpenDev Migration Patch 2019-04-19 19:40:53 +00:00
.mailmap Add my new address to .mailmap 2020-04-13 07:29:37 -07:00
.pre-commit-config.yaml Improve pre-commit configuration 2025-11-15 11:41:31 +01:00
.stestr.conf Migrate to stestr as unit tests runner 2017-09-22 08:56:34 +00:00
bindep.txt Always rebuild sphinx env on doc build 2025-08-15 10:56:13 +12:00
CONTRIBUTING.rst Project Contributing updates for Goal 2020-02-20 02:01:21 +00:00
driver-requirements.txt Remove sushy-oem-idrac from driver requirements 2025-10-28 17:26:28 +01:00
LICENSE Added project infrastructure needs. 2013-05-02 14:55:43 -04:00
pyproject.toml Merge "Add a noop deploy interface" 2025-11-18 17:21:20 +00:00
README.rst doc: trivial: Quick revision of README 2025-11-20 07:33:02 -08:00
requirements.txt Revert "Switch from local RPC to automated JSON RPC on localhost" 2025-08-28 17:10:25 +02:00
setup.cfg Migrate setup configuration to pyproject.toml 2025-09-22 11:46:52 +01:00
setup.py add pyproject.toml to support pip 23.1 2024-11-05 08:00:24 -06:00
test-requirements.txt Drop direct dependency on iso8601 2025-03-01 06:06:01 +00:00
tox.ini Add hacking check to ban eventlet imports 2025-08-28 11:30:57 +02:00

======
Ironic
======

.. image:: https://governance.openstack.org/tc/badges/ironic.svg

Overview
--------

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.

By default, it will use PXE and IPMI/Redfish to interact with bare metal
machines. Some drivers, like the Redfish drivers, also support advanced
features like leveraging HTTPBoot or Virtual Media based boot operations
depending on the configuration by the user. Ironic also supports
vendor-specific plug-ins which may implement additional functionality,
however many vendors have chosen to focus on their Redfish implementations
instead of customized drivers.

Numerous ways exist to leverage Ironic to deploy a bare metal node, above
and beyond asking Nova for a "bare metal" instance, or for asking Ironic
to manually deploy a specific machine. Bifrost and Metal3 are related
projects which seek to simplify the use and interaction of Ironic.

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
~~~~~~~~~~~~~~~~~

* Documentation: https://docs.openstack.org/ironic/latest
* Source: https://opendev.org/openstack/ironic
* Bugs: https://bugs.launchpad.net/ironic/+bugs
* Wiki: https://wiki.openstack.org/wiki/Ironic
* APIs: https://docs.openstack.org/api-ref/baremetal/index.html
* Release Notes: https://docs.openstack.org/releasenotes/ironic/
* Design Specifications: https://specs.openstack.org/openstack/ironic-specs/

Project status, bugs, and requests for feature enhancements (RFEs) are tracked
in Launchpad:
https://launchpad.net/ironic

For information on how to contribute to ironic, see
https://docs.openstack.org/ironic/latest/contributor