Welcome to Ironic’s developer documentation!¶
Introduction¶
Ironic is an OpenStack project which provisions bare metal (as opposed to virtual) machines by leveraging common technologies such as PXE boot and IPMI to cover a wide range of hardware, while supporting pluggable drivers to allow vendor-specific functionality to be added.
If one thinks of traditional hypervisor functionality (eg, creating a VM, enumerating virtual devices, managing the power state, loading an OS onto the VM, and so on), then Ironic may be thought of as a hypervisor API gluing together multiple drivers, each of which implement some portion of that functionality with respect to physical hardware.
The documentation provided here is continually kept up-to-date based on the latest code, and may not represent the state of the project at any specific prior release.
For information on any current or prior version of Ironic, see the release notes.
Administrator’s Guide¶
- Introduction to Ironic
- Installation Guide
- Upgrade Guide
- Configuration Reference (Mitaka)
- Ironic Python Agent
- Enabling drivers
- Node cleaning
- RAID Configuration
- Hardware Inspection
- Security
- Node adoption
- API Audit Logging
- Enabling API Audit Logging
- Sample Audit Event
- Troubleshooting Ironic
- Release Notes
- Dashboard (horizon) plugin
Commands and API References¶
Developer’s Guide¶
- System Architecture
- Ironic’s State Machine
- Contributing to Ironic
- Code Contribution Guide
- Developer Quick-Start
- Exercising the Services Locally
- Deploying Ironic with DevStack
- Running Tempest tests
- Building developer documentation
- Vendor Methods
- Ironic multitenant networking and DevStack
- Developer FAQ (frequently asked questions)