In the main landing page, under 'Upgrade Guide', links to
'Upgrading to Hardware Types' documentation are added.
Change-Id: I671a42dc723fdd6b311e340b744c513da7336849
Documentation layout aligned with the OS standards.
The admin page cleaned up - unrelated references moved
elsewhere linking merely admin pages.
The configuration page refactored, ironic.conf
and policy.conf documentation and samples
automatically generated by oslo_config.sphinxext.
Change-Id: I9075e2688f59ecd8ab5c489679f2c53d6294f28d
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
This patch does the following:
* Adds a configuration folder to contain automated generated config
files for Ironic.
* Adds `oslo_config.sphinxconfiggen` to the extensions list.
* Adds `oslo_policy.sphinxpolicygen` to the extensions list.
* Adds ironic-policy-generator.conf
This is important for Ironic to be included in the list of services
on https://docs.openstack.org/pike/configuration/
Change-Id: I51a7204ce00be2588e427c1951e8be7dc7a22647
Closes-bug: #1706176
This updates ironic's landing page https://docs.openstack.org/ironic/latest/
so that:
- it isn't only for developer documentation
- the sections are reordered to better reflect the order of information
from new user to experienced developer
- a user guide entry was added (since there is user documentation)
- the releasenotes/index.rst was removed since it was a placeholder to
redirect links to new locations. Due to the doc migrations, that original
URL doesn't exist anymore anyway, so this page should not be bookmarked
so we don't need to keep it
- the section names are more consistent
- the User Guide and Administrator Guide sections have links to subsections
- removed a link to <api/index>, which doesn't exist
Change-Id: I413048526f96a8c11eb7da365b935f617307de10
Oslo_reports enables OpenStack projects to dump
Guru Meditation Reports with useful debugging
information to files or stderr. For example,
what threads are running, what config parameters
are in effect, and more.
Change-Id: Ib435f9e933009d52841dd8876d425a093731fe7e
Closes-bug: #1526423
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.
Fix problems found:
* Duplicate labels (rename wrong faq entries, rename unused drivers
entries)
* Add api/autoindex.rst as hidden to the index so that we do not get a
warning. The modindex includes the same content, so no need to show
this.
* Add releasenotes/index.rst, webapi/v1.rst, user-guide, and install-guide.rst
to hidden index since they're not listed in index on purpose, so sphinx
will not warn that they do not appear in a toc
* Add deploy/radosgw to index
* ignore app.add_directiv warning
* Fix reference to user-guide to use proper markup so that Sphinx knows
the user-guide is referenced.
Change-Id: I00d249229d4d31ba36d4393d60847fdb1513a744
This moves the description of available notifications in ironic to the
administrator's guide and briefly describes how to configure
notifications. It also documents the message bus topic ironic
notifications are emitted on, since previously that required looking at
code to find out.
Related-Bug: #1526408
Change-Id: I4d5dfe92d2c2646a7cc803fa6ea7ade723aba310
Since third-party driver continuous integration testing is now required for
ironic, we can include documentation for best practices for setting up a test
environment. This patch is to get a basic outline and index done so that we
can then build on it.
Co-Authored-By: Mike Turek <mjturek@linux.vnet.ibm.com>
Change-Id: I06415c3bd5cc9809d3ffda5b656e5948182349fb
This documents what projects may be allowed in our governance, and the
process one must follow to add a project.
Change-Id: Iaf50a94371d51784db35a66f65106cc3bcf92cf8
Currently, the configuration reference points to Mitaka. This is wrong
as Newton was just released. Additionally, there is also a different
page published from master.
This commit links to the "draft" page from master. This will direct
readers to the right version of the configuration reference
documentation.
Change-Id: I677bfe0757dd99b63c5204b36e5fe68878eeb1f0
Fixes issues pointed out post merge in doc update:
- s/Test/Tox/ in the header for dev-quickstart
- Adding instructions for installing python-ironicclient
- Fixed grammar issue in index.rst
- Readded link to console documentation
Change-Id: If10e4dd1aaf608442022c7e544f5a6ffaa923a9a
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
The console documentation will be growing. In preparation for that
move it to its own file.
Co-Authored-By: Yuiko Takada Mori <y-mori@ti.jp.nec.com>
Change-Id: I8edf738d766c5d0689ddd15346661d5deb92e665
This adds support for the audit middleware to Ironic, allowing
the middleware to send two notifications per API request,
one for the request and another for the response.
This adds an option to enable or disable audit middleware.
Also to properly audit API requests passing conf options
via audit map file.
AuditMiddleware docs:
http://docs.openstack.org/developer/keystonemiddleware/audit.html
Co-Authored-By: Chris Krelle <nobodycam@gmail.com>
Closes-Bug: #1540232
Change-Id: I6de4751aa6b25e8457cae3eeab95a15f417662c5
The guide shows how to setup Devstack with Ironic multitenancy
and ``networking-generic-switch`` Neutron ML2 driver.
Depends-On: If2fb996783b9ac26a5bae2aadd6387207750def9
Change-Id: I24ef394536e5109cf1499ec87f6a495063a87f5d
Closes-bug: #1526403
At present the ironic API explicitly sets the new state for
nodes to the beginning step in the ironic workflow.
As part of hardware fleet lifecycle management, an operator
expects to be able to migrate inventory and control systems
for their hardware fleet utilizing their existing inventory
data and allocation records. Ultimately this means that
an imported host MAY already be allocated and unavailable
for immediate allocation.
As such, a mechanism is required to permit users to put nodes
into an ACTIVE state without performing a deployment operation.
This adds a new API provision_state verb to allow users to move
nodes from MANAGEABLE state to ACTIVE state.
Partial-Bug: #1526315
Change-Id: Ib3eadf4172e93add9a9855582f56cbb3707f3d39
Depends-On: Ie114bfaab249d73ea3ca7c0edc314ca1ed0448eb
Added ironic-ui to ironic documentation labled as 'Dashboard (horizon)
plugin' to prevent confusion between the webclient and the plugin.
Change-Id: I014c33428f98c1ee61e1461a50fd6198abfd4e1c
We don't want users to believe that ironic handles firmware security for
them, so document that we don't, and give some advice on how to do it.
This should be the start of a larger security document that talks about
firmwares, networks, ramdisk, more?
Co-authored-by: Devananda van der Veen <devananda.vdv@gmail.com>
Change-Id: I703b5d03da610fde43dd6723edd6cdc53051c1c3
This removes the link to the Liberty configs from our documentation.
Our documentation should reflect what is on the master branch, but
since the configuration documentation is only available on a (named)
release basis, we should only link to the latest, which is Mitaka
configs.
Change-Id: I2d4c857dcbe3745ef8aad714600ea32c9762a628
This reorganizes the developer's main page by adding a
'Commands and API References' section at the same level
as the sections for Administrator's & Developer's guides.
It also removes subsections like 'Introduction' and 'Overview'
that didn't make sense any more since they included more than
one might expect from such sections.
Change-Id: Ibf5415d946238ffadedc36c9a731f773f4fa2d71
Add a code contribution guide for Ironic. This should be useful for
developers to consider some key points when write and review
Ironic code.
First introduces things related to live-upgrade which consists
of RPC version and Object version.
Change-Id: I1d243a20151827a35aed465061befbcf65f96474
Implements: blueprint online-upgrade-support
