Administrator’s Guide

If you are a system administrator running Ironic, this section contains information that may help you understand how to operate and upgrade the services.

• Drivers, Hardware Types and Hardware Interfaces
  • Generic Interfaces
    • Boot interfaces
    • Deploy Interfaces
  • Hardware Types
    • iDRAC driver
    • iLO driver
    • Intel IPMI driver
    • IPMI driver
    • iRMC driver
    • Redfish driver
    • SNMP driver
    • Fake driver
  • Changing Hardware Types and Interfaces
    • Changing Hardware Interfaces
    • Changing Hardware Type
    • Static boot order configuration
  • Unsupported drivers
• Bare Metal Service Features
  • Hardware Inspection
    • Overview
    • Capabilities discovery
    • In-band inspection
  • Deployment
    • Overview
    • Deploy Steps
    • Deploy Templates
  • Cleaning
    • Overview
    • Automated cleaning
    • Manual cleaning
    • Cleaning Network
    • In-band vs out-of-band
    • FAQ
    • Advanced topics
    • Troubleshooting
  • Adoption
    • Overview
    • How it works
    • Possible Risk
    • How to use
    • Troubleshooting
    • Adoption with Nova
  • Retirement
    • Overview
    • Requirements
    • How to use
  • RAID Configuration
    • Overview
    • Prerequisites
    • Build agent ramdisk which supports RAID configuration
    • RAID configuration JSON format
    • Workflow
    • Software RAID
    • Using RAID in nova flavor for scheduling
    • Developer documentation
  • BIOS Settings
    • Overview
    • Prerequisites
    • Retrieve BIOS settings
    • Configure BIOS settings
  • Firmware Updates
    • How it works
    • Applying updates
  • Node Rescuing
    • Overview
    • Configuring The Bare Metal Service
  • Booting from Volume
    • Overview
    • Prerequisites
    • Conductor Configuration
    • Node Configuration
    • Image Creation
    • Advanced Topics
  • Configuring Web or Serial Console
    • Overview
    • Node web console
    • Node serial console
  • Enabling Notifications
    • Configuration
    • Versioning
    • Available notifications
  • Node Multi-Tenancy
    • Setting the Owner and Lessee
    • Configuring the Bare Metal Service Policy
  • Booting a Ramdisk or an ISO
    • Configuration
    • Creating a ramdisk
    • Booting a ramdisk
    • Booting an ISO
    • Limitations
    • Common options
  • Hardware Burn-in
    • Overview
    • CPU burn-in
    • Memory burn-in
    • Disk burn-in
    • Network burn-in
    • Logging
    • Additional Information
  • Vendor Passthru
    • Node Vendor Passthru
    • Driver Vendor Passthru
  • Servicing
    • Overview
    • Major differences
    • Similarities to Cleaning and Deployment
    • Available Steps
    • Executing Service Steps
    • Servicing Network
  • Windows Images
    • Requirements:
    • Preparation:
    • Implementation:
  • Deploying without BMC Credentials
    • How it works
    • Enabling
    • Limitations
  • Layer 3 or DHCP-less Ramdisk Booting
    • Hardware type support
    • Configuring network data
    • Deploying outside of the provisioning network
  • Deploying with Anaconda
    • Configuration
    • Creating an OS Image
    • Configuring the OS Image in glance
    • Creating a bare metal server
    • Standalone deployments
    • Deployment Process
    • Configuration Considerations
    • Limitations
• Configuration and Operation
  • Ironic Python Agent
    • Overview
    • Drivers
    • Using proxies for image download
    • Advanced configuration
  • Multi-tenant Networking
    • Overview
    • Concepts
    • Configuring the Bare Metal service
    • Configuring nodes
    • Configuring the Networking service
  • Port Groups
    • Switch-side configuration
    • Physical networks
    • Port groups configuration in the Bare Metal service
    • Link aggregation/teaming on windows
  • Conductor Groups
    • Overview
    • How it works
    • How to use
  • Security
    • REST API: user roles and policy settings
    • Multi-tenancy
    • Firmware security
    • UEFI secure boot mode
    • Other considerations
  • Troubleshooting FAQ
    • Nova returns “No valid host was found” Error
    • Patching the Deploy Ramdisk
    • API Errors
    • Retrieving logs from the deploy ramdisk
    • DHCP during PXE or iPXE is inconsistent or unreliable
    • Why does X issue occur when I am using LACP bonding with iPXE?
    • IPMI errors
    • Why are my nodes stuck in a “-ing” state?
    • Why are my nodes stuck in a “wait” state?
    • Deployments fail with “failed to update MAC address”
    • My test VM image does not deploy – mount point does not exist
    • Issues with autoconfigured TLS
    • I changed ironic.conf, and now I can’t edit my nodes.
    • I’m getting Out of Memory errors
    • Why does API return “Node is locked by host”?
    • What is ConcurrentActionLimit?
    • Why do I have an error that an NVMe Partition is not a block device?
    • Why can’t I use Secure Erase/Wipe with RAID controllers?
    • I’m in “clean failed” state, what do I do?
    • I can’t seem to introspect newly added nodes in a large cluster
    • Some or all of my baremetal nodes disappeared! Help?!
    • Config Drives in Swift, but rebuilds fails?
  • Power Synchronization
    • Baremetal Power Sync
    • Compute-Baremetal Power Sync
    • Power fault and recovery
  • Fast-Track Deployment
    • Enabling
  • Authentication for Instance Images
    • How to enable the feature via global configuration options
    • Example
    • Known limitations
  • OVN Networking
    • Overview
    • Challenges
    • Required Configuration
    • VTEP Switch Support
    • Unknowns
  • Ceph Object Gateway
    • Overview
    • Configure Ironic and Glance with RADOS Gateway
  • Emitting Software Metrics
    • Configuring the Bare Metal Service to Enable Metrics with Statsd
    • Transmission to the Message Bus Notifier
    • Types of Metrics Emitted
    • Adding New Metrics
  • Auditing API Traffic
    • Enabling API Audit Logging
    • Sample Audit Event
  • Service State Reporting
    • Configuration
    • Generating a GMR
    • Structure of a GMR
    • Sample GMR Report
  • Tuning Ironic
    • Memory Utilization
    • API
    • Conductor
    • Database
    • BMC interaction
    • What can I do?
  • Role Based Access Control
    • Suggested Reading
    • System Scoped
    • Project Scoped
  • Dashboard Integration
  • Upgrade Guide
    • Plan your upgrade
    • Offline upgrades
    • Rolling upgrades
• Architecture and Implementation Details
  • Agent Token
    • Purpose
    • How it works
    • Agent Configuration
  • Steps
    • What are steps?
    • Reserved Functional Steps