20 Commits

Author SHA1 Message Date
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
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
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
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
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