03b8f4dd11
This is a significant improvement and update to Ironic contributor documentation, as an attempt to make it easier for new Ironic contributors to onboard. It is not perfect, but it's significantly better than the existing documentation. What this change does: - Improve dev-quickstart guide, make it easier to find devstack configurations. - Removes information that can bit-rot over time and replaces with more generic information. - Provides an actual working, tested, Ironic+Nova devstack conf What hasn't been done: - Testing of Ironic BFV or Multitenant networking devstack confs - Validation that the local development method still works - There is a ton more information about how to use these testing envs (both bifrost and devstack) which could be added. - System prerequsities and Python prerequisites under the unit tests section has bitrotted considerably; they have not been significantly modified and will be fixed in a future commit. Change-Id: I0cdfe50042fabb6b65633961fc418aff5d6ebfe3
Ironic
Team and repository tags
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 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
- 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 StoryBoard: https://storyboard.openstack.org/#!/project/943
For information on how to contribute to ironic, see https://docs.openstack.org/ironic/latest/contributor