This is largely inspired by the excellent feedback we got from David
Welsch, although this patch is only a very early first step towards
where we want to be with the documentation.

First, I'm splitting the large administrator guide into several large
sections: features, operation, architecture. Some of their topic might
actually find a better home outside of the administrator guide, but I
don't go that far in this change.

Second, I'm grouping several separate things together with the larger
topics:
- API topics are relevant for users and are grouped with the user guide
- Configuration guide and release notes are grouped with the
  administrator guide.
- The command reference is renamed for clarity and also grouped with the
  administrator guide since these are not user-visible commands.
- I'm dropping the "Advanced topics" subsection. While I like its
  intention (and I think it was me who added it in the first place),
  it's clear that such separation makes these topics much less
  discoverable.

Third, I'm playing with :maxdepth: here to make the sub-pages more
informative.

Change-Id: Icd0a35b252136b7da107c6346c48473cf1b99bcb

2024-06-24 13:25:51 +02:00

2.2 KiB

Raw Blame History

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 (latest) <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

Release Notes

admin/index

Contributor Guide

contributor/index

html

Indices and tables

genindex
search

2.2 KiB Raw Blame History