Commit Graph

23 Commits

Author SHA1 Message Date
Bruno Cornec
5c888986bc Update documentation index.rst
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
2015-05-27 19:56:01 +09:00
Ruby Loo
e30e77aefa Link to config reference in our docs
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
2015-05-04 22:22:35 +00:00
Adam Gandelman
995999730a Add notes about upgrading juno->kilo to docs
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
2015-04-09 09:30:53 -07:00
Jay Faulkner
ad49f1b435 Add documentation for Cleaning
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>
2015-03-27 11:35:42 -07:00
Jenkins
b4872913e7 Merge "Add state machine to documentation" 2015-01-14 21:13:56 +00:00
Joshua Harlow
27d9f8b1d3 Add state machine to documentation
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
2015-01-12 17:05:39 -08:00
Satoru Moriya
afde5bf1f8 Delete unnecessary document files
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
2015-01-08 16:01:35 +09:00
Lucas Alvares Gomes
8cf772b494 Add documentation about Vendor Methods
This patch adds a quick tutorial on writing vendor specific methods to
a driver.

Implements: blueprint extended-vendor-passthru
Change-Id: Id23e73715e0058ce162a5dde8eeb3ad61d9e7131
2014-11-18 18:21:58 +00:00
Devananda van der Veen
92e7fc73db Update doc headers at end of Juno
- 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
2014-10-16 09:41:44 +01:00
David Shrewsbury
3f8bc3b53d Add documentation for ironic-dbsync command
This adds a new documentation section for the ironic commands.
The ironic-dbsync command is the first to be documented.

Change-Id: I166a00005092fb7e87b856e7ceca2b88b6eae322
2014-09-24 11:51:00 -04:00
Imre Farkas
a2d3e4c493 Add DracDriver and its DracPower module
Implements: blueprint drac-power-driver
Change-Id: If93231c39ce901224f3a920f5342c44ba1b26851
2014-08-19 16:28:52 +02:00
Devananda van der Veen
a0a013c927 Some minor clean up of various doc pages
* 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
2014-04-15 12:08:43 -07:00
Ruby Loo
2adc6bbf66 Install guide for Ironic
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
2014-04-15 13:28:09 +00:00
Sandhya Balakrishnan
41af7d6b74 Add Ironic User Guide
Add a User guide, Initial chapters to cover introduction, architecture
diagrams, terminology for Ironic service.

Change-Id: I08faac6204aa412e330362133eb14241f3c21b34
2014-04-14 16:11:32 +05:30
Devananda van der Veen
943585600d Fix broken doc links on the index page
Commit 017f99120b 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
2014-02-06 11:21:26 -08:00
Devananda van der Veen
017f99120b Minor documentation update
* 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
2014-01-28 21:42:18 +00:00
Devananda van der Veen
f1acbc3c03 Developer doc index page points to correct API docs
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
2013-12-13 23:07:32 +00:00
Devananda van der Veen
8eb63c2078 Rename "manager" to "conductor"
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
2013-07-03 04:03:22 -07:00
Devananda van der Veen
4901e861d4 Fix one typo in index.rst.
Fix a one-char typo in index.rst, to regenerate and publish the docs.

Change-Id: Id8e3f1a6d231be7f9c521f41f8310252626620f1
2013-05-30 16:35:13 -07:00
Devananda van der Veen
676a157f42 More doc updates.
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
2013-05-29 16:20:58 -07:00
Devananda van der Veen
09271d52e5 More doc updates.
- general updates to index.rst
- add api quick-ref section to index.rst
- consolidate contributing/* to contributing.rst & dev-quickstart.rst
- remove broken :term: links in architecture.rst
- rename v1.rst -> api-spec-v1.rst

Change-Id: Ib02fb3f8c8e3c6450e74b3a6831795699b2ddf67
2013-05-29 11:58:57 -07:00
Devananda van der Veen
2b5bc76e92 Add initial sphinx docs, based on README.
Initial run of refactoring the README into RST so that Sphinx will build
docs automatically from it.

Change-Id: Ic648a2fa5fadb326b7db1578bcb630f58531ea87
2013-05-28 11:02:59 -07:00
Monty Taylor
23f30cb6fe Add support for Sphinx Docs.
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
2013-05-25 08:03:45 +02:00