ironic/doc/source/index.rst
satoshi-sh 68f379582d Create a reference section
Added a reference section to doc

Closes-Bug: #2072354

Change-Id: I586364b118307469b8c3fcefada68df11aa854a6
2025-02-05 13:27:36 -06:00

2.3 KiB

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 /contributor/bugs.

Would like to engage with the community? See /contributor/community.

Installation Guide

install/index install/standalone admin/upgrade-guide

User Guide

user/index

API Concept Guide <contributor/webapi> API Reference for Ironic <https://docs.openstack.org/api-ref/baremetal/> API Version History <contributor/webapi-version-history>

Administrator Guide

admin/drivers

admin/features

admin/operation

cli/index

configuration/index

admin/architecture

admin/index

Contributor Guide

contributor/index

References

references/index

html

Indices and tables

  • genindex
  • search