2017-07-20 16:45:48 -04:00
|
|
|
==================================
|
|
|
|
|
Welcome to Ironic's documentation!
|
|
|
|
|
==================================
|
2013-05-25 08:03:45 +02:00
|
|
|
|
2013-05-29 11:02:04 -07:00
|
|
|
Introduction
|
|
|
|
|
============
|
|
|
|
|
|
2014-10-15 12:05:58 -07:00
|
|
|
Ironic is an OpenStack project which provisions bare metal (as opposed to
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
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.
|
2013-05-25 08:03:45 +02:00
|
|
|
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
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.
|
2013-05-25 08:03:45 +02:00
|
|
|
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
This documentation is continually updated and may not represent the state of
|
|
|
|
|
the project at any specific prior release. To access documentation for a
|
2017-07-20 16:45:48 -04:00
|
|
|
previous release of ironic, append the OpenStack release name to the URL; for
|
|
|
|
|
example, the ``ocata`` release is available at
|
2017-08-22 14:43:44 -04:00
|
|
|
https://docs.openstack.org/ironic/ocata/.
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
|
2020-06-23 12:21:30 +02:00
|
|
|
Found a bug in one of our projects? Please see :doc:`/contributor/bugs`.
|
|
|
|
|
|
2017-08-08 19:02:36 +02:00
|
|
|
Installation Guide
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
install/index
|
2021-03-08 18:35:46 +01:00
|
|
|
install/standalone
|
2017-08-08 19:02:36 +02:00
|
|
|
|
|
|
|
|
Upgrade Guide
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
admin/upgrade-guide
|
2017-09-21 17:16:05 -04:00
|
|
|
admin/upgrade-to-hardware-types
|
2017-08-08 19:02:36 +02:00
|
|
|
|
2017-07-20 16:45:48 -04:00
|
|
|
User Guide
|
|
|
|
|
==========
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
|
|
|
|
|
.. toctree::
|
2017-07-20 16:45:48 -04:00
|
|
|
:maxdepth: 2
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
|
2017-07-20 16:45:48 -04:00
|
|
|
user/index
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
|
2017-07-20 16:45:48 -04:00
|
|
|
Administrator Guide
|
2017-07-03 16:34:42 +01:00
|
|
|
===================
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
|
2020-11-10 18:40:27 +01:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 3
|
|
|
|
|
|
|
|
|
|
admin/drivers
|
|
|
|
|
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
.. toctree::
|
2017-07-20 16:45:48 -04:00
|
|
|
:maxdepth: 2
|
2015-05-22 21:10:08 +02:00
|
|
|
|
2017-07-03 16:33:46 +01:00
|
|
|
admin/index
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
|
2017-08-08 19:02:36 +02:00
|
|
|
Configuration Guide
|
|
|
|
|
===================
|
2017-07-25 13:30:59 +05:30
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
configuration/index
|
|
|
|
|
|
2017-07-20 16:45:48 -04:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
API Concept Guide <contributor/webapi>
|
2019-07-22 18:24:39 +02:00
|
|
|
API Reference (latest) <https://docs.openstack.org/api-ref/baremetal/>
|
2017-07-20 16:45:48 -04:00
|
|
|
API Version History <contributor/webapi-version-history>
|
|
|
|
|
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
Command References
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
Here are references for commands not elsewhere documented.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
2017-07-03 16:36:20 +01:00
|
|
|
:maxdepth: 2
|
Documentation update
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
2016-08-17 15:20:50 -07:00
|
|
|
|
2017-07-03 16:36:20 +01:00
|
|
|
cli/index
|
2015-11-25 17:00:44 +00:00
|
|
|
|
2017-07-20 16:45:48 -04:00
|
|
|
Contributor Guide
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
contributor/index
|
|
|
|
|
|
2017-08-08 19:02:36 +02:00
|
|
|
Release Notes
|
|
|
|
|
=============
|
|
|
|
|
|
2017-09-07 19:41:18 -07:00
|
|
|
`Release Notes <https://docs.openstack.org/releasenotes/ironic/>`_
|
2017-08-08 19:02:36 +02:00
|
|
|
|
2019-09-06 11:57:18 +08:00
|
|
|
.. only:: html
|
|
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
2013-05-25 08:03:45 +02:00
|
|
|
|
2019-09-06 11:57:18 +08:00
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`search`
|