656f93b6e7
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 |
||
|---|---|---|
| api-ref | ||
| devstack | ||
| doc | ||
| etc | ||
| ironic | ||
| playbooks | ||
| redfish-interop-profiles | ||
| releasenotes | ||
| tools | ||
| zuul.d | ||
| .coveragerc | ||
| .gitignore | ||
| .gitreview | ||
| .mailmap | ||
| .pre-commit-config.yaml | ||
| .stestr.conf | ||
| bindep.txt | ||
| CONTRIBUTING.rst | ||
| driver-requirements.txt | ||
| LICENSE | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
Ironic
Team and repository tags
Overview
Ironic consists of an API and plug-ins for managing and provisioning physical machines in a security-aware and fault-tolerant manner. It can be used with nova as a hypervisor driver, or standalone service using bifrost. By default, it will use PXE and IPMI to interact with bare metal machines. Ironic also supports vendor-specific plug-ins which may implement additional functionality.
Ironic is distributed under the terms of the Apache License, Version 2.0. The full terms and conditions of this license are detailed in the LICENSE file.
Project resources
- Documentation: https://docs.openstack.org/ironic/latest
- Source: https://opendev.org/openstack/ironic
- Bugs: https://bugs.launchpad.net/ironic/+bugs
- Wiki: https://wiki.openstack.org/wiki/Ironic
- APIs: https://docs.openstack.org/api-ref/baremetal/index.html
- Release Notes: https://docs.openstack.org/releasenotes/ironic/
- Design Specifications: https://specs.openstack.org/openstack/ironic-specs/
Project status, bugs, and requests for feature enhancements (RFEs) are tracked in Launchpad: https://launchpad.net/ironic
For information on how to contribute to ironic, see https://docs.openstack.org/ironic/latest/contributor