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
The old ramdisk is deprecated, so we should not really default to it.
Also this guide makes an assumption that agent_* and pxe_* drivers
can't be used together, which is no longer the case, as IPA handles both.
Consolidate the example local.conf into one enabling both pxe_* and agent_*
drivers with IPA and create a separate page for explaining difference between
these two.
Co-Authored-By: Lilia Sampaio <liliars@lsd.ufcg.edu.br>
Change-Id: Ifeed7bf9128281b79d425f7c5dbb3d8c39e7fb68
In bare metal case this error happens much more often, we
are adding a new troubleshooting document and add it as
part of this new document.
Change-Id: I155b5c7160fbefe61c6a7bcdc5aa51452c8b8ab7
Closes-bug: #1503735
This is a first stab a developer FAQ in our documentation. The only
question answered so far is "How do I create a migration script
template?" because every time I have to google that.
This FAQ should be extended with more answers from questions we get from
day to day.
Change-Id: I3a81261892c359e624ed2dbeb7cd42b11b799a6d
Currently the configuration reference of admin guide is kilo in Ironic’s
developer documentation. We should update it to liberty.
Change-Id: Ia2509ae34785308a1bd5c883d53e27668825445f
Closes-bug: #1509746
Add release notes for 4.0.0 to doc tree, updating the index.html page
with reference to the new release notes.
Include a symlink in the base dir so packagers can find RELEASE-NOTES
Co-Authored-By: Ruby Loo <rloo@yahoo-inc.com>
Change-Id: I1a161b2c1d1e27268065b6b4be24c8f7a5315afb
Reorder the index doc to place Admin guide first (before the dev doc) so
that users/newcomers have a more easy entry point
Change-Id: Id9de3e02877c539da973d38734afbb8f5ac0a7e5
The ironic configuration options for kilo are documented with the rest
of the OpenStack configs at
http://docs.openstack.org/kilo/config-reference/content/.
This adds a 'Configuration Reference (Kilo)' entry to the index of our developer
documentation with a link to the config-reference URL. The install guide
also has a link to the config reference.
It also removes 'Bare Metal Service' from two entries at
http://docs.openstack.org/developer/ironic/, since it seems redundant.
(Everything there is about Bare Metal Service!)
Change-Id: Idf649641b2108ac6075e7b67c547551bccd9d5f7
This adds a new section to docs to outline special considerations
for the juno -> kilo upgrade, specifically around how to upgrade
Nova and Ironic together.
Change-Id: Idf7efb7438217f5132f6a8581c591a04c76b1abb
Closes-bug: #1433727
This adds some basic documentation, including a FAQ, about the new
cleaning feature for Ironic.
Change-Id: I7ce79972057d4bfb133710eaba7a44fa6ccb0371
Partial-blueprint: implement-cleaning-states
Co-Authored-By: Josh Gachnang <josh@servercobra.com>
Since we can now generate the state machine that ironic
uses using the tools/states_to_dot.py generator we can
now build it and include it in the documentation for others
to view.
Change-Id: I4ffc298d0708cbac2573e1e2aee2d73836c27a80
This patch deletes unnecessary files and references to them
because they are just TOC files and also cause some warnings
in doc building.
Change-Id: I3bd230cc3b38a6d7a8d9d9b8c230eb34b90dd936
Partial-bug: 1277282
This patch adds a quick tutorial on writing vendor specific methods to
a driver.
Implements: blueprint extended-vendor-passthru
Change-Id: Id23e73715e0058ce162a5dde8eeb3ad61d9e7131
- remove note that Ironic is incubated
- remove statements about Icehouse being beta quality
- add note to deploy/install-guide that it refers to Juno release
Change-Id: I1fb7059bdd01d2bd9a6d20c8f131d51608188451
This adds a new documentation section for the ironic commands.
The ironic-dbsync command is the first to be documented.
Change-Id: I166a00005092fb7e87b856e7ceca2b88b6eae322
* simplify the links on index.rst
* update the main description on the index page
* move install/ironic-install under deploy/
* rename ironic-install to install-guide
* rename userguide to user-guide
* clarify a few things in the install-guide
Change-Id: Ic6eff035df42d0c3fa78f54eac7ad8322ebb0afc
This contains the beginnings of documentation on how to
install and configure the Bare Metal Service (ironic).
This is modelled after documentation available at
http://docs.openstack.org/havana/install-guide/install/apt/content/.
Change-Id: I7bf0a9caaf5bd5a2fcfc6fd0b0addeedb7ca26cb
Add a User guide, Initial chapters to cover introduction, architecture
diagrams, terminology for Ironic service.
Change-Id: I08faac6204aa412e330362133eb14241f3c21b34
Commit 017f99120b1 did not move documentation from dev/ to developer/.
The links on the index page were updated incorrectly.
This change reverts that and fixes the broken links.
Change-Id: Ia2f3703589c469bfc2a5204bdd3becc4b09efd0d
* Update the index page's description.
* Add a section about the hash ring to architecture.
* Add some new modules to, and remove some old modules from,
the developer doc quick links, to make the list of quicklinks
shorter and more useful.
* Correct a few broken links in the developer docs.
Change-Id: Ifac1dc355631a2d77b7ccdea362fb83ffbe6a4db
The index.html page of our developer web docs should now
reference the auto-generated API documentation, and we can
remove the out-of-date hand-written api-spec-v1.rst.
It served us well early on, but is impractical to keep up
to date with a fast-moving project.
Change-Id: Ie71f43ef363501d4c470485a011267755f41c5b3
This rename to "conductor" more clearly communicates that this service
has a many-to-many relationship. One or more service instances
coordinate between each other to conduct actions on a set of nodes,
using guarded locks to prevent conflicting simultaneous actions on any
given node. The old name "manager" suggested a more one-to-many relationship,
which is not the design pattern which we use here.
Rename ironic/manager to ironic/conductor
Rename ironic.manager.manager.ManagerService
to ironic.conductor.manager.ConductorManager
Rename ironic-manager to ironic-conductor
Update docs too
Change-Id: I3191be72a44bdaf14c763ce7519a7ae9066b2bc5
Create doc/source/dev/ directory, and add several files that got
accidentaly ignored because they were under doc/source/api/.
Also move some files from doc/source into doc/source/dev to clean up the
base doc dir.
Change-Id: Ief9777216db82ec3be32b7a73e2d268a3a973ef8
Initial run of refactoring the README into RST so that Sphinx will build
docs automatically from it.
Change-Id: Ic648a2fa5fadb326b7db1578bcb630f58531ea87
Also turn on doc API autoindexing.
This depends on https://review.openstack.org/30520 landing in pbr and a
new point release being cut, as it uncovered a bug.
Change-Id: I8f4ffc4f7c54c7b207d6d52e74ccab020596e602
