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
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
Use the new oslosphinx version of the OpenStack doc theme instead of
maintaining a copy of it in the Ironic repository.
Change-Id: I1d949d1e2734b10e38dea0067db9f3cfd7109c11
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
Adds a section to the developer quickstart doc explaining
how to deploy Ironic as part of devstack.
Change-Id: I26a6f8faa882bfaa94dd6eb26e6bef197f12b25c
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
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
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
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
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
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
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
Add the necessary bits for sphinxcontrib-pecanwsme
so that we can start auto-generating REST API docs.
Change-Id: I6ad61a5185462916865884dd1619465ef90aba0a
Closes-bug: 1251011
Improve the API doc spec for node and fix some other format problems in
the document.
Change-Id: Iefa645552d55743cad553d1ab9bbaff6612343e2
Partial-Bug: #1202748
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
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
Some files still use trademark OpenStack LLC in header, which
should be changed to OpenStack Foundation.
Change-Id: I6ab820e61514c6004247d9b931976e03baf84ae0
Fixes-Bug: #1214176
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
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
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
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
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
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
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
