1750 Commits

Author SHA1 Message Date
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
Adam Gandelman
c02a2a3fba Remove some obsolete settings from DevStack doc
The BM_* variables are no longer used by Devstack for Ironic
deployment and the new defaults should work fine. Removes
references to the old settings.

Change-Id: Ia19dccaf389273c5a224b804eb270c08d31a1811
2014-03-27 12:26:50 -07:00
Sergey Lukjanov
1ef1c90f32 Start using oslosphinx theme for docs
Use the new oslosphinx version of the OpenStack doc theme instead of
maintaining a copy of it in the Ironic repository.

Change-Id: I1d949d1e2734b10e38dea0067db9f3cfd7109c11
2014-03-27 11:40:14 +04:00
Jenkins
882e007890 Merge "Correct version.py and update current version string" 2014-03-24 10:24:51 +00:00
Devananda van der Veen
8e854d7eb8 Correct version.py and update current version string
Correct the version string in setup.cfg for Icehouse.

Make ironic/version.py use PBR instead of the stale code that was there.

Make ironic/common/config.py properly set the version string so that
all CLI commands output it when "--version" is passed.

Remove openstack.common.version module which is no longer present in
oslo-incubator.

Closes-bug: #1294389

Change-Id: I9a7bfe5fc1b79934cf2467d6f8a6c16f41205dbf
2014-03-21 13:50:05 -07:00
Adam Gandelman
e9e5a1e335 Documentation for deploying DevStack /w Ironic
Adds a section to the developer quickstart doc explaining
how to deploy Ironic as part of devstack.

Change-Id: I26a6f8faa882bfaa94dd6eb26e6bef197f12b25c
2014-03-21 13:22:25 -07:00
Roman Podoliaka
9f8748d1d8 Set the database.connection option default value
This was previously set right before ironic-api start, but the
default value must also be present for ironic-dbsync calls.

Note: the default value of database.connection is changed here - from
now on the sqlite database will be stored in ./ironic/ironic.sqlite
instead of ./ironic/openstack/common/db/ironic.sqlite.

Closes-Bug: #1290645

Change-Id: I2c2ab2f10a99ffd564611351e71c0b88adc20ba7
2014-03-12 19:32:17 +02:00
Jenkins
778ec1f18d Merge "Remove errors from API documentation" 2014-03-06 18:26:13 +00:00
Matt Wagner
d5b7af3294 Remove errors from API documentation
The API documentation mentions NodePowerState, NodeProvisionState,
and NodeVendorPassthru. They do not exist in the code, and their
entries here are error messages. Remove them.

Change-Id: I48c357cdf5d7ef2149b8af0becb517a578def97a
2014-03-05 19:10:53 -05:00
Jim Rollenhagen
70ba1493f9 Add libffi-dev(el) dependency to quickstart
This is required to build cryptography 0.2.1.

Change-Id: I397fe3c48ca65a3bed70bb5941c4bf9001aec717
2014-03-05 15:42:58 -08:00
Devananda van der Veen
dfa3501d78 Clarify and fix the dev-quickstart doc some more
Clarify and fix up the dev-quickstart doc some more
based on user feedback.

Testing examples now use tox rather than invoking the
testr command directly.

Simplified the section on building the documentation by
removing the need to install a web server.

Co-Authored-By: David Shrewsbury <shrewsbury.dave@gmail.com>

Change-Id: Ibdff4b44a26f11a5a0e92efb4c451105f6ab3245
2014-02-24 09:54:12 -08:00
Lucas Alvares Gomes
fdf19d393b Fix dev-quick-start.rst post landing for 9d81333fd0
Fixing:
* Add missing -r option to the pip install command
* Add a step to start rabbitmq-server on fedora/rhel after the
  installation
* Replace the systemctl command with service because RHEL <= 6 doesn't
  use systemd
* auth_strategy option can't be appended at the end of the file and
  should be edited under the [DEFAULT] section
* Remove the trailing space

Change-Id: Id9b8a3e2b8c0358ddfc6693fb0cda410a40a4186
2014-02-17 17:52:12 +00:00
Jenkins
b37844dacc Merge "Add testing and doc sections to docs/dev-quickstart" 2014-02-13 16:23:36 +00:00
Devananda van der Veen
9d81333fd0 Add testing and doc sections to docs/dev-quickstart
Add notes to dev/dev-quickstart to demonstrate how to
start up and interact with ironic-api and ironic-conductor
services locally, in a python virtualenv.

Also add some instrutions on building the documentation locally.

Change-Id: I01eb7ffb5ebe510cec9e4bc2f6ac0f0cc616493c
2014-02-12 22:17:00 -08:00
Jim Rollenhagen
7eb48adc82 Add git dependency to quickstart docs
Without git installed, `tox -evenv -- echo 'done'` fails with a
cryptic error message. This should keep newcomers from getting
stuck on this.

Change-Id: I7cd7faa3bda905c8cfb3cfb456e3279566edf613
2014-02-11 09:47:59 -08:00
Devananda van der Veen
943585600d Fix broken doc links on the index page
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
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
30206795b7 Add hooks to auto-generate REST API docs
Add the necessary bits for sphinxcontrib-pecanwsme
so that we can start auto-generating REST API docs.

Change-Id: I6ad61a5185462916865884dd1619465ef90aba0a
Closes-bug: 1251011
2013-11-20 09:25:06 -08:00
Jenkins
56dff2d905 Merge "Improve the API doc spec for node" 2013-11-12 16:31:29 +00:00
Lucas Alvares Gomes
584396a68d Improve the API doc spec for chassis
Change-Id: I2b7604c756a474bafd8f48b0c4b8d848aa9fd539
Partial-Bug: #1202748
2013-11-05 10:32:20 +00:00
Lucas Alvares Gomes
1889358422 Improve the API doc spec for node
Improve the API doc spec for node and fix some other format problems in
the document.

Change-Id: Iefa645552d55743cad553d1ab9bbaff6612343e2
Partial-Bug: #1202748
2013-11-05 10:31:20 +00:00
Jenkins
98670162c7 Merge "API GET to return only minimal data" 2013-09-25 19:17:34 +00:00
Lucas Alvares Gomes
3dd85586b6 API GET to return only minimal data
Requests to list top-level resources like nodes, chassis or ports will
now return only a subset of it's attributes, a subresource called /detail
could be used to get the full details of the resource. This changes
is supposed to improve performance and UX, also, others OpenStack APIs
already do it the same way so it's also about being consistent between
other APIs.

Change-Id: Ida45febf60e44d50e506f3680ab371e1027010c4
Closes-Bug: #1227431
2013-09-25 16:19:02 +01:00
Jenkins
26f72c01ae Merge "Replace OpenStack LLC with OpenStack Foundation" 2013-09-23 17:29:15 +00:00
Lucas Alvares Gomes
b11d982b3e Fix broken links
Fix broken links on the system architecture page.

Change-Id: I7bffd18f629e076c8dc0372789bac9d765ee1ec0
2013-09-23 12:28:48 +01:00
Ruby Loo
cd25f5d82f Changes documentation hyperlinks to be relative
On the "System Architecture" page of the developer documentation there
are hyperlinks to sections of the API documentation. These hyperlinks
assumed that the documentation has been placed in the web root and
did not work for documentation in a subdirectory. The hyperlinks
were changed to be relative.

Fixes bug: #1206569

Change-Id: Id2bffbeaba1a41f7e9f76f7eb5a849d66703a7e7
2013-09-19 20:38:31 +00:00
ZhiQiang Fan
2cb920614a Replace OpenStack LLC with OpenStack Foundation
Some files still use trademark OpenStack LLC in header, which
should be changed to OpenStack Foundation.

Change-Id: I6ab820e61514c6004247d9b931976e03baf84ae0
Fixes-Bug: #1214176
2013-09-20 03:45:06 +08:00
Ruby Loo
76b81e1f26 Updates documentation for tox use
In order to create a virtualenv with tox, a postgresql package is needed
as a prerequisite. The dev-quickstart documentation has been updated to
reflect this.

In addition, the prerequisites for Fedora/RHEL were modified, because
mysql-devel is needed, not mysql-libs.

Fixes bug: #1227390

Change-Id: Ibfdb0a9a3d560fcc3fb7d95aaa1d765ed18215e2
2013-09-19 16:12:01 +00:00
Lucas Alvares Gomes
143fe0ede8 Expose the vendor_passthru resource
The vendor_passthru resource allow vendors to expose a custom
functionality in the Ironic API. Ironic will merely relay the message
from here to the appropriate driver, no introspection will be made in
the message body.

Change-Id: I81f6460da80d44ab879fa4cadfbc0021b38ec96f
2013-09-12 17:21:14 +01:00
Lucas Alvares Gomes
b96e297dbb Updating resources with PATCH
This patch enables clients to update the resources using the PATCH HTTP
method. PATCH allows partial updates on the documents, reducing network
and processing overhead. Attributes may be removed, replaced, or added
in a single request.

Closes-Bug: #1220107

Change-Id: I8187f32b86f05fda58360cd3a51f07ae43742a3a
2013-09-06 11:25:08 +01:00
Devananda van der Veen
6863cbac0f Update the dev docs with driver interface description
Update the developer architecture document with information about the
current driver architecture. The existing description was old and
incorrect.

Fixes bug 1206567

Change-Id: Icc3dc82028f5ca3bb16fc256c54cf0563db10523
2013-08-05 07:56:51 -07:00
Lucas Alvares Gomes
318dd2181b Update API documentation
Update the Pagination section of the API documentation.

Partially fixes bug 1202748

Change-Id: Iec0e6ba47152cef77a30a3464d98516356e04ca4
2013-08-02 19:04:48 +01: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
Martyn Taylor
7826d1e129 Updated API Spec for new Drivers
Updates the API specification to match the new
driver definitions.

Renamed management configuration to driver
configuration, and removed control and deployment
sections.

Change-Id: I561d72e935b12c2810c9a0835fe36028e88a86d9
2013-06-20 10:36:22 +01:00
jiangwt100
0442a0034f Writing Error: nodess to nodes
Find it when reading doc

Change-Id: Icf686c23db56505235d2a61a14204f4433f4e3b8
2013-06-14 00:10:50 +08:00
Devananda van der Veen
b15d2b2459 Fix relative links in architecture doc.
Change-Id: Ib686e7bec00f798108d1b4fa995160b36ddf9cf3
2013-06-06 11:25:29 -07:00
Devananda van der Veen
bf7298d452 Reword architecture driver description.
Change-Id: I16528a6aad5d5dd728537a2a271012e02eaaf1d4
2013-06-06 11:25:06 -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
Jenkins
dff6b2d359 Merge "More doc updates." 2013-05-29 23:29:50 +00: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
0a21463459 Remove the old README.
Change-Id: I867960f48c3f3b5a1b868c764af185c048196690
2013-05-29 12:18:48 -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
Jenkins
0f68c80eb5 Merge "Added API v1 Specification" 2013-05-29 18:58:17 +00:00
Devananda van der Veen
72ba74423e Minor fixes to sphinx docs.
Add pygments.css to match other OpenStack projects.
Fix a few things in conf.py

Change-Id: Ieb62caa7d4540ed642265612eb9a04e5a61a7b99
2013-05-29 11:03:58 -07:00
Martyn Taylor
3fc85ff0e3 Added API v1 Specification
Change-Id: I901b11d8bdf5dcd415c58a2b3eb01c5bc6b51a70
Implements: blueprint api-v1-spec
2013-05-29 14:44:43 +01: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
Sean Dague
04c1574bee move ironic docs to top level for ease of discovery
Change-Id: Ief94889dc5c4d65a6d95067b51d73f13fbba640a
2013-05-20 15:14:16 -04:00