ironic/doc/source/index.rst
Dmitry Tantsur 6243a4b280 Rework the user guide
Currently it only contains (outdated) explanations how Ironic works.
Move them one level deeper and migrate the content relevant to users:
* Preparing instance images from the installation guide
* Deploying nodes from the standalone guide

Compatibility shims are provided for migrated pages.

Change-Id: I8468da377b7878eb3d1a61e6a6bcd4ac8a5f06d7
2021-05-10 17:18:13 +02:00

2.4 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.

Installation Guide

install/index install/standalone admin/upgrade-guide

User Guide

user/index

Administrator Guide

admin/drivers

admin/index

Configuration Guide

configuration/index

Bare Metal API References

Ironic's REST API has changed since its first release, and continues to evolve to meet the changing needs of the community. Here we provide a conceptual guide as well as more detailed reference documentation.

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

Command References

Here are references for commands not elsewhere documented.

cli/index

Contributor Guide

contributor/index

Release Notes

Release Notes

html

Indices and tables

  • genindex
  • search