Welcome to Ironic’s documentation!¶
Introduction¶
Ironic is an OpenStack project which provisions bare metal (as opposed to virtual) machines. It may be used independently or as part of an OpenStack Cloud, and integrates with the OpenStack Identity (keystone), Compute (nova), Network (neutron), Image (glance), and Object (swift) services.
The Bare Metal service manages hardware through both common (eg. PXE and IPMI) and vendor-specific remote management protocols. It provides the cloud operator with a unified interface to a heterogeneous fleet of servers while also providing the Compute service with an interface that allows physical servers to be managed as though they were virtual machines.
This documentation is continually updated and may not represent the state of
the project at any specific prior release. To access documentation for a
previous release of ironic, append the OpenStack release name to the URL; for
example, the ocata
release is available at
https://docs.openstack.org/ironic/ocata/.
Found a bug in one of our projects? Please see Bug Reporting and Triaging Guide.
Would like to engage with the community? See Bare Metal Community.
Installation Guide¶
- Bare Metal Service Installation Guide
- Bare Metal service overview
- Reference Deploy Architectures
- Install and configure the Bare Metal service
- Building or downloading a deploy ramdisk image
- Integration with other OpenStack services
- Set up the drivers for the Bare Metal service
- Enrolling hardware with Ironic
- Using Bare Metal service as a standalone service
- Enabling the configuration drive (configdrive)
- Advanced features
- Troubleshooting
- Next steps
- Using Bare Metal service as a standalone service
- Bare Metal Service Upgrade Guide
User Guide¶
Administrator Guide¶
- Bare Metal Service Features
- Hardware Inspection
- Deployment
- Cleaning
- Adoption
- Retirement
- RAID Configuration
- BIOS Settings
- Firmware Updates
- Node Rescuing
- Booting from Volume
- Configuring Web or Serial Console
- Enabling Notifications
- Node Multi-Tenancy
- Booting a Ramdisk or an ISO
- Hardware Burn-in
- Vendor Passthru
- Servicing
- Windows Images
- Deploying without BMC Credentials
- Layer 3 or DHCP-less Ramdisk Booting
- Deploying with Anaconda
- Configuration and Operation
- Ironic Python Agent
- Multi-tenant Networking
- Port Groups
- Conductor Groups
- Security
- Troubleshooting FAQ
- Power Synchronization
- Fast-Track Deployment
- Authentication for Instance Images
- OVN Networking
- Ceph Object Gateway
- Emitting Software Metrics
- Auditing API Traffic
- Service State Reporting
- Tuning Ironic
- Role Based Access Control
- Dashboard Integration
- Upgrade Guide