d0e49e1b41
This patch contains several changes to the documentation which were brought about by, initially, removing the webapi/v1 page and replacing it with a link to the /api-ref/ page. As I did that, I saw that our front page (index.html) needed to be updated as well, and decided that the front page needed to actually be completely rerwitten -- while preserving all the links. Some of the TOC links from the front page were malformed because subpages included more than one H1 heading, so I had to make small changes in the api-audit-support and code-contribution-guide and dev-quickstart pages, in order for the front page to render properly. As I corrected the headings on dev-quickstart, I realized the page was not comprehensively organized, and so decided to reorganize the sections and make it easier to navigate. Here is a bullet-point summary of this change: * Major changes to content and organization of index page * Moved the version history from webapi/v1 to dev/webapi-version-history * Added API conceptual guide at dev/webapi * Replaced webapi/v1 with a link to dev/webapi, in case anyone bookmarked it * Removed doc references to webapi/v1 * Merged the pages dev/contributing and dev/code-contribution-guide * Removed duplicate H1 headers in deploy/api-audit-support * Reorganized and renamed section headers in dev/dev-quickstart, and made some substantive corrections and changes as well * Updated wording at the top of the index and deploy/user-guide pages. Change-Id: Ib418e1d4fdfab4f0e15560270f39922e33df3f12
6.6 KiB
Welcome to Ironic's developer 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.
An introduction to the ironic's conceptual architecture is available for those new to the project.
Site Notes
This site is primarily intended to provide documentation for developers interested in contributing to or working with ironic. It also contains references and guides for administrators which are not yet hosted elsewhere on the OpenStack documentation sites.
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:
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 <dev/webapi> API Reference (latest) <http://developer.openstack.org/api-ref/baremetal/> API Version History <dev/webapi-version-history>
Developer's Guide
Getting Started
If you are new to ironic, this section contains information that should help you get started as a developer working on the project or contributing to the project.
Developer Contribution Guide <dev/code-contribution-guide> Setting Up Your Development Environment <dev/dev-quickstart> Frequently Asked Questions <dev/faq>
The following pages describe the architecture of the Bare Metal service and may be helpful to anyone working on or with the service, but are written primarily for developers.
Ironic System Architecture <dev/architecture> Provisioning State Machine <dev/states>
Writing Drivers
Ironic's community includes many hardware vendors who contribute drivers that enable more advanced functionality when Ironic is used in conjunction with that hardware. To do this, the Ironic developer community is committed to standardizing on a Python Driver API that meets the common needs of all hardware vendors, and evolving this API without breaking backwards compatibility. However, it is sometimes necessary for driver authors to implement functionality - and expose it through the REST API - that can not be done through any existing API.
To facilitate that, we also provide the means for API calls to be "passed through" ironic and directly to the driver. Some guidelines on how to implement this are provided below. Driver authors are strongly encouraged to talk with the developer community about any implementation using this functionality.
Driver Overview <dev/drivers> Driver Base Class Definition <api/ironic.drivers.base.html> Writing "vendor_passthru" methods <dev/vendor-passthru>
Testing Network Integration
In order to test the integration between the Bare Metal and Networking services, support has been added to devstack to mimic an external physical switch. Here we include a recommended configuration for devstack to bring up this environment.
Configuring Devstack for multitenant network testing <dev/ironic-multitenant-networking>
Administrator's Guide
Installation & Operations
If you are a system administrator running Ironic, this section contains information that should help you understand how to deploy, operate, and upgrade the services.
Installation Guide <deploy/install-guide> Upgrade Guide <deploy/upgrade-guide> Release Notes <http://docs.openstack.org/releasenotes/ironic/> Troubleshooting FAQ <deploy/troubleshooting>
Configuration
There are many aspects of the Bare Metal service which are environment specific. The following pages will be helpful in configuring specific aspects of ironic that may or may not be suitable to every situation.
Guide to Node Cleaning <deploy/cleaning> Configuring Node Inspection <deploy/inspection> Configuring RAID during deployment <deploy/raid> Security considerations for your Bare Metal installation <deploy/security> Adopting Nodes in an ACTIVE state <deploy/adoption> Auditing API Traffic <deploy/api-audit-support> Configuring for Multi-tenant Networking <deploy/multitenancy>
Add page on metrics.
A reference guide listing all available configuration options is published for every major release. Additionally, a sample configuration file is included within the project and kept continually up to date.
Configuration Reference (Mitaka) <http://docs.openstack.org/mitaka/config-reference/bare-metal.html>
Dashboard Integration
A plugin for the OpenStack Dashboard (horizon) service is under development. Documentation for that can be found within the ironic-ui project.
Dashboard (horizon) plugin <http://docs.openstack.org/developer/ironic-ui/>
Driver References
Every driver author is expected to document the use and configuration of their driver. These pages are linked below.
Driver Documentation pages <deploy/drivers> Further Considerations for the Agent Drivers <drivers/ipa>
Command References
Here are references for commands not elsewhere documented.
cmds/ironic-dbsync
Indices and tables
genindexmodindexsearch