ca1fe6cc84
This corrects the URLs in the contributor documentation as well as the main index. The changes include: - changing http to https - changing absolute links to relative links (where applicable) Change-Id: Iea392f8108ca4b5203682609dd78b980c1540b89
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/.
User Guide
user/index
Administrator Guide
admin/index
Configuration Reference
configuration/index
Driver References
Every driver author is expected to document the use and configuration of their driver. These pages are linked below.
Driver Documentation pages <admin/drivers> Further Considerations for the Agent Drivers <admin/drivers/ipa>
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://developer.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
Indices and tables
genindexsearch